Ginkgo  Generated from pipelines/224724463 branch based on develop. Ginkgo version 1.3.0
A numerical linear algebra library targeting many-core architectures
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
gko::solver::Bicg< ValueType > Class Template Reference

BICG or the Biconjugate gradient method is a Krylov subspace solver. More...

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

Collaboration diagram for gko::solver::Bicg< ValueType >:
[legend]

Classes

class  Factory
 
struct  parameters_type
 

Public Types

using value_type = ValueType
 
using transposed_type = Bicg< ValueType >
 
- Public Types inherited from gko::EnablePolymorphicAssignment< Bicg< ValueType > >
using result_type = Bicg< ValueType >
 
- Public Types inherited from gko::ConvertibleTo< Bicg< ValueType > >
using result_type = Bicg< ValueType >
 

Public Member Functions

std::shared_ptr< const LinOpget_system_matrix () const
 Gets the system operator (matrix) of the linear system. More...
 
std::unique_ptr< LinOptranspose () const override
 Returns a LinOp representing the transpose of the Transposable object. More...
 
std::unique_ptr< LinOpconj_transpose () const override
 Returns a LinOp representing the conjugate transpose of the Transposable object. More...
 
bool apply_uses_initial_guess () const override
 Return true as iterative solvers use the data in x as an initial guess. More...
 
std::shared_ptr< const stop::CriterionFactoryget_stop_criterion_factory () const
 Gets the stopping criterion factory of the solver. More...
 
void set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > other)
 Sets the stopping criterion of the solver. More...
 
const parameters_typeget_parameters () const
 
- Public Member Functions inherited from gko::EnableLinOp< Bicg< ValueType > >
const Bicg< ValueType > * apply (const LinOp *b, LinOp *x) const
 
Bicg< ValueType > * apply (const LinOp *b, LinOp *x)
 
const Bicg< ValueType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 
Bicg< ValueType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Bicg< ValueType >, LinOp >
std::unique_ptr< Bicg< ValueType > > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Bicg< ValueType > > create_default () const
 
std::unique_ptr< Bicg< ValueType > > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Bicg< ValueType > > clone () const
 
Bicg< ValueType > * copy_from (const PolymorphicObject *other)
 
Bicg< ValueType > * copy_from (std::unique_ptr< PolymorphicObject > other)
 
Bicg< ValueType > * clear ()
 
- Public Member Functions inherited from gko::LinOp
LinOpapply (const LinOp *b, LinOp *x)
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
const LinOpapply (const LinOp *b, LinOp *x) const
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
LinOpapply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 Performs the operation x = alpha * op(b) + beta * x. More...
 
const LinOpapply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 Performs the operation x = alpha * op(b) + beta * x. More...
 
const dim< 2 > & get_size () const noexcept
 Returns the size of the operator. More...
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOpcreate_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpcreate_default () const
 
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpclone () const
 
LinOpcopy_from (const PolymorphicObject *other)
 
LinOpcopy_from (std::unique_ptr< PolymorphicObject > other)
 
LinOpclear ()
 
- Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObjectoperator= (const PolymorphicObject &)
 
std::unique_ptr< PolymorphicObjectcreate_default (std::shared_ptr< const Executor > exec) const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object. More...
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object. More...
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object. More...
 
PolymorphicObjectcopy_from (std::unique_ptr< PolymorphicObject > other)
 Moves another object into this object. More...
 
PolymorphicObjectclear ()
 Transforms the object into its default state. More...
 
std::shared_ptr< const Executorget_executor () const noexcept
 Returns the Executor of the object. More...
 
- Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void add_logger (std::shared_ptr< const Logger > logger) override
 Adds a new logger to the list of subscribed loggers. More...
 
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers. More...
 
- Public Member Functions inherited from gko::EnablePolymorphicAssignment< Bicg< ValueType > >
void convert_to (result_type *result) const override
 Converts the implementer to an object of type result_type. More...
 
void move_to (result_type *result) override
 Converts the implementer to an object of type result_type by moving data from this object. More...
 
- Public Member Functions inherited from gko::Preconditionable
virtual std::shared_ptr< const LinOpget_preconditioner () const
 Returns the preconditioner operator used by the Preconditionable. More...
 
virtual void set_preconditioner (std::shared_ptr< const LinOp > new_precond)
 Sets the preconditioner operator used by the Preconditionable. More...
 

Static Public Member Functions

static auto build () -> decltype(Factory ::create())
 

Friends

class EnableLinOp< Bicg >
 
class EnablePolymorphicObject< Bicg, LinOp >
 

Detailed Description

template<typename ValueType = default_precision>
class gko::solver::Bicg< ValueType >

BICG or the Biconjugate gradient method is a Krylov subspace solver.

Being a generic solver, it is capable of solving general matrices, including non-s.p.d matrices. Though, the memory and the computational requirement of the BiCG solver are higher than of its s.p.d solver counterpart, it has the capability to solve generic systems.

BiCG is based on the bi-Lanczos tridiagonalization method and in exact arithmetic should terminate in at most N iterations (2N MV's, with A and A^H). It forms the basis of many of the cheaper methods such as BiCGSTAB and CGS.

Reference: R.Fletcher, Conjugate gradient methods for indefinite systems, doi: 10.1007/BFb0080116

Template Parameters
ValueTypeprecision of matrix elements

Member Function Documentation

◆ apply_uses_initial_guess()

template<typename ValueType = default_precision>
bool gko::solver::Bicg< ValueType >::apply_uses_initial_guess ( ) const
inlineoverridevirtual

Return true as iterative solvers use the data in x as an initial guess.

Returns
true as iterative solvers use the data in x as an initial guess.

Reimplemented from gko::LinOp.

◆ conj_transpose()

template<typename ValueType = default_precision>
std::unique_ptr<LinOp> gko::solver::Bicg< ValueType >::conj_transpose ( ) const
overridevirtual

Returns a LinOp representing the conjugate transpose of the Transposable object.

Returns
a pointer to the new conjugate transposed object

Implements gko::Transposable.

◆ get_stop_criterion_factory()

template<typename ValueType = default_precision>
std::shared_ptr<const stop::CriterionFactory> gko::solver::Bicg< ValueType >::get_stop_criterion_factory ( ) const
inline

Gets the stopping criterion factory of the solver.

Returns
the stopping criterion factory

◆ get_system_matrix()

template<typename ValueType = default_precision>
std::shared_ptr<const LinOp> gko::solver::Bicg< ValueType >::get_system_matrix ( ) const
inline

Gets the system operator (matrix) of the linear system.

Returns
the system operator (matrix)

◆ set_stop_criterion_factory()

template<typename ValueType = default_precision>
void gko::solver::Bicg< ValueType >::set_stop_criterion_factory ( std::shared_ptr< const stop::CriterionFactory other)
inline

Sets the stopping criterion of the solver.

Parameters
otherthe new stopping criterion factory

◆ transpose()

template<typename ValueType = default_precision>
std::unique_ptr<LinOp> gko::solver::Bicg< ValueType >::transpose ( ) const
overridevirtual

Returns a LinOp representing the transpose of the Transposable object.

Returns
a pointer to the new transposed object

Implements gko::Transposable.


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