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

Document non-const SparseMatrix::diagonal() method.

Browse Source
This commit is contained in:
Gael Guennebaud 2014-12-01 14:45:15 +01:00
parent b26e697182
commit e2f3e4e4aa
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Eigen/src/SparseCore/SparseMatrix.h
View File

@ -633,8 +633,13 @@ class SparseMatrix
m_data.resize(size);
}
/** \returns a const expression of the diagonal coefficients */
/** \returns a const expression of the diagonal coefficients. */
const ConstDiagonalReturnType diagonal() const { return ConstDiagonalReturnType(*this); }
/** \returns a read-write expression of the diagonal coefficients.
* \warning If the diagonal entries are written, then all diagonal
* entries \b must already exist, otherwise an assertion will be raised.
*/
DiagonalReturnType diagonal() { return DiagonalReturnType(*this); }
/** Default constructor yielding an empty \c 0 \c x \c 0 matrix */