aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/MatrixfreeSolverExample.dox
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2016-07-26 23:51:43 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2016-07-26 23:51:43 +0200
commit9d16b6e1cfb3bd8e11ad81276be208bbbdcf1998 (patch)
tree79e97632a6bda8fac1b781901c803d25dd4bb242 /doc/MatrixfreeSolverExample.dox
parentfd2f989b1d6401e254693ba047f3230aabde3495 (diff)
Formatting
Diffstat (limited to 'doc/MatrixfreeSolverExample.dox')
-rw-r--r--doc/MatrixfreeSolverExample.dox8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/MatrixfreeSolverExample.dox b/doc/MatrixfreeSolverExample.dox
index 000cb0bbe..3efa292b5 100644
--- a/doc/MatrixfreeSolverExample.dox
+++ b/doc/MatrixfreeSolverExample.dox
@@ -6,12 +6,12 @@ namespace Eigen {
\eigenManualPage MatrixfreeSolverExample Matrix-free solvers
Iterative solvers such as ConjugateGradient and BiCGSTAB can be used in a matrix free context. To this end, user must provide a wrapper class inheriting EigenBase<> and implementing the following methods:
- - Index rows() and Index cols(): returns number of rows and columns respectively
- - operator* with and %Eigen dense column vector (its actual implementation goes in a specialization of the internal::generic_product_impl class)
+ - \c Index \c rows() and \c Index \c cols(): returns number of rows and columns respectively
+ - \c operator* with your type and an %Eigen dense column vector (its actual implementation goes in a specialization of the internal::generic_product_impl class)
-Eigen::internal::traits<> must also be specialized for the wrapper type.
+\c Eigen::internal::traits<> must also be specialized for the wrapper type.
-Here is a complete example wrapping a Eigen::SparseMatrix:
+Here is a complete example wrapping an Eigen::SparseMatrix:
\include matrixfree_cg.cpp
Output: \verbinclude matrixfree_cg.out