EnablePreconditionedIterativeSolver< ValueType, DerivedType > Class Template Reference

EnablePreconditionedIterativeSolver&lt; ValueType, DerivedType &gt; Class Template Reference#

Reference API: gko::solver::EnablePreconditionedIterativeSolver< ValueType, DerivedType > Class Template Reference
Reference API
gko::solver::EnablePreconditionedIterativeSolver< ValueType, DerivedType > Class Template Reference

#include <ginkgo/core/solver/solver_base.hpp>

Inheritance diagram for gko::solver::EnablePreconditionedIterativeSolver< ValueType, DerivedType >:
[legend]

Public Member Functions

 EnablePreconditionedIterativeSolver (std::shared_ptr< const LinOp > system_matrix, std::shared_ptr< const stop::CriterionFactory > stop_factory, std::shared_ptr< const LinOp > preconditioner)
 
template<typename FactoryParameters >
 EnablePreconditionedIterativeSolver (std::shared_ptr< const LinOp > system_matrix, const FactoryParameters &params)
 
- Public Member Functions inherited from gko::solver::EnableSolverBase< DerivedType, MatrixType >
EnableSolverBaseoperator= (const EnableSolverBase &other)
 
EnableSolverBaseoperator= (EnableSolverBase &&other)
 
 EnableSolverBase (std::shared_ptr< const MatrixType > system_matrix)
 
 EnableSolverBase (const EnableSolverBase &other)
 
 EnableSolverBase (EnableSolverBase &&other)
 
int get_num_workspace_ops () const override
 
std::vector< std::string > get_workspace_op_names () const override
 
std::vector< int > get_workspace_scalars () const override
 
std::vector< int > get_workspace_vectors () const override
 
- Public Member Functions inherited from gko::solver::SolverBase< MatrixType >
std::shared_ptr< const MatrixType > get_system_matrix () const
 
- Public Member Functions inherited from gko::solver::EnableIterativeBase< DerivedType >
EnableIterativeBaseoperator= (const EnableIterativeBase &other)
 
EnableIterativeBaseoperator= (EnableIterativeBase &&other)
 
 EnableIterativeBase (std::shared_ptr< const stop::CriterionFactory > stop_factory)
 
 EnableIterativeBase (const EnableIterativeBase &other)
 
 EnableIterativeBase (EnableIterativeBase &&other)
 
void set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > new_stop_factory) override
 
- Public Member Functions inherited from gko::solver::IterativeBase
std::shared_ptr< const stop::CriterionFactoryget_stop_criterion_factory () const
 
- Public Member Functions inherited from gko::solver::EnablePreconditionable< DerivedType >
void set_preconditioner (std::shared_ptr< const LinOp > new_precond) override
 
EnablePreconditionableoperator= (const EnablePreconditionable &other)
 
EnablePreconditionableoperator= (EnablePreconditionable &&other)
 
 EnablePreconditionable (std::shared_ptr< const LinOp > preconditioner)
 
 EnablePreconditionable (const EnablePreconditionable &other)
 
 EnablePreconditionable (EnablePreconditionable &&other)
 
- Public Member Functions inherited from gko::Preconditionable
virtual std::shared_ptr< const LinOpget_preconditioner () const
 

Additional Inherited Members

- Protected Member Functions inherited from gko::solver::EnableSolverBase< DerivedType, MatrixType >
void set_system_matrix (std::shared_ptr< const MatrixType > new_system_matrix)
 
void setup_workspace () const
 
- Protected Member Functions inherited from gko::solver::SolverBase< MatrixType >
void set_system_matrix_base (std::shared_ptr< const MatrixType > system_matrix)
 

Detailed Description

template<typename ValueType, typename DerivedType>
class gko::solver::EnablePreconditionedIterativeSolver< ValueType, DerivedType >

A LinOp implementing this interface stores a system matrix and stopping criterion factory.

Template Parameters
ValueTypethe value type that iterative solver uses for its vectors
DerivedTypethe CRTP type that derives from this

The documentation for this class was generated from the following file: