diff options
author | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-02-12 17:43:29 +0000 |
---|---|---|
committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-02-12 17:43:29 +0000 |
commit | 9ac68e40a0fa84419e95674c07bb773d054558c8 (patch) | |
tree | 6f1bb94758f94b369f05ee3759a318824bac420b /Eigen | |
parent | 7015aa00a97a0161fd8f73fd2ffdfb7a36749f98 (diff) |
Write topic page for storage orders.
Diffstat (limited to 'Eigen')
-rw-r--r-- | Eigen/src/Core/BandMatrix.h | 6 | ||||
-rw-r--r-- | Eigen/src/Core/DenseBase.h | 8 | ||||
-rw-r--r-- | Eigen/src/Core/Map.h | 4 | ||||
-rw-r--r-- | Eigen/src/Core/Matrix.h | 5 | ||||
-rw-r--r-- | Eigen/src/Core/Stride.h | 2 | ||||
-rw-r--r-- | Eigen/src/Core/util/Constants.h | 3 |
6 files changed, 15 insertions, 13 deletions
diff --git a/Eigen/src/Core/BandMatrix.h b/Eigen/src/Core/BandMatrix.h index 3f2608c13..a1f71d5f6 100644 --- a/Eigen/src/Core/BandMatrix.h +++ b/Eigen/src/Core/BandMatrix.h @@ -181,9 +181,9 @@ class BandMatrixBase : public EigenBase<Derived> * \param Supers Number of super diagonal * \param Subs Number of sub diagonal * \param _Options A combination of either \b RowMajor or \b ColMajor, and of \b SelfAdjoint - * The former controls storage order, and defaults to column-major. The latter controls - * whether the matrix represent a selfadjoint matrix in which case either Supers of Subs - * have to be null. + * The former controls \ref TopicStorageOrders "storage order", and defaults to + * column-major. The latter controls whether the matrix represents a selfadjoint + * matrix in which case either Supers of Subs have to be null. * * \sa class TridiagonalMatrix */ diff --git a/Eigen/src/Core/DenseBase.h b/Eigen/src/Core/DenseBase.h index b8fa9d1cd..91465f026 100644 --- a/Eigen/src/Core/DenseBase.h +++ b/Eigen/src/Core/DenseBase.h @@ -185,8 +185,8 @@ template<typename Derived> class DenseBase /** \returns the outer size. * * \note For a vector, this returns just 1. For a matrix (non-vector), this is the major dimension - * with respect to the storage order, i.e., the number of columns for a column-major matrix, - * and the number of rows for a row-major matrix. */ + * with respect to the \ref TopicStorageOrders "storage order", i.e., the number of columns for a + * column-major matrix, and the number of rows for a row-major matrix. */ Index outerSize() const { return IsVectorAtCompileTime ? 1 @@ -196,8 +196,8 @@ template<typename Derived> class DenseBase /** \returns the inner size. * * \note For a vector, this is just the size. For a matrix (non-vector), this is the minor dimension - * with respect to the storage order, i.e., the number of rows for a column-major matrix, - * and the number of columns for a row-major matrix. */ + * with respect to the \ref TopicStorageOrders "storage order", i.e., the number of rows for a + * column-major matrix, and the number of columns for a row-major matrix. */ Index innerSize() const { return IsVectorAtCompileTime ? this->size() diff --git a/Eigen/src/Core/Map.h b/Eigen/src/Core/Map.h index f78e87e39..8f0d87b51 100644 --- a/Eigen/src/Core/Map.h +++ b/Eigen/src/Core/Map.h @@ -44,7 +44,7 @@ * data is laid out contiguously in memory. You can however override this by explicitly specifying * inner and outer strides. * - * Here's an example of simply mapping a contiguous array as a column-major matrix: + * Here's an example of simply mapping a contiguous array as a \ref TopicStorageOrders "column-major" matrix: * \include Map_simple.cpp * Output: \verbinclude Map_simple.out * @@ -74,7 +74,7 @@ * * This class is the return type of Matrix::Map() but can also be used directly. * - * \sa Matrix::Map() + * \sa Matrix::Map(), \ref TopicStorageOrders */ namespace internal { diff --git a/Eigen/src/Core/Matrix.h b/Eigen/src/Core/Matrix.h index 2b7202c62..7e3279094 100644 --- a/Eigen/src/Core/Matrix.h +++ b/Eigen/src/Core/Matrix.h @@ -45,7 +45,7 @@ * The remaining template parameters are optional -- in most cases you don't have to worry about them. * \tparam _Options \anchor matrix_tparam_options A combination of either \b RowMajor or \b ColMajor, and of either * \b AutoAlign or \b DontAlign. - * The former controls storage order, and defaults to column-major. The latter controls alignment, which is required + * The former controls \ref TopicStorageOrders "storage order", and defaults to column-major. The latter controls alignment, which is required * for vectorization. It defaults to aligning matrices except for fixed sizes that aren't a multiple of the packet size. * \tparam _MaxRows Maximum number of rows. Defaults to \a _Rows (\ref maxrows "note"). * \tparam _MaxCols Maximum number of columns. Defaults to \a _Cols (\ref maxrows "note"). @@ -107,7 +107,8 @@ * are the dimensions of the original matrix, while _Rows and _Cols are Dynamic.</dd> * </dl> * - * \see MatrixBase for the majority of the API methods for matrices, \ref TopicClassHierarchy + * \see MatrixBase for the majority of the API methods for matrices, \ref TopicClassHierarchy, + * \ref TopicStorageOrders */ namespace internal { diff --git a/Eigen/src/Core/Stride.h b/Eigen/src/Core/Stride.h index 9425253ec..0430f1116 100644 --- a/Eigen/src/Core/Stride.h +++ b/Eigen/src/Core/Stride.h @@ -51,7 +51,7 @@ * \include Map_general_stride.cpp * Output: \verbinclude Map_general_stride.out * - * \sa class InnerStride, class OuterStride + * \sa class InnerStride, class OuterStride, \ref TopicStorageOrders */ template<int _OuterStrideAtCompileTime, int _InnerStrideAtCompileTime> class Stride diff --git a/Eigen/src/Core/util/Constants.h b/Eigen/src/Core/util/Constants.h index 7ba91d6db..2ffeb7948 100644 --- a/Eigen/src/Core/util/Constants.h +++ b/Eigen/src/Core/util/Constants.h @@ -56,7 +56,8 @@ const int Infinity = -1; * for a matrix, this means that the storage order is row-major. * If this bit is not set, the storage order is column-major. * For an expression, this determines the storage order of - * the matrix created by evaluation of that expression. */ + * the matrix created by evaluation of that expression. + * \sa \ref TopicStorageOrders */ const unsigned int RowMajorBit = 0x1; /** \ingroup flags |