Document EIGEN_NO_DEBUG macro.

I needed some doxygen tricks to get this to work, so it may not be worth it.
This commit is contained in:
Jitse Niesen
2010-08-10 11:37:23 +01:00
parent 530b328769
commit 76fbe94279
5 changed files with 26 additions and 7 deletions

View File

@@ -184,7 +184,7 @@ namespace adtl {
\section PreprocessorDirectives 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 disables Eigen assertions. Like NDEBUG but only affects Eigen's assertions.
- \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.