aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/I15_StorageOrders.dox
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2012-05-13 21:42:45 +0100
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2012-05-13 21:42:45 +0100
commitb5f70814c1005a39b0ff084f55360337b3b8ebd8 (patch)
tree36995ae49185c4254a82b3544ca7a06946fe6d05 /doc/I15_StorageOrders.dox
parentce2e2fe3364e5f37d3f375523bd0840d52a3fc32 (diff)
Warn users against dangerous macros.
Also, mark EIGEN_DEFAULT_TO_ROW_MAJOR as internal (see also bug #422).
Diffstat (limited to 'doc/I15_StorageOrders.dox')
-rw-r--r--doc/I15_StorageOrders.dox6
1 files changed, 2 insertions, 4 deletions
diff --git a/doc/I15_StorageOrders.dox b/doc/I15_StorageOrders.dox
index 6b56ca8f8..7418912a6 100644
--- a/doc/I15_StorageOrders.dox
+++ b/doc/I15_StorageOrders.dox
@@ -60,10 +60,8 @@ parameter is set to \c RowMajor, then the matrix or array is stored in row-major
\c ColMajor, then it is stored in column-major order. This mechanism is used in the above Eigen program to
specify the storage order.
-If the storage order is not specified, then Eigen normally defaults to storing the entry in column-major
-order. This is also the case if one of the convenience typedefs (\c Matrix3f, \c ArrayXXd, etc.) is
-used. However, it is possible to change the default to row-major order by defining the
-\c EIGEN_DEFAULT_TO_ROW_MAJOR \ref TopicPreprocessorDirectives "preprocessor directive".
+If the storage order is not specified, then Eigen defaults to storing the entry in column-major. This is also
+the case if one of the convenience typedefs (\c Matrix3f, \c ArrayXXd, etc.) is used.
Matrices and arrays using one storage order can be assigned to matrices and arrays using the other storage
order, as happens in the above program when \c Arowmajor is initialized using \c Acolmajor. Eigen will reorder