33#ifndef GKO_PUBLIC_CORE_SOLVER_CG_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_CG_HPP_
40#include <ginkgo/core/base/array.hpp>
41#include <ginkgo/core/base/exception_helpers.hpp>
42#include <ginkgo/core/base/lin_op.hpp>
43#include <ginkgo/core/base/math.hpp>
44#include <ginkgo/core/base/types.hpp>
45#include <ginkgo/core/log/logger.hpp>
46#include <ginkgo/core/matrix/dense.hpp>
47#include <ginkgo/core/matrix/identity.hpp>
48#include <ginkgo/core/solver/solver_base.hpp>
49#include <ginkgo/core/stop/combined.hpp>
50#include <ginkgo/core/stop/criterion.hpp>
73template <
typename ValueType = default_precision>
81 using value_type = ValueType;
99 parameters_type, Factory> {};
105 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
107 template <
typename VectorType>
111 LinOp* x)
const override;
113 explicit Cg(std::shared_ptr<const Executor> exec)
118 std::shared_ptr<const LinOp> system_matrix)
122 std::move(system_matrix), factory->get_parameters()},
123 parameters_{factory->get_parameters()}
128template <
typename ValueType>
132 static int num_vectors(
const Solver&);
134 static int num_arrays(
const Solver&);
136 static std::vector<std::string> op_names(
const Solver&);
138 static std::vector<std::string> array_names(
const Solver&);
140 static std::vector<int> scalars(
const Solver&);
142 static std::vector<int> vectors(
const Solver&);
145 constexpr static int r = 0;
147 constexpr static int z = 1;
149 constexpr static int p = 2;
151 constexpr static int q = 3;
153 constexpr static int alpha = 4;
155 constexpr static int beta = 5;
157 constexpr static int prev_rho = 6;
159 constexpr static int rho = 7;
161 constexpr static int one = 8;
163 constexpr static int minus_one = 9;
166 constexpr static int stop = 0;
168 constexpr static int tmp = 1;
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:908
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:691
Definition lin_op.hpp:146
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:263
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:462
CG or the conjugate gradient method is an iterative type Krylov subspace method which is suitable for...
Definition cg.hpp:76
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition cg.hpp:93
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:816
#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:422
#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:1046
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
Definition solver_base.hpp:869
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:267