Move doxygen comments for EIGEN_NO_DEBUG from source to I14.

This reverts changeset 76fbe94279
. Benoit and I agree that my
approach there (to use doxygen comments) pollutes the code too much.
This commit is contained in:
Jitse Niesen
2010-12-27 15:07:11 +00:00
parent 840c4e1ab5
commit 8db9acbc16
5 changed files with 8 additions and 23 deletions

View File

@@ -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.