aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2010-12-27 15:07:07 +0000
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2010-12-27 15:07:07 +0000
commit840c4e1ab5151ca8288721c10c1d92e35df61581 (patch)
treeb95023d0ce3bbc4bcb7c7ca5a83f5ef181f0b341 /doc
parent42a050dc6881d00ed32ffe2b9d55192db8dca760 (diff)
Move section on preprocessor directives from I00 to its own page.
Diffstat (limited to 'doc')
-rw-r--r--doc/I00_CustomizingEigen.dox13
-rw-r--r--doc/I14_PreprocessorDirectives.dox16
-rw-r--r--doc/Overview.dox1
3 files changed, 18 insertions, 12 deletions
diff --git a/doc/I00_CustomizingEigen.dox b/doc/I00_CustomizingEigen.dox
index 1c7a45355..2a3a9b7d6 100644
--- a/doc/I00_CustomizingEigen.dox
+++ b/doc/I00_CustomizingEigen.dox
@@ -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
*/
diff --git a/doc/I14_PreprocessorDirectives.dox b/doc/I14_PreprocessorDirectives.dox
new file mode 100644
index 000000000..3fd811cc7
--- /dev/null
+++ b/doc/I14_PreprocessorDirectives.dox
@@ -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
+
+*/
+
+} \ No newline at end of file
diff --git a/doc/Overview.dox b/doc/Overview.dox
index edbc69e24..a4c4cde5d 100644
--- a/doc/Overview.dox
+++ b/doc/Overview.dox
@@ -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