diff options
author | Gael Guennebaud <g.gael@free.fr> | 2016-01-25 11:56:25 +0100 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2016-01-25 11:56:25 +0100 |
commit | b114e6fd3b61c7ef93f6b94e194d316f0ab19036 (patch) | |
tree | 6fefaa65364fb55217d7c8a2c54c283cf5929b3d /Eigen/src/SparseCore/SparseMatrix.h | |
parent | 869b4443ac4a55c09a0632e2dbf621587749e164 (diff) |
Improve documentation.
Diffstat (limited to 'Eigen/src/SparseCore/SparseMatrix.h')
-rw-r--r-- | Eigen/src/SparseCore/SparseMatrix.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Eigen/src/SparseCore/SparseMatrix.h b/Eigen/src/SparseCore/SparseMatrix.h index 91bada40f..8b57445e6 100644 --- a/Eigen/src/SparseCore/SparseMatrix.h +++ b/Eigen/src/SparseCore/SparseMatrix.h @@ -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) { |