diff options
author | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2010-08-22 18:28:19 +0100 |
---|---|---|
committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2010-08-22 18:28:19 +0100 |
commit | 103b9351fdbf3ea440b718a13f40eb17928afaaa (patch) | |
tree | 62c02f61423308bd73bce42167b9b4ef9c4c2631 /Eigen/src | |
parent | a6da80387364de1a6af39a2b472968b1cb1b10a1 (diff) |
Docs: Add references to TopicClassHierarchy
Diffstat (limited to 'Eigen/src')
-rw-r--r-- | Eigen/src/Core/Array.h | 2 | ||||
-rw-r--r-- | Eigen/src/Core/ArrayBase.h | 2 | ||||
-rw-r--r-- | Eigen/src/Core/DenseBase.h | 2 | ||||
-rw-r--r-- | Eigen/src/Core/DenseCoeffsBase.h | 7 | ||||
-rw-r--r-- | Eigen/src/Core/DenseStorageBase.h | 5 | ||||
-rw-r--r-- | Eigen/src/Core/EigenBase.h | 2 | ||||
-rw-r--r-- | Eigen/src/Core/Matrix.h | 2 | ||||
-rw-r--r-- | Eigen/src/Core/MatrixBase.h | 2 |
8 files changed, 17 insertions, 7 deletions
diff --git a/Eigen/src/Core/Array.h b/Eigen/src/Core/Array.h index e099647df..2e97f18ee 100644 --- a/Eigen/src/Core/Array.h +++ b/Eigen/src/Core/Array.h @@ -37,7 +37,7 @@ * API for the %Matrix class provides easy access to linear-algebra * operations. * - * \sa \ref TutorialArrayClass + * \sa \ref TutorialArrayClass, \ref TopicClassHierarchy */ template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols> struct ei_traits<Array<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> > : ei_traits<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> > diff --git a/Eigen/src/Core/ArrayBase.h b/Eigen/src/Core/ArrayBase.h index 36bf71dde..f0fbcd4ff 100644 --- a/Eigen/src/Core/ArrayBase.h +++ b/Eigen/src/Core/ArrayBase.h @@ -44,7 +44,7 @@ template<typename ExpressionType> class MatrixWrapper; * * \param Derived is the derived type, e.g., an array or an expression type. * - * \sa class MatrixBase + * \sa class MatrixBase, \ref TopicClassHierarchy */ template<typename Derived> class ArrayBase : public DenseBase<Derived> diff --git a/Eigen/src/Core/DenseBase.h b/Eigen/src/Core/DenseBase.h index a00b791cd..065f2efed 100644 --- a/Eigen/src/Core/DenseBase.h +++ b/Eigen/src/Core/DenseBase.h @@ -35,6 +35,8 @@ * and related expression types). The common Eigen API for dense objects is contained in this class. * * \param Derived is the derived type, e.g., a matrix type or an expression. + * + * \sa \ref TopicClassHierarchy */ template<typename Derived> class DenseBase #ifndef EIGEN_PARSED_BY_DOXYGEN diff --git a/Eigen/src/Core/DenseCoeffsBase.h b/Eigen/src/Core/DenseCoeffsBase.h index 5fef6f276..918b246a8 100644 --- a/Eigen/src/Core/DenseCoeffsBase.h +++ b/Eigen/src/Core/DenseCoeffsBase.h @@ -33,7 +33,8 @@ * This class defines the \c operator() \c const function and friends, which can be used to read specific * entries of a matrix or array. * - * \sa DenseCoeffsBase<Derived, WriteAccessors>, DenseCoeffsBase<Derived, DirectAccessors> + * \sa DenseCoeffsBase<Derived, WriteAccessors>, DenseCoeffsBase<Derived, DirectAccessors>, + * \ref TopicClassHierarchy */ template<typename Derived> class DenseCoeffsBase<Derived,ReadOnlyAccessors> : public EigenBase<Derived> @@ -257,7 +258,7 @@ class DenseCoeffsBase<Derived,ReadOnlyAccessors> : public EigenBase<Derived> * entries of a matrix or array. This class inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which * defines the const variant for reading specific entries. * - * \sa DenseCoeffsBase<Derived, DirectAccessors> + * \sa DenseCoeffsBase<Derived, DirectAccessors>, \ref TopicClassHierarchy */ template<typename Derived> class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived, ReadOnlyAccessors> @@ -543,6 +544,8 @@ class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived, * This class defines functions to work with strides which can be used to access entries directly. This class * inherits DenseCoeffsBase<Derived, WriteAccessors> which defines functions to access entries using * \c operator() . + * + * \sa \ref TopicClassHierarchy */ template<typename Derived> class DenseCoeffsBase<Derived, DirectAccessors> : public DenseCoeffsBase<Derived, WriteAccessors> diff --git a/Eigen/src/Core/DenseStorageBase.h b/Eigen/src/Core/DenseStorageBase.h index eb5170bfe..94b3e23a8 100644 --- a/Eigen/src/Core/DenseStorageBase.h +++ b/Eigen/src/Core/DenseStorageBase.h @@ -36,8 +36,9 @@ template <typename Derived, typename OtherDerived = Derived, bool IsVector = sta template<typename MatrixTypeA, typename MatrixTypeB, bool SwapPointers> struct ei_matrix_swap_impl; /** -* \brief %Dense storage base class for matrices and arrays. -**/ + * \brief %Dense storage base class for matrices and arrays. + * \sa \ref TopicClassHierarchy + */ template<typename Derived> class DenseStorageBase : public ei_dense_xpr_base<Derived>::type { diff --git a/Eigen/src/Core/EigenBase.h b/Eigen/src/Core/EigenBase.h index 178e2c7af..d07fea9a2 100644 --- a/Eigen/src/Core/EigenBase.h +++ b/Eigen/src/Core/EigenBase.h @@ -34,6 +34,8 @@ * Besides MatrixBase-derived classes, this also includes special matrix classes such as diagonal matrices, etc. * * Notice that this class is trivial, it is only used to disambiguate overloaded functions. + * + * \sa \ref TopicClassHierarchy */ template<typename Derived> struct EigenBase { diff --git a/Eigen/src/Core/Matrix.h b/Eigen/src/Core/Matrix.h index 1c9d32a29..9d8ff6640 100644 --- a/Eigen/src/Core/Matrix.h +++ b/Eigen/src/Core/Matrix.h @@ -107,7 +107,7 @@ * 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 + * \see MatrixBase for the majority of the API methods for matrices, \ref TopicClassHierarchy */ template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols> struct ei_traits<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> > diff --git a/Eigen/src/Core/MatrixBase.h b/Eigen/src/Core/MatrixBase.h index a05614d1b..25b2fa5e8 100644 --- a/Eigen/src/Core/MatrixBase.h +++ b/Eigen/src/Core/MatrixBase.h @@ -52,6 +52,8 @@ cout << x.row(0) << endl; } * \endcode + * + * \sa \ref TopicClassHierarchy */ template<typename Derived> class MatrixBase : public DenseBase<Derived> |