GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-07-21 20:34:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

Formatting

Browse Source
This commit is contained in:
Gael Guennebaud 2016-07-26 23:51:43 +02:00
parent fd2f989b1d
commit 9d16b6e1cf
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/MatrixfreeSolverExample.dox
View File

@ -6,12 +6,12 @@ namespace Eigen {
\eigenManualPage MatrixfreeSolverExample Matrix-free solvers \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: 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 - \c Index \c rows() and \c Index \c 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 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 \include matrixfree_cg.cpp
Output: \verbinclude matrixfree_cg.out Output: \verbinclude matrixfree_cg.out