GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-05-05 10:14:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix bug #688: make it clearer that CG is for both dense and sparse matrices.

Browse Source
This commit is contained in:
Gael Guennebaud 2013-10-28 15:56:30 +01:00
parent 9f3f42d66a
commit 285112fc55
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Eigen/src/IterativeLinearSolvers/ConjugateGradient.h
View File

@ -107,12 +107,12 @@ struct traits<ConjugateGradient<_MatrixType,_UpLo,_Preconditioner> >
} }
/** \ingroup IterativeLinearSolvers_Module /** \ingroup IterativeLinearSolvers_Module
* \brief A conjugate gradient solver for sparse self-adjoint problems * \brief A conjugate gradient solver for sparse (or dense) self-adjoint problems
* *
* This class allows to solve for A.x = b sparse linear problems using a conjugate gradient algorithm. * This class allows to solve for A.x = b linear problems using an iterative conjugate gradient algorithm.
* The sparse matrix A must be selfadjoint. The vectors x and b can be either dense or sparse. * The matrix A must be selfadjoint. The matrix A and the vectors x and b can be either dense or sparse.
* *
* \tparam _MatrixType the type of the sparse matrix A, can be a dense or a sparse matrix. * \tparam _MatrixType the type of the matrix A, can be a dense or a sparse matrix.
* \tparam _UpLo the triangular part that will be used for the computations. It can be Lower * \tparam _UpLo the triangular part that will be used for the computations. It can be Lower
* or Upper. Default is Lower. * or Upper. Default is Lower.
* \tparam _Preconditioner the type of the preconditioner. Default is DiagonalPreconditioner * \tparam _Preconditioner the type of the preconditioner. Default is DiagonalPreconditioner