diff options
author | Gael Guennebaud <g.gael@free.fr> | 2015-06-05 14:40:07 +0200 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2015-06-05 14:40:07 +0200 |
commit | d0b7b5cb55af90f7cba376e3591cbdba9d82aa41 (patch) | |
tree | 8ce659f678941a7b31fa9dd9a67729e57a011d0e /Eigen/src/Core/TriangularMatrix.h | |
parent | 56d4ef7ad6856f95730aa4a143e1c1db757a6ce0 (diff) |
minor documentation fixes
Diffstat (limited to 'Eigen/src/Core/TriangularMatrix.h')
-rw-r--r-- | Eigen/src/Core/TriangularMatrix.h | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/Eigen/src/Core/TriangularMatrix.h b/Eigen/src/Core/TriangularMatrix.h index 7b3be2120..22f2bd8dd 100644 --- a/Eigen/src/Core/TriangularMatrix.h +++ b/Eigen/src/Core/TriangularMatrix.h @@ -19,9 +19,7 @@ template<int Side, typename TriangularType, typename Rhs> struct triangular_solv } -/** \internal - * - * \class TriangularBase +/** \class TriangularBase * \ingroup Core_Module * * \brief Base class for triangular part in a matrix @@ -148,7 +146,7 @@ template<typename Derived> class TriangularBase : public EigenBase<Derived> /** \class TriangularView * \ingroup Core_Module * - * \brief Base class for triangular part in a matrix + * \brief Expression of a triangular part in a matrix * * \param MatrixType the type of the object in which we are taking the triangular part * \param Mode the kind of triangular matrix expression to construct. Can be #Upper, @@ -158,7 +156,7 @@ template<typename Derived> class TriangularBase : public EigenBase<Derived> * * This class represents a triangular part of a matrix, not necessarily square. Strictly speaking, for rectangular * matrices one should speak of "trapezoid" parts. This class is the return type - * of MatrixBase::triangularView() and most of the time this is the only way it is used. + * of MatrixBase::triangularView() and SparseMatrixBase::triangularView(), and most of the time this is the only way it is used. * * \sa MatrixBase::triangularView() */ @@ -306,6 +304,15 @@ template<typename _MatrixType, unsigned int _Mode> class TriangularView MatrixTypeNested m_matrix; }; +/** \ingroup Core_Module + * + * \brief Base class for a triangular part in a \b dense matrix + * + * This class is an abstract base class of class TriangularView, and objects of type TriangularViewImpl cannot be instantiated. + * It extends class TriangularView with additional methods which available for dense expressions only. + * + * \sa class TriangularView, MatrixBase::triangularView() + */ template<typename _MatrixType, unsigned int _Mode> class TriangularViewImpl<_MatrixType,_Mode,Dense> : public TriangularBase<TriangularView<_MatrixType, _Mode> > { |