Improve documentation.

This commit is contained in:
Gael Guennebaud
2016-01-25 11:56:25 +01:00
parent 869b4443ac
commit b114e6fd3b
2 changed files with 19 additions and 1 deletions

View File

@@ -538,7 +538,12 @@ class SparseMatrix
}
/** Resizes the matrix to a \a rows x \a cols matrix leaving old values untouched.
* \sa reserve(), setZero()
*
* If the sizes of the matrix are decreased, then the matrix is turned to \b uncompressed-mode
* and the storage of the out of bounds coefficients is kept and reserved.
* Call makeCompressed() to pack the entries and squeeze extra memory.
*
* \sa reserve(), setZero(), makeCompressed()
*/
void conservativeResize(Index rows, Index cols)
{