Minor correction/clarification to LSCG solver documentation

This commit is contained in:
Essex Edwards
2022-01-14 19:48:54 +00:00
committed by David Tellenbach
parent 5fe0115724
commit 49a8a1e07a
2 changed files with 2 additions and 2 deletions

View File

@@ -113,7 +113,7 @@ struct traits<LeastSquaresConjugateGradient<MatrixType_,Preconditioner_> >
/** \ingroup IterativeLinearSolvers_Module
* \brief A conjugate gradient solver for sparse (or dense) least-square problems
*
* This class allows to solve for A x = b linear problems using an iterative conjugate gradient algorithm.
* This class solves for the least-squares solution to A x = b using an iterative conjugate gradient algorithm.
* The matrix A can be non symmetric and rectangular, but the matrix A' A should be positive-definite to guaranty stability.
* Otherwise, the SparseLU or SparseQR classes might be preferable.
* The matrix A and the vectors x and b can be either dense or sparse.