Move section on preprocessor directives from I00 to its own page.

This commit is contained in:
Jitse Niesen 2010-12-27 15:07:07 +00:00
parent 42a050dc68
commit 840c4e1ab5
3 changed files with 18 additions and 12 deletions

View File

@ -8,7 +8,6 @@ Eigen can be extended in several ways, for instance, by defining global methods,
- \ref ExtendingMatrixBase
- \ref InheritingFromMatrix
- \ref CustomScalarType
- \ref PreprocessorDirectives
\section ExtendingMatrixBase Extending MatrixBase
@ -180,17 +179,7 @@ namespace adtl {
\endcode
\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_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.
- \b EIGEN_TUNE_FOR_CPU_CACHE_SIZE represents the maximal size in Bytes of L2 blocks. Since several blocks have to stay concurently in L2 cache, this value should correspond to at most 1/4 of the size of L2 cache.
- \b EIGEN_NO_STATIC_ASSERT replaces compile time static assertions by runtime assertions
- \b EIGEN_MATRIXBASE_PLUGIN see \ref ExtendingMatrixBase
\sa \ref TopicPreprocessorDirectives
*/

View File

@ -0,0 +1,16 @@
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_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.
- \b EIGEN_TUNE_FOR_CPU_CACHE_SIZE represents the maximal size in Bytes of L2 blocks. Since several blocks have to stay concurently in L2 cache, this value should correspond to at most 1/4 of the size of L2 cache.
- \b EIGEN_NO_STATIC_ASSERT replaces compile time static assertions by runtime assertions
- \b EIGEN_MATRIXBASE_PLUGIN see \ref ExtendingMatrixBase
*/
}

View File

@ -33,6 +33,7 @@ For a first contact with Eigen, the best place is to have a look at the \ref Get
- \ref TopicLazyEvaluation
- \ref TopicLinearAlgebraDecompositions
- \ref TopicCustomizingEigen
- \ref TopicPreprocessorDirectives
- \ref TopicInsideEigenExample
- \ref TopicWritingEfficientProductExpression
- \ref TopicClassHierarchy