Clarify documentation of the tolerance and error returned in iterative solvers

This commit is contained in:
Gael Guennebaud
2015-06-25 13:51:13 +02:00
parent 84264ceebc
commit 973b0a90db
3 changed files with 15 additions and 3 deletions

View File

@@ -121,6 +121,8 @@ struct traits<ConjugateGradient<_MatrixType,_UpLo,_Preconditioner> >
* and setTolerance() methods. The defaults are the size of the problem for the maximal number of iterations
* and NumTraits<Scalar>::epsilon() for the tolerance.
*
* The tolerance is the relative residual error: |Ax-b|/|b|
*
* This class can be used as the direct solver classes. Here is a typical usage example:
\code
int n = 10000;