aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/IterativeLinearSolvers/ConjugateGradient.h
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2011-12-02 19:02:49 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2011-12-02 19:02:49 +0100
commite759086dcd31358ece573226abf5fc650db8b1dc (patch)
treef2579af252616b9d61af0604e8571dc474bcb1e9 /Eigen/src/IterativeLinearSolvers/ConjugateGradient.h
parent4ca89f32ed7bbbc4938825a416642782583988e0 (diff)
improve documentation of some sparse related classes
Diffstat (limited to 'Eigen/src/IterativeLinearSolvers/ConjugateGradient.h')
-rw-r--r--Eigen/src/IterativeLinearSolvers/ConjugateGradient.h3
1 files changed, 2 insertions, 1 deletions
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.