aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/PreprocessorDirectives.dox
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2013-02-07 18:07:07 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2013-02-07 18:07:07 +0100
commit5115f4c50429398b61807181f6c155ba17243af7 (patch)
tree9e231dafb242618d65f43e04abcb4c0e1d010a16 /doc/PreprocessorDirectives.dox
parent3c1ccca28577e4b9e815b4e263295a21ad654136 (diff)
add EIGEN_INITIALIZE_MATRICES_BY_NAN
Diffstat (limited to 'doc/PreprocessorDirectives.dox')
-rw-r--r--doc/PreprocessorDirectives.dox6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/PreprocessorDirectives.dox b/doc/PreprocessorDirectives.dox
index 0c4c47464..f731b5628 100644
--- a/doc/PreprocessorDirectives.dox
+++ b/doc/PreprocessorDirectives.dox
@@ -27,7 +27,11 @@ are doing.
- \b EIGEN_DEFAULT_IO_FORMAT - the IOFormat to use when printing a matrix if no %IOFormat is specified.
Defaults to the %IOFormat constructed by the default constructor IOFormat::IOFormat().
- \b EIGEN_INITIALIZE_MATRICES_BY_ZERO - if defined, all entries of newly constructed matrices and arrays are
- initializes to zero, as are new entries in matrices and arrays after resizing. Not defined by default.
+ initialized to zero, as are new entries in matrices and arrays after resizing. Not defined by default.
+ - \b EIGEN_INITIALIZE_MATRICES_BY_NAN - if defined, all entries of newly constructed matrices and arrays are
+ initialized to NaN, as are new entries in matrices and arrays after resizing. This option is especially
+ useful for debugging purpose, though a memory tool like <a href="http://valgrind.org/">valgring</a> is
+ preferable. Not defined by default.
- \b EIGEN_NO_AUTOMATIC_RESIZING - if defined, the matrices (or arrays) on both sides of an assignment
<tt>a = b</tt> have to be of the same size; otherwise, %Eigen automatically resizes \c a so that it is of
the correct size. Not defined by default.