aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/UmfPackSupport
diff options
context:
space:
mode:
authorGravatar Desire NUENTSA <desire.nuentsa_wakam@inria.fr>2012-03-29 14:32:54 +0200
committerGravatar Desire NUENTSA <desire.nuentsa_wakam@inria.fr>2012-03-29 14:32:54 +0200
commitf804a319c81cb1629abb9bdc97dd74a2d2dec3d7 (patch)
tree5d59101e9f756ed2cc02ae6047dcaaf8a67dbfe4 /Eigen/src/UmfPackSupport
parentada9e791450618d1d608db11fcdd97adde824cbe (diff)
modify the unit tests of sparse linear solvers to enable tests on real matrices, from MatrixMarket for instance
Diffstat (limited to 'Eigen/src/UmfPackSupport')
-rw-r--r--Eigen/src/UmfPackSupport/UmfPackSupport.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/Eigen/src/UmfPackSupport/UmfPackSupport.h b/Eigen/src/UmfPackSupport/UmfPackSupport.h
index 5921a86b0..636bba87d 100644
--- a/Eigen/src/UmfPackSupport/UmfPackSupport.h
+++ b/Eigen/src/UmfPackSupport/UmfPackSupport.h
@@ -124,9 +124,11 @@ inline int umfpack_get_determinant(std::complex<double> *Mx, double *Ex, void *N
* \brief A sparse LU factorization and solver based on UmfPack
*
* This class allows to solve for A.X = B sparse linear problems via a LU factorization
- * using the UmfPack library. The sparse matrix A must be column-major, squared and full rank.
+ * using the UmfPack library. The sparse matrix A must be in a compressed column-major form, squared and full rank.
* The vectors or matrices X and B can be either dense or sparse.
*
+ * WARNING The Eigen column-major SparseMatrix is not always in compressed form.
+ * The user should call makeCompressed() to get a matrix in CSC suitable for UMFPACK
* \tparam _MatrixType the type of the sparse matrix A, it must be a SparseMatrix<>
*
* \sa \ref TutorialSparseDirectSolvers
@@ -198,7 +200,9 @@ class UmfPackLU
return m_q;
}
- /** Computes the sparse Cholesky decomposition of \a matrix */
+ /** Computes the sparse Cholesky decomposition of \a matrix
+ * Note that the matrix should be in compressed format. Please, use makeCompressed() to get it !!
+ */
void compute(const MatrixType& matrix)
{
analyzePattern(matrix);