Improve inline documentation of SparseCompressedBase and its derived classes

This commit is contained in:
Gael Guennebaud
2016-01-03 21:56:30 +01:00
parent 8b0d1eb0f7
commit 715f6f049f
4 changed files with 69 additions and 8 deletions

View File

@@ -22,6 +22,16 @@ struct traits<SparseCompressedBase<Derived> > : traits<Derived>
} // end namespace internal
/** \ingroup SparseCore_Module
* \class SparseCompressedBase
* \brief Common base class for sparse [compressed]-{row|column}-storage format.
*
* This class defines the common interface for all derived classes implementing the compressed sparse storage format, such as:
* - SparseMatrix
* - Ref<SparseMatrixType,Options>
* - Map<SparseMatrixType>
*
*/
template<typename Derived>
class SparseCompressedBase
: public SparseMatrixBase<Derived>