33#ifndef GKO_PUBLIC_CORE_SOLVER_BICG_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_BICG_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/csr.hpp>
47#include <ginkgo/core/matrix/dense.hpp>
48#include <ginkgo/core/matrix/identity.hpp>
49#include <ginkgo/core/solver/solver_base.hpp>
50#include <ginkgo/core/stop/combined.hpp>
51#include <ginkgo/core/stop/criterion.hpp>
79template <
typename ValueType = default_precision>
88 using value_type = ValueType;
106 parameters_type, Factory> {};
112 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
118 LinOp* x)
const override;
120 explicit Bicg(std::shared_ptr<const Executor> exec)
125 std::shared_ptr<const LinOp> system_matrix)
129 std::move(system_matrix), factory->get_parameters()},
130 parameters_{factory->get_parameters()}
135template <
typename ValueType>
139 static int num_vectors(
const Solver&);
141 static int num_arrays(
const Solver&);
143 static std::vector<std::string> op_names(
const Solver&);
145 static std::vector<std::string> array_names(
const Solver&);
147 static std::vector<int> scalars(
const Solver&);
149 static std::vector<int> vectors(
const Solver&);
152 constexpr static int r = 0;
154 constexpr static int z = 1;
156 constexpr static int p = 2;
158 constexpr static int q = 3;
160 constexpr static int r2 = 4;
162 constexpr static int z2 = 5;
164 constexpr static int p2 = 6;
166 constexpr static int q2 = 7;
168 constexpr static int alpha = 8;
170 constexpr static int beta = 9;
172 constexpr static int prev_rho = 10;
174 constexpr static int rho = 11;
176 constexpr static int one = 12;
178 constexpr static int minus_one = 13;
181 constexpr static int stop = 0;
183 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
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:136
BICG or the Biconjugate gradient method is a Krylov subspace solver.
Definition bicg.hpp:83
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate 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 bicg.hpp:100
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
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