mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2024-12-15 07:10:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add missing documentation for TriangularViewImpl<MatrixType,Mode,Sparse>

Browse Source
This commit is contained in:
Gael Guennebaud 2015-06-09 11:40:07 +02:00
parent 3a4299b245
commit 302cf8ffe2
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Eigen/src/SparseCore/SparseTriangularView.h
View File

@ -11,11 +11,17 @@
#ifndef EIGEN_SPARSE_TRIANGULARVIEW_H
#define EIGEN_SPARSE_TRIANGULARVIEW_H
#ifndef EIGEN_PARSED_BY_DOXYGEN
// Doxygen gets confused with template specialization:
// https://bugzilla.gnome.org/show_bug.cgi?id=406027
namespace Eigen {
/** \ingroup SparseCore_Module
*
* \brief Base class for a triangular part in a \b sparse 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 are available for sparse expressions only.
*
* \sa class TriangularView, SparseMatrixBase::triangularView()
*/
template<typename MatrixType, unsigned int Mode> class TriangularViewImpl<MatrixType,Mode,Sparse>
: public SparseMatrixBase<TriangularView<MatrixType,Mode> >
{
@ -278,6 +284,4 @@ SparseMatrixBase<Derived>::triangularView() const
} // end namespace Eigen
#endif // not EIGEN_PARSED_BY_DOXYGEN
#endif // EIGEN_SPARSE_TRIANGULARVIEW_H