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/config/config.hpp>
22#include <ginkgo/core/config/registry.hpp>
23#include <ginkgo/core/log/logger.hpp>
24#include <ginkgo/core/matrix/csr.hpp>
25#include <ginkgo/core/matrix/identity.hpp>
26#include <ginkgo/core/solver/solver_base.hpp>
44template <
typename ValueType,
typename IndexType>
65template <
typename ValueType = default_precision,
typename IndexType =
int32>
68 matrix::Csr<ValueType, IndexType>>,
72 friend class UpperTrs<ValueType, IndexType>;
75 using value_type = ValueType;
76 using index_type = IndexType;
106 algorithm, trisolve_algorithm::sparselib);
127 config::make_type_descriptor<ValueType, IndexType>());
161 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
164 LinOp* x)
const override;
172 explicit LowerTrs(std::shared_ptr<const Executor> exec)
176 explicit LowerTrs(
const Factory* factory,
177 std::shared_ptr<const LinOp> system_matrix)
183 parameters_{factory->get_parameters()}
189 std::shared_ptr<solver::SolveStruct> solve_struct_;
193template <
typename ValueType,
typename IndexType>
197 static int num_vectors(
const Solver&);
199 static int num_arrays(
const Solver&);
201 static std::vector<std::string> op_names(
const Solver&);
203 static std::vector<std::string> array_names(
const Solver&);
205 static std::vector<int> scalars(
const Solver&);
207 static std::vector<int> vectors(
const Solver&);
210 constexpr static int transposed_b = 0;
212 constexpr static int transposed_x = 1;
233template <
typename ValueType = default_precision,
typename IndexType =
int32>
236 matrix::Csr<ValueType, IndexType>>,
240 friend class LowerTrs<ValueType, IndexType>;
243 using value_type = ValueType;
244 using index_type = IndexType;
274 algorithm, trisolve_algorithm::sparselib);
295 config::make_type_descriptor<ValueType, IndexType>());
329 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
332 LinOp* x)
const override;
340 explicit UpperTrs(std::shared_ptr<const Executor> exec)
344 explicit UpperTrs(
const Factory* factory,
345 std::shared_ptr<const LinOp> system_matrix)
351 parameters_{factory->get_parameters()}
357 std::shared_ptr<solver::SolveStruct> solve_struct_;
361template <
typename ValueType,
typename IndexType>
365 static int num_vectors(
const Solver&);
367 static int num_arrays(
const Solver&);
369 static std::vector<std::string> op_names(
const Solver&);
371 static std::vector<std::string> array_names(
const Solver&);
373 static std::vector<int> scalars(
const Solver&);
375 static std::vector<int> vectors(
const Solver&);
378 constexpr static int transposed_b = 0;
380 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
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:211
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
pnode describes a tree of properties.
Definition property_tree.hpp:28
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:168
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:37
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition sparsity_csr.hpp:22
A LinOp deriving from this CRTP class stores a system matrix.
Definition solver_base.hpp:542
Definition triangular.hpp:108
LowerTrs is the triangular solver which solves the system L x = b, when L is a lower triangular matri...
Definition triangular.hpp:69
LowerTrs & operator=(LowerTrs &&)
Move-constructs a triangular solver.
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >())
Create the parameters from the property_tree.
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:276
UpperTrs is the triangular solver which solves the system U x = b, when U is an upper triangular matr...
Definition triangular.hpp:237
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.
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >())
Create the parameters from the property_tree.
#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:41
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:86
std::unique_ptr< R, std::function< void(R *)> > copy_and_convert_to(std::shared_ptr< const Executor > exec, T *obj)
Converts the object to R and places it on Executor exec.
Definition polymorphic_object.hpp:563
Definition triangular.hpp:84
Definition triangular.hpp:252
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:239