diff options
author | Gael Guennebaud <g.gael@free.fr> | 2015-12-16 10:47:03 +0100 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2015-12-16 10:47:03 +0100 |
commit | ae8b217a01f07711aa2e57f6b3cf93da77d6d82a (patch) | |
tree | 763d1770146a9c8cef926869345f0c7230210bd4 | |
parent | 35d8725c73cfcce45ebb774e25e51bd5ab5e61b7 (diff) |
Update doc to make it clear that only SuperLU 4.x is supported
-rw-r--r-- | Eigen/SuperLUSupport | 2 | ||||
-rw-r--r-- | Eigen/src/SuperLUSupport/SuperLUSupport.h | 4 |
2 files changed, 5 insertions, 1 deletions
diff --git a/Eigen/SuperLUSupport b/Eigen/SuperLUSupport index 0ae9f3fdf..113f58ee5 100644 --- a/Eigen/SuperLUSupport +++ b/Eigen/SuperLUSupport @@ -43,6 +43,8 @@ namespace Eigen { struct SluMatrix; } * - class SuperLU: a supernodal sequential LU factorization. * - class SuperILU: a supernodal sequential incomplete LU factorization (to be used as a preconditioner for iterative methods). * + * \warning This wrapper is only for the 4.x versions of SuperLU. The 3.x and 5.x versions are not supported. + * * \warning When including this module, you have to use SUPERLU_EMPTY instead of EMPTY which is no longer defined because it is too polluting. * * \code diff --git a/Eigen/src/SuperLUSupport/SuperLUSupport.h b/Eigen/src/SuperLUSupport/SuperLUSupport.h index b20da37f7..fd2b26581 100644 --- a/Eigen/src/SuperLUSupport/SuperLUSupport.h +++ b/Eigen/src/SuperLUSupport/SuperLUSupport.h @@ -452,6 +452,8 @@ class SuperLUBase : public SparseSolverBase<Derived> * * \tparam _MatrixType the type of the sparse matrix A, it must be a SparseMatrix<> * + * \warning This class is only for the 4.x versions of SuperLU. The 3.x and 5.x versions are not supported. + * * \implsparsesolverconcept * * \sa \ref TutorialSparseDirectSolvers @@ -801,7 +803,7 @@ typename SuperLU<MatrixType>::Scalar SuperLU<MatrixType>::determinant() const * This class allows to solve for an approximate solution of A.X = B sparse linear problems via an incomplete LU factorization * using the SuperLU library. This class is aimed to be used as a preconditioner of the iterative linear solvers. * - * \warning This class requires SuperLU 4 or later. + * \warning This class is only for the 4.x versions of SuperLU. The 3.x and 5.x versions are not supported. * * \tparam _MatrixType the type of the sparse matrix A, it must be a SparseMatrix<> * |