MatrixfreeSolverExample.dox 758 B

1234567891011121314151617181920
  1. namespace Eigen {
  2. /**
  3. \eigenManualPage MatrixfreeSolverExample Matrix-free solvers
  4. 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:
  5. - \c Index \c rows() and \c Index \c cols(): returns number of rows and columns respectively
  6. - \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)
  7. \c Eigen::internal::traits<> must also be specialized for the wrapper type.
  8. Here is a complete example wrapping an Eigen::SparseMatrix:
  9. \include matrixfree_cg.cpp
  10. Output: \verbinclude matrixfree_cg.out
  11. */
  12. }