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

Fix typos in docs for IterativeLinearSolvers module

Browse Source
This commit is contained in:
Jitse Niesen 2014-09-21 14:20:08 +01:00
parent 5fa69422a2
commit 333905b0c2
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Eigen/src/IterativeLinearSolvers/BiCGSTAB.h
View File

@ -143,7 +143,7 @@ struct traits<BiCGSTAB<_MatrixType,_Preconditioner> >
* step execution example starting with a random guess and printing the evolution * step execution example starting with a random guess and printing the evolution
* of the estimated error: * of the estimated error:
* \include BiCGSTAB_step_by_step.cpp * \include BiCGSTAB_step_by_step.cpp
* Note that such a step by step excution is slightly slower. * Note that such a step by step execution is slightly slower.
* *
* \sa class SimplicialCholesky, DiagonalPreconditioner, IdentityPreconditioner * \sa class SimplicialCholesky, DiagonalPreconditioner, IdentityPreconditioner
*/ */

12
Eigen/src/IterativeLinearSolvers/IterativeSolverBase.h
View File

@ -60,10 +60,10 @@ public:
~IterativeSolverBase() {} ~IterativeSolverBase() {}
/** Initializes the iterative solver for the sparcity pattern of the matrix \a A for further solving \c Ax=b problems. /** Initializes the iterative solver for the sparsity pattern of the matrix \a A for further solving \c Ax=b problems.
* *
* Currently, this function mostly call analyzePattern on the preconditioner. In the future * Currently, this function mostly calls analyzePattern on the preconditioner. In the future
* we might, for instance, implement column reodering for faster matrix vector products. * we might, for instance, implement column reordering for faster matrix vector products.
*/ */
Derived& analyzePattern(const MatrixType& A) Derived& analyzePattern(const MatrixType& A)
{ {
@ -76,7 +76,7 @@ public:
/** Initializes the iterative solver with the numerical values of the matrix \a A for further solving \c Ax=b problems. /** Initializes the iterative solver with the numerical values of the matrix \a A for further solving \c Ax=b problems.
* *
* Currently, this function mostly call factorize on the preconditioner. * Currently, this function mostly calls factorize on the preconditioner.
* *
* \warning this class stores a reference to the matrix A as well as some * \warning this class stores a reference to the matrix A as well as some
* precomputed values that depend on it. Therefore, if \a A is changed * precomputed values that depend on it. Therefore, if \a A is changed
@ -95,8 +95,8 @@ public:
/** Initializes the iterative solver with the matrix \a A for further solving \c Ax=b problems. /** Initializes the iterative solver with the matrix \a A for further solving \c Ax=b problems.
* *
* Currently, this function mostly initialized/compute the preconditioner. In the future * Currently, this function mostly initializes/computes the preconditioner. In the future
* we might, for instance, implement column reodering for faster matrix vector products. * we might, for instance, implement column reordering for faster matrix vector products.
* *
* \warning this class stores a reference to the matrix A as well as some * \warning this class stores a reference to the matrix A as well as some
* precomputed values that depend on it. Therefore, if \a A is changed * precomputed values that depend on it. Therefore, if \a A is changed