diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2011-12-02 19:02:49 +0100 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2011-12-02 19:02:49 +0100 |
| commit | e759086dcd31358ece573226abf5fc650db8b1dc (patch) | |
| tree | f2579af252616b9d61af0604e8571dc474bcb1e9 /Eigen/src/IterativeLinearSolvers | |
| parent | 4ca89f32ed7bbbc4938825a416642782583988e0 (diff) | |
improve documentation of some sparse related classes
Diffstat (limited to 'Eigen/src/IterativeLinearSolvers')
4 files changed, 10 insertions, 5 deletions
diff --git a/Eigen/src/IterativeLinearSolvers/BasicPreconditioners.h b/Eigen/src/IterativeLinearSolvers/BasicPreconditioners.h index d9edd1461..b1da2f8ce 100644 --- a/Eigen/src/IterativeLinearSolvers/BasicPreconditioners.h +++ b/Eigen/src/IterativeLinearSolvers/BasicPreconditioners.h @@ -25,7 +25,8 @@ #ifndef EIGEN_BASIC_PRECONDITIONERS_H #define EIGEN_BASIC_PRECONDITIONERS_H -/** \brief A preconditioner based on the digonal entries +/** \ingroup IterativeLinearSolvers_Module + * \brief A preconditioner based on the digonal entries * * This class allows to approximately solve for A.x = b problems assuming A is a diagonal matrix. * In other words, this preconditioner neglects all off diagonal entries and, in Eigen's language, solves for: @@ -116,7 +117,8 @@ struct solve_retval<DiagonalPreconditioner<_MatrixType>, Rhs> } -/** \brief A naive preconditioner which approximates any matrix as the identity matrix +/** \ingroup IterativeLinearSolvers_Module + * \brief A naive preconditioner which approximates any matrix as the identity matrix * * \sa class DiagonalPreconditioner */ diff --git a/Eigen/src/IterativeLinearSolvers/BiCGSTAB.h b/Eigen/src/IterativeLinearSolvers/BiCGSTAB.h index 798f85da5..574b47384 100644 --- a/Eigen/src/IterativeLinearSolvers/BiCGSTAB.h +++ b/Eigen/src/IterativeLinearSolvers/BiCGSTAB.h @@ -115,7 +115,8 @@ struct traits<BiCGSTAB<_MatrixType,_Preconditioner> > } -/** \brief A bi conjugate gradient stabilized solver for sparse square problems +/** \ingroup IterativeLinearSolvers_Module + * \brief A bi conjugate gradient stabilized solver for sparse square problems * * This class allows to solve for A.x = b sparse linear problems using a bi conjugate gradient * stabilized algorithm. The vectors x and b can be either dense or sparse. diff --git a/Eigen/src/IterativeLinearSolvers/ConjugateGradient.h b/Eigen/src/IterativeLinearSolvers/ConjugateGradient.h index 35b89404a..8b3c93bf1 100644 --- a/Eigen/src/IterativeLinearSolvers/ConjugateGradient.h +++ b/Eigen/src/IterativeLinearSolvers/ConjugateGradient.h @@ -99,7 +99,8 @@ struct traits<ConjugateGradient<_MatrixType,_UpLo,_Preconditioner> > } -/** \brief A conjugate gradient solver for sparse self-adjoint problems +/** \ingroup IterativeLinearSolvers_Module + * \brief A conjugate gradient solver for sparse self-adjoint problems * * This class allows to solve for A.x = b sparse linear problems using a conjugate gradient algorithm. * The sparse matrix A must be selfadjoint. The vectors x and b can be either dense or sparse. diff --git a/Eigen/src/IterativeLinearSolvers/IterativeSolverBase.h b/Eigen/src/IterativeLinearSolvers/IterativeSolverBase.h index 5e8bbd3e2..9a4eca1a1 100644 --- a/Eigen/src/IterativeLinearSolvers/IterativeSolverBase.h +++ b/Eigen/src/IterativeLinearSolvers/IterativeSolverBase.h @@ -26,7 +26,8 @@ #define EIGEN_ITERATIVE_SOLVER_BASE_H -/** \brief Base class for linear iterative solvers +/** \ingroup IterativeLinearSolvers_Module + * \brief Base class for linear iterative solvers * * \sa class SimplicialCholesky, DiagonalPreconditioner, IdentityPreconditioner */ |