5#ifndef GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
13#include <ginkgo/core/base/abstract_factory.hpp>
14#include <ginkgo/core/base/array.hpp>
15#include <ginkgo/core/base/dim.hpp>
16#include <ginkgo/core/base/exception_helpers.hpp>
17#include <ginkgo/core/base/lin_op.hpp>
18#include <ginkgo/core/base/polymorphic_object.hpp>
19#include <ginkgo/core/base/types.hpp>
20#include <ginkgo/core/base/utils.hpp>
21#include <ginkgo/core/log/logger.hpp>
22#include <ginkgo/core/matrix/csr.hpp>
23#include <ginkgo/core/matrix/identity.hpp>
24#include <ginkgo/core/solver/solver_base.hpp>
42template <
typename ValueType,
typename IndexType>
63template <
typename ValueType = default_precision,
typename IndexType =
int32>
66 matrix::Csr<ValueType, IndexType>>,
70 friend class UpperTrs<ValueType, IndexType>;
73 using value_type = ValueType;
74 using index_type = IndexType;
104 algorithm, trisolve_algorithm::sparselib);
141 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
144 LinOp* x)
const override;
152 explicit LowerTrs(std::shared_ptr<const Executor> exec)
156 explicit LowerTrs(
const Factory* factory,
157 std::shared_ptr<const LinOp> system_matrix)
163 parameters_{factory->get_parameters()}
169 std::shared_ptr<solver::SolveStruct> solve_struct_;
173template <
typename ValueType,
typename IndexType>
177 static int num_vectors(
const Solver&);
179 static int num_arrays(
const Solver&);
181 static std::vector<std::string> op_names(
const Solver&);
183 static std::vector<std::string> array_names(
const Solver&);
185 static std::vector<int> scalars(
const Solver&);
187 static std::vector<int> vectors(
const Solver&);
190 constexpr static int transposed_b = 0;
192 constexpr static int transposed_x = 1;
213template <
typename ValueType = default_precision,
typename IndexType =
int32>
216 matrix::Csr<ValueType, IndexType>>,
220 friend class LowerTrs<ValueType, IndexType>;
223 using value_type = ValueType;
224 using index_type = IndexType;
254 algorithm, trisolve_algorithm::sparselib);
291 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
294 LinOp* x)
const override;
302 explicit UpperTrs(std::shared_ptr<const Executor> exec)
306 explicit UpperTrs(
const Factory* factory,
307 std::shared_ptr<const LinOp> system_matrix)
313 parameters_{factory->get_parameters()}
319 std::shared_ptr<solver::SolveStruct> solve_struct_;
323template <
typename ValueType,
typename IndexType>
327 static int num_vectors(
const Solver&);
329 static int num_arrays(
const Solver&);
331 static std::vector<std::string> op_names(
const Solver&);
333 static std::vector<std::string> array_names(
const Solver&);
335 static std::vector<int> scalars(
const Solver&);
337 static std::vector<int> vectors(
const Solver&);
340 constexpr static int transposed_b = 0;
342 constexpr static int transposed_x = 1;
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:880
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
Definition lin_op.hpp:118
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:434
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:117
A LinOp deriving from this CRTP class stores a system matrix.
Definition solver_base.hpp:542
Definition triangular.hpp:106
LowerTrs is the triangular solver which solves the system L x = b, when L is a lower triangular matri...
Definition triangular.hpp:67
LowerTrs & operator=(LowerTrs &&)
Move-constructs a triangular solver.
LowerTrs(const LowerTrs &)
Copy-assigns a triangular solver.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
LowerTrs & operator=(const LowerTrs &)
Copy-constructs a triangular solver.
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
LowerTrs(LowerTrs &&)
Move-assigns a triangular solver.
Definition triangular.hpp:256
UpperTrs is the triangular solver which solves the system U x = b, when U is an upper triangular matr...
Definition triangular.hpp:217
UpperTrs(UpperTrs &&)
Move-assigns a triangular solver.
UpperTrs(const UpperTrs &)
Copy-assigns a triangular solver.
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
UpperTrs & operator=(UpperTrs &&)
Move-constructs a triangular solver.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
UpperTrs & operator=(const UpperTrs &)
Copy-constructs a triangular solver.
#define GKO_CREATE_FACTORY_PARAMETERS(_parameters_name, _factory_name)
This Macro will generate a new type containing the parameters for the factory _factory_name.
Definition abstract_factory.hpp:280
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
#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
#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:1018
trisolve_algorithm
A helper for algorithm selection in the triangular solvers.
Definition triangular.hpp:39
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:92
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:239