mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-03-07 18:27:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Doc: explain how to free allocated memory in SparseMAtrix

Browse Source
This commit is contained in:
Gael Guennebaud 2015-02-16 15:56:11 +01:00
parent 98604576d1
commit 953d5ccfd5
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -243,7 +243,13 @@ class SparseMatrix
public:
/** Removes all non zeros but keep allocated memory */
/** Removes all non zeros but keep allocated memory
*
* This function does not free the currently allocated memory. To release as much as memory as possible,
* call \code mat.data().squeeze(); \endcode after resizing it.
*
* \sa resize(Index,Index), data()
*/
inline void setZero()
{
m_data.clear();
@ -601,6 +607,10 @@ class SparseMatrix
}
/** Resizes the matrix to a \a rows x \a cols matrix and initializes it to zero.
*
* This function does not free the currently allocated memory. To release as much as memory as possible,
* call \code mat.data().squeeze(); \endcode after resizing it.
*
* \sa resizeNonZeros(Index), reserve(), setZero()
*/
void resize(Index rows, Index cols)