 |
Ginkgo
Generated from pipelines/2011557978 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
|
5 #ifndef GKO_PUBLIC_CORE_SOLVER_PIPE_CG_HPP_
6 #define GKO_PUBLIC_CORE_SOLVER_PIPE_CG_HPP_
11 #include <ginkgo/core/base/array.hpp>
12 #include <ginkgo/core/base/exception_helpers.hpp>
13 #include <ginkgo/core/base/lin_op.hpp>
14 #include <ginkgo/core/base/math.hpp>
15 #include <ginkgo/core/base/types.hpp>
16 #include <ginkgo/core/config/config.hpp>
17 #include <ginkgo/core/config/registry.hpp>
18 #include <ginkgo/core/config/type_descriptor.hpp>
19 #include <ginkgo/core/log/logger.hpp>
20 #include <ginkgo/core/matrix/dense.hpp>
21 #include <ginkgo/core/matrix/identity.hpp>
22 #include <ginkgo/core/solver/solver_base.hpp>
23 #include <ginkgo/core/stop/combined.hpp>
24 #include <ginkgo/core/stop/criterion.hpp>
60 template <
typename ValueType = default_precision>
69 using value_type = ValueType;
72 std::unique_ptr<LinOp>
transpose()
const override;
87 parameters_type, Factory> {};
108 config::make_type_descriptor<ValueType>());
111 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
113 template <
typename VectorType>
114 void apply_dense_impl(
const VectorType* b, VectorType* x)
const;
117 LinOp* x)
const override;
119 explicit PipeCg(std::shared_ptr<const Executor> exec)
124 std::shared_ptr<const LinOp> system_matrix)
128 std::move(system_matrix), factory->get_parameters()},
129 parameters_{factory->get_parameters()}
134 template <
typename ValueType>
138 static int num_vectors(
const Solver&);
140 static int num_arrays(
const Solver&);
142 static std::vector<std::string> op_names(
const Solver&);
144 static std::vector<std::string> array_names(
const Solver&);
146 static std::vector<int> scalars(
const Solver&);
148 static std::vector<int> vectors(
const Solver&);
151 constexpr
static int r = 0;
153 constexpr
static int z = 1;
155 constexpr
static int p = 2;
157 constexpr
static int w = 3;
159 constexpr
static int m = 4;
161 constexpr
static int n = 5;
163 constexpr
static int q = 6;
165 constexpr
static int f = 7;
167 constexpr
static int g = 8;
169 constexpr
static int beta = 9;
171 constexpr
static int delta = 10;
173 constexpr
static int prev_rho = 11;
175 constexpr
static int rho = 12;
177 constexpr
static int one = 13;
179 constexpr
static int minus_one = 14;
182 constexpr
static int stop = 0;
184 constexpr
static int tmp = 1;
192 #endif // GKO_PUBLIC_CORE_SOLVER_PIPE_CG_HPP_
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
pnode describes a tree of properties.
Definition: property_tree.hpp:28
Definition: lin_op.hpp:117
Linear operators which support transposition should implement the Transposable interface.
Definition: lin_op.hpp:433
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition: pipe_cg.hpp:81
Definition: solver_base.hpp:854
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition: type_descriptor.hpp:39
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
Definition: pipe_cg.hpp:89
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.
Definition: pipe_cg.hpp:85
#define GKO_ENABLE_LIN_OP_FACTORY(_lin_op, _parameters_name, _factory_name)
This macro will generate a default implementation of a LinOpFactory for the LinOp subclass it is defi...
Definition: lin_op.hpp:1017
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
This class stores additional context for creating Ginkgo objects from configuration files.
Definition: registry.hpp:167
#define GKO_ENABLE_BUILD_METHOD(_factory_name)
Defines a build method for the factory, simplifying its construction by removing the repetitive typin...
Definition: abstract_factory.hpp:394
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition: polymorphic_object.hpp:243
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition: solver_base.hpp:238
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition: lin_op.hpp:210
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition: lin_op.hpp:877
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition: solver_base.hpp:799
constexpr T one()
Returns the multiplicative identity for T.
Definition: math.hpp:654
PIPE_CG or the pipelined conjugate gradient method is an iterative type Krylov subspace method which ...
Definition: pipe_cg.hpp:61
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition: polymorphic_object.hpp:667