aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/I11_Aliasing.dox
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2010-11-16 17:28:59 +0000
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2010-11-16 17:28:59 +0000
commite54c8d20cbbfa43f037d6a521eca16e45a61a6b2 (patch)
treee7d02c739f4dba6558c2e7e8c1e6845955314a1c /doc/I11_Aliasing.dox
parentda05b6af0ef8720355eb7ae0321476ca9a3d81d8 (diff)
Docs: aliasing and component-wise operations.
Diffstat (limited to 'doc/I11_Aliasing.dox')
-rw-r--r--doc/I11_Aliasing.dox21
1 files changed, 20 insertions, 1 deletions
diff --git a/doc/I11_Aliasing.dox b/doc/I11_Aliasing.dox
index 04a24bded..c7e984cf3 100644
--- a/doc/I11_Aliasing.dox
+++ b/doc/I11_Aliasing.dox
@@ -128,7 +128,26 @@ functions provided:
\section TopicAliasingCwise Aliasing and component-wise operations
-Synopsis: Things like mat = 2 * mat, matA = matA + matB and arr = arr.sin() are safe.
+As explained above, it may be dangerous if the same matrix or array occurs on both the left-hand side and the
+right-hand side of an assignment operator, and it is then often necessary to evaluate the right-hand side
+explicitly. However, applying component-wise operations (such as matrix addition, scalar multiplication and
+array multiplication) is safe.
+
+The following example has only component-wise operations. Thus, there is no need for .eval() even though
+the same matrix appears on both sides of the assignments.
+
+<table class="example">
+<tr><th>Example</th><th>Output</th></tr>
+<tr><td>
+\include TopicAliasing_cwise.cpp
+</td>
+<td>
+\verbinclude TopicAliasing_cwise.out
+</td></tr></table>
+
+In general, an assignment is safe if the (i,j) entry of the expression on the right-hand side depends only on
+the (i,j) entry of the matrix or array on the left-hand side and not on any other entries. In that case it is
+not necessary to evaluate the right-hand side explicitly.
\section TopicAliasingMatrixMult Aliasing and matrix multiplication