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

Minor correction/clarification to LSCG solver documentation

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Eigen/src/IterativeLinearSolvers/LeastSquareConjugateGradient.h
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.

2
doc/SparseLinearSystems.dox
View File

@ -42,7 +42,7 @@ They are summarized in the following tables:
<tr><td>LeastSquaresConjugateGradient \n <tt>\#include<Eigen/\link IterativeLinearSolvers_Module IterativeLinearSolvers\endlink></tt></td><td>CG for rectangular least-square problem</td><td>Rectangular</td>
<td>IdentityPreconditioner, [LeastSquareDiagonalPreconditioner]</td>
<td>Solve for min |A'Ax-b|^2 without forming A'A</td></tr>
<td>Solve for min |Ax-b|^2 without forming A'A</td></tr>
<tr><td>BiCGSTAB \n <tt>\#include<Eigen/\link IterativeLinearSolvers_Module IterativeLinearSolvers\endlink></tt></td><td>Iterative stabilized bi-conjugate gradient</td><td>Square</td>
<td>IdentityPreconditioner, [DiagonalPreconditioner], IncompleteLUT</td>