aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Pitfalls.dox
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2018-05-29 22:37:47 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2018-05-29 22:37:47 +0200
commit6af1433cb50af7423a1a69afc24c098af9c76bb1 (patch)
treea2c282ce1bc5103d9287e1f81e93d5f567fbed26 /doc/Pitfalls.dox
parentea94543190354e9cac55784b9e4f17549a14906f (diff)
Doc: add aliasing in common pitfaffs.
Diffstat (limited to 'doc/Pitfalls.dox')
-rw-r--r--doc/Pitfalls.dox6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/Pitfalls.dox b/doc/Pitfalls.dox
index cf42effef..3f395053d 100644
--- a/doc/Pitfalls.dox
+++ b/doc/Pitfalls.dox
@@ -2,10 +2,16 @@ namespace Eigen {
/** \page TopicPitfalls Common pitfalls
+
\section TopicPitfalls_template_keyword Compilation error with template methods
See this \link TopicTemplateKeyword page \endlink.
+\section TopicPitfalls_aliasing Aliasing
+
+Don't miss this \link TopicAliasing page \endlink on aliasing,
+especially if you got wrong results in statements where the destination appears on the right hand side of the expression.
+
\section TopicPitfalls_auto_keyword C++11 and the auto keyword
In short: do not use the auto keywords with Eigen's expressions, unless you are 100% sure about what you are doing. In particular, do not use the auto keyword as a replacement for a Matrix<> type. Here is an example: