mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-06-04 18:54:00 +08:00
Docs: Add references to TopicClassHierarchy
This commit is contained in:
parent
a6da803873
commit
103b9351fd
@ -37,7 +37,7 @@
|
|||||||
* API for the %Matrix class provides easy access to linear-algebra
|
* API for the %Matrix class provides easy access to linear-algebra
|
||||||
* operations.
|
* operations.
|
||||||
*
|
*
|
||||||
* \sa \ref TutorialArrayClass
|
* \sa \ref TutorialArrayClass, \ref TopicClassHierarchy
|
||||||
*/
|
*/
|
||||||
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
|
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> >
|
struct ei_traits<Array<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> > : ei_traits<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
|
||||||
|
@ -44,7 +44,7 @@ template<typename ExpressionType> class MatrixWrapper;
|
|||||||
*
|
*
|
||||||
* \param Derived is the derived type, e.g., an array or an expression type.
|
* \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
|
template<typename Derived> class ArrayBase
|
||||||
: public DenseBase<Derived>
|
: public DenseBase<Derived>
|
||||||
|
@ -35,6 +35,8 @@
|
|||||||
* and related expression types). The common Eigen API for dense objects is contained in this class.
|
* 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.
|
* \param Derived is the derived type, e.g., a matrix type or an expression.
|
||||||
|
*
|
||||||
|
* \sa \ref TopicClassHierarchy
|
||||||
*/
|
*/
|
||||||
template<typename Derived> class DenseBase
|
template<typename Derived> class DenseBase
|
||||||
#ifndef EIGEN_PARSED_BY_DOXYGEN
|
#ifndef EIGEN_PARSED_BY_DOXYGEN
|
||||||
|
@ -33,7 +33,8 @@
|
|||||||
* This class defines the \c operator() \c const function and friends, which can be used to read specific
|
* This class defines the \c operator() \c const function and friends, which can be used to read specific
|
||||||
* entries of a matrix or array.
|
* 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>
|
template<typename Derived>
|
||||||
class DenseCoeffsBase<Derived,ReadOnlyAccessors> : public EigenBase<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
|
* entries of a matrix or array. This class inherits DenseCoeffsBase<Derived, ReadOnlyAccessors> which
|
||||||
* defines the const variant for reading specific entries.
|
* defines the const variant for reading specific entries.
|
||||||
*
|
*
|
||||||
* \sa DenseCoeffsBase<Derived, DirectAccessors>
|
* \sa DenseCoeffsBase<Derived, DirectAccessors>, \ref TopicClassHierarchy
|
||||||
*/
|
*/
|
||||||
template<typename Derived>
|
template<typename Derived>
|
||||||
class DenseCoeffsBase<Derived, WriteAccessors> : public DenseCoeffsBase<Derived, ReadOnlyAccessors>
|
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
|
* 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
|
* inherits DenseCoeffsBase<Derived, WriteAccessors> which defines functions to access entries using
|
||||||
* \c operator() .
|
* \c operator() .
|
||||||
|
*
|
||||||
|
* \sa \ref TopicClassHierarchy
|
||||||
*/
|
*/
|
||||||
template<typename Derived>
|
template<typename Derived>
|
||||||
class DenseCoeffsBase<Derived, DirectAccessors> : public DenseCoeffsBase<Derived, WriteAccessors>
|
class DenseCoeffsBase<Derived, DirectAccessors> : public DenseCoeffsBase<Derived, WriteAccessors>
|
||||||
|
@ -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;
|
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>
|
template<typename Derived>
|
||||||
class DenseStorageBase : public ei_dense_xpr_base<Derived>::type
|
class DenseStorageBase : public ei_dense_xpr_base<Derived>::type
|
||||||
{
|
{
|
||||||
|
@ -34,6 +34,8 @@
|
|||||||
* Besides MatrixBase-derived classes, this also includes special matrix classes such as diagonal matrices, etc.
|
* 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.
|
* Notice that this class is trivial, it is only used to disambiguate overloaded functions.
|
||||||
|
*
|
||||||
|
* \sa \ref TopicClassHierarchy
|
||||||
*/
|
*/
|
||||||
template<typename Derived> struct EigenBase
|
template<typename Derived> struct EigenBase
|
||||||
{
|
{
|
||||||
|
@ -107,7 +107,7 @@
|
|||||||
* are the dimensions of the original matrix, while _Rows and _Cols are Dynamic.</dd>
|
* are the dimensions of the original matrix, while _Rows and _Cols are Dynamic.</dd>
|
||||||
* </dl>
|
* </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>
|
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
|
||||||
struct ei_traits<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
|
struct ei_traits<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols> >
|
||||||
|
@ -52,6 +52,8 @@
|
|||||||
cout << x.row(0) << endl;
|
cout << x.row(0) << endl;
|
||||||
}
|
}
|
||||||
* \endcode
|
* \endcode
|
||||||
|
*
|
||||||
|
* \sa \ref TopicClassHierarchy
|
||||||
*/
|
*/
|
||||||
template<typename Derived> class MatrixBase
|
template<typename Derived> class MatrixBase
|
||||||
: public DenseBase<Derived>
|
: public DenseBase<Derived>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user