aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/MatrixfreeSolverExample.dox
blob: 000cb0bbe06cc7d9bcd6edf3c0d3e17e0c5d51b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

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)

Eigen::internal::traits<> must also be specialized for the wrapper type.

Here is a complete example wrapping a Eigen::SparseMatrix:
\include matrixfree_cg.cpp
Output: \verbinclude matrixfree_cg.out

*/

}