![]() |
Ginkgo
Generated from pipelines/2011557978 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
|
PIPE_CG or the pipelined conjugate gradient method is an iterative type Krylov subspace method which is suitable for symmetric positive definite methods. More...
#include <ginkgo/core/solver/pipe_cg.hpp>
Classes | |
class | Factory |
struct | parameters_type |
Public Types | |
using | value_type = ValueType |
using | transposed_type = PipeCg< ValueType > |
![]() | |
using | result_type = PipeCg< ValueType > |
![]() | |
using | result_type = PipeCg< ValueType > |
Public Member Functions | |
std::unique_ptr< LinOp > | transpose () const override |
Returns a LinOp representing the transpose of the Transposable object. More... | |
std::unique_ptr< LinOp > | conj_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... | |
const parameters_type & | get_parameters () const |
![]() | |
const PipeCg< ValueType > * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
PipeCg< ValueType > * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) |
const PipeCg< ValueType > * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const |
PipeCg< ValueType > * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) |
![]() | |
std::unique_ptr< PipeCg< ValueType > > | create_default (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< PipeCg< ValueType > > | create_default () const |
std::unique_ptr< PipeCg< ValueType > > | clone (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< PipeCg< ValueType > > | clone () const |
PipeCg< ValueType > * | copy_from (const PolymorphicObject *other) |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PipeCg< ValueType > > * | copy_from (std::unique_ptr< Derived > &&other) |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PipeCg< ValueType > > * | copy_from (const std::unique_ptr< Derived > &other) |
PipeCg< ValueType > * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
PipeCg< ValueType > * | move_from (ptr_param< PolymorphicObject > other) |
PipeCg< ValueType > * | clear () |
![]() | |
LinOp * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) |
Applies a linear operator to a vector (or a sequence of vectors). More... | |
const LinOp * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
LinOp * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) |
Performs the operation x = alpha * op(b) + beta * x. More... | |
const LinOp * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const |
const dim< 2 > & | get_size () const noexcept |
Returns the size of the operator. More... | |
LinOp & | operator= (const LinOp &)=default |
Copy-assigns a LinOp. More... | |
LinOp & | operator= (LinOp &&other) |
Move-assigns a LinOp. More... | |
LinOp (const LinOp &)=default | |
Copy-constructs a LinOp. More... | |
LinOp (LinOp &&other) | |
Move-constructs a LinOp. More... | |
![]() | |
std::unique_ptr< LinOp > | create_default (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< LinOp > | create_default () const |
std::unique_ptr< LinOp > | clone (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< LinOp > | clone () const |
LinOp * | copy_from (const PolymorphicObject *other) |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * | copy_from (std::unique_ptr< Derived > &&other) |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * | copy_from (const std::unique_ptr< Derived > &other) |
LinOp * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
LinOp * | move_from (ptr_param< PolymorphicObject > other) |
LinOp * | clear () |
![]() | |
PolymorphicObject & | operator= (const PolymorphicObject &) |
std::unique_ptr< PolymorphicObject > | create_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< PolymorphicObject > | create_default () const |
Creates a new "default" object of the same dynamic type as this object. More... | |
std::unique_ptr< PolymorphicObject > | clone (std::shared_ptr< const Executor > exec) const |
Creates a clone of the object. More... | |
std::unique_ptr< PolymorphicObject > | clone () const |
Creates a clone of the object. More... | |
PolymorphicObject * | copy_from (const PolymorphicObject *other) |
Copies another object into this object. More... | |
template<typename Derived , typename Deleter > | |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > * | copy_from (std::unique_ptr< Derived, Deleter > &&other) |
Moves another object into this object. More... | |
template<typename Derived , typename Deleter > | |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > * | copy_from (const std::unique_ptr< Derived, Deleter > &other) |
Copies another object into this object. More... | |
PolymorphicObject * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
Copies another object into this object. More... | |
PolymorphicObject * | move_from (ptr_param< PolymorphicObject > other) |
Moves another object into this object. More... | |
PolymorphicObject * | clear () |
Transforms the object into its default state. More... | |
std::shared_ptr< const Executor > | get_executor () const noexcept |
Returns the Executor of the object. More... | |
![]() | |
void | add_logger (std::shared_ptr< const Logger > logger) override |
void | remove_logger (const Logger *logger) override |
void | remove_logger (ptr_param< const Logger > logger) |
const std::vector< std::shared_ptr< const Logger > > & | get_loggers () const override |
void | clear_loggers () override |
![]() | |
void | remove_logger (ptr_param< const Logger > logger) |
![]() | |
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... | |
![]() | |
void | convert_to (ptr_param< result_type > result) const |
void | move_to (ptr_param< result_type > result) |
![]() | |
EnablePreconditionedIterativeSolver (std::shared_ptr< const LinOp > system_matrix, std::shared_ptr< const stop::CriterionFactory > stop_factory, std::shared_ptr< const LinOp > preconditioner) | |
EnablePreconditionedIterativeSolver (std::shared_ptr< const LinOp > system_matrix, const FactoryParameters ¶ms) | |
![]() | |
EnableSolverBase & | operator= (const EnableSolverBase &other) |
Creates a shallow copy of the provided system matrix, clones it onto this executor if executors don't match. | |
EnableSolverBase & | operator= (EnableSolverBase &&other) |
Moves the provided system matrix, clones it onto this executor if executors don't match. More... | |
EnableSolverBase (std::shared_ptr< const LinOp > system_matrix) | |
EnableSolverBase (const EnableSolverBase &other) | |
Creates a shallow copy of the provided system matrix. | |
EnableSolverBase (EnableSolverBase &&other) | |
Moves the provided system matrix. More... | |
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 |
Returns the IDs of all scalars (workspace vectors with system dimension-independent size, usually 1 x num_rhs). | |
std::vector< int > | get_workspace_vectors () const override |
Returns the IDs of all vectors (workspace vectors with system dimension-dependent size, usually system_matrix_size x num_rhs). | |
![]() | |
std::shared_ptr< const LinOp > | get_system_matrix () const |
Returns the system matrix, with its concrete type, used by the solver. More... | |
![]() | |
EnableIterativeBase & | operator= (const EnableIterativeBase &other) |
Creates a shallow copy of the provided stopping criterion, clones it onto this executor if executors don't match. | |
EnableIterativeBase & | operator= (EnableIterativeBase &&other) |
Moves the provided stopping criterion, clones it onto this executor if executors don't match. More... | |
EnableIterativeBase (std::shared_ptr< const stop::CriterionFactory > stop_factory) | |
EnableIterativeBase (const EnableIterativeBase &other) | |
Creates a shallow copy of the provided stopping criterion. | |
EnableIterativeBase (EnableIterativeBase &&other) | |
Moves the provided stopping criterion. More... | |
void | set_stop_criterion_factory (std::shared_ptr< const stop::CriterionFactory > new_stop_factory) override |
Sets the stopping criterion of the solver. More... | |
![]() | |
std::shared_ptr< const stop::CriterionFactory > | get_stop_criterion_factory () const |
Gets the stopping criterion factory of the solver. More... | |
![]() | |
void | set_preconditioner (std::shared_ptr< const LinOp > new_precond) override |
Sets the preconditioner operator used by the Preconditionable. More... | |
EnablePreconditionable & | operator= (const EnablePreconditionable &other) |
Creates a shallow copy of the provided preconditioner, clones it onto this executor if executors don't match. | |
EnablePreconditionable & | operator= (EnablePreconditionable &&other) |
Moves the provided preconditioner, clones it onto this executor if executors don't match. More... | |
EnablePreconditionable (std::shared_ptr< const LinOp > preconditioner) | |
EnablePreconditionable (const EnablePreconditionable &other) | |
Creates a shallow copy of the provided preconditioner. | |
EnablePreconditionable (EnablePreconditionable &&other) | |
Moves the provided preconditioner. More... | |
![]() | |
virtual std::shared_ptr< const LinOp > | get_preconditioner () const |
Returns the preconditioner operator used by the Preconditionable. More... | |
Static Public Member Functions | |
static auto | build () -> decltype(Factory ::create()) |
static parameters_type | parse (const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType >()) |
Create the parameters from the property_tree. More... | |
Friends | |
class | EnableLinOp< PipeCg > |
class | EnablePolymorphicObject< PipeCg, LinOp > |
PIPE_CG or the pipelined conjugate gradient method is an iterative type Krylov subspace method which is suitable for symmetric positive definite methods.
It improves upon the CG method by allowing computation of inner products and norms to be overlapped with operator and preconditioner application. The pipelined method scales up to the 10^6 nodes of the assumed exascale machine, while its standard counterpart level off about one order of magnitude earlier, as suggested in the referenced paper (see below).
Possible issues:
The implementation in Ginkgo is based on the following paper: Pipelined, Flexible Krylov Subspace Methods, P. Sanan et. al, SISC, 2016, doi: 10.1137/15M1049130
ValueType | precision of matrix elements |
|
inlineoverridevirtual |
Return true as iterative solvers use the data in x as an initial guess.
Reimplemented from gko::LinOp.
|
overridevirtual |
Returns a LinOp representing the conjugate transpose of the Transposable object.
Implements gko::Transposable.
|
static |
Create the parameters from the property_tree.
Because this is directly tied to the specific type, the value/index type settings within config are ignored and type_descriptor is only used for children configs.
config | the property tree for setting |
context | the registry |
td_for_child | the type descriptor for children configs. The default uses the value type of this class. |
|
overridevirtual |
Returns a LinOp representing the transpose of the Transposable object.
Implements gko::Transposable.