diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/I11_Aliasing.dox | 2 | ||||
| -rw-r--r-- | doc/I14_PreprocessorDirectives.dox | 6 | ||||
| -rw-r--r-- | doc/QuickReference.dox | 2 |
3 files changed, 7 insertions, 3 deletions
diff --git a/doc/I11_Aliasing.dox b/doc/I11_Aliasing.dox index b5b5a3b59..7c111991c 100644 --- a/doc/I11_Aliasing.dox +++ b/doc/I11_Aliasing.dox @@ -73,7 +73,7 @@ Assertion `(!internal::check_transpose_aliasing_selector<Scalar,internal::blas_t \endverbatim The user can turn Eigen's run-time assertions like the one to detect this aliasing problem off by defining the -#EIGEN_NO_DEBUG macro, and the above program was compiled with this macro turned off in order to illustrate the +EIGEN_NO_DEBUG macro, and the above program was compiled with this macro turned off in order to illustrate the aliasing problem. See \ref TopicAssertions for more information about Eigen's run-time assertions. diff --git a/doc/I14_PreprocessorDirectives.dox b/doc/I14_PreprocessorDirectives.dox index 3fd811cc7..0c8804020 100644 --- a/doc/I14_PreprocessorDirectives.dox +++ b/doc/I14_PreprocessorDirectives.dox @@ -3,7 +3,11 @@ namespace Eigen { /** \page TopicPreprocessorDirectives Preprocessor directives You can control some aspects of Eigen by defining the following preprocessor tokens them before including any of Eigen's headers. - - \b #EIGEN_NO_DEBUG disables Eigen assertions. Like NDEBUG but only affects Eigen's assertions. + - \b EIGEN_NO_DEBUG If defined, Eigen's assertions are disabled. Disabling run-time assertions improves the + performance, but it is dangerous because the assertions guard against programming errors. By default, the + EIGEN_NO_DEBUG macro is not defined and Eigen's run-time assertions are thus enabled. However, if the + NDEBUG macro is defined (this is a standard C++ macro which disables all asserts), then the EIGEN_NO_DEBUG + macro will also be defined, and so Eigen's assertions will also be disabled. - \b EIGEN_DONT_VECTORIZE disables explicit vectorization when defined. - \b EIGEN_UNROLLING_LIMIT defines the maximal instruction counts to enable meta unrolling of loops. Set it to zero to disable unrolling. The default is 100. - \b EIGEN_DEFAULT_TO_ROW_MAJOR the default storage order for matrices becomes row-major instead of column-major. diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox index e657f1a7c..62c327107 100644 --- a/doc/QuickReference.dox +++ b/doc/QuickReference.dox @@ -176,7 +176,7 @@ vector[i] vector.y() vector.w() \endcode</td><td>\code matrix(i,j) -\endcode</td><td class="note">Range checking is disabled if \n NDEBUG or #EIGEN_NO_DEBUG is defined</td></tr> +\endcode</td><td class="note">Range checking is disabled if \n NDEBUG or EIGEN_NO_DEBUG is defined</td></tr> <tr class="alt"><td>Coeff access without \n range checking</td> <td>\code |