33#ifndef GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
41#include <ginkgo/core/base/abstract_factory.hpp>
42#include <ginkgo/core/base/array.hpp>
43#include <ginkgo/core/base/dim.hpp>
44#include <ginkgo/core/base/exception_helpers.hpp>
45#include <ginkgo/core/base/lin_op.hpp>
46#include <ginkgo/core/base/polymorphic_object.hpp>
47#include <ginkgo/core/base/types.hpp>
48#include <ginkgo/core/base/utils.hpp>
49#include <ginkgo/core/log/logger.hpp>
50#include <ginkgo/core/matrix/csr.hpp>
51#include <ginkgo/core/matrix/identity.hpp>
52#include <ginkgo/core/solver/solver_base.hpp>
70template <
typename ValueType,
typename IndexType>
91template <
typename ValueType = default_precision,
typename IndexType =
int32>
94 matrix::Csr<ValueType, IndexType>>,
98 friend class UpperTrs<ValueType, IndexType>;
101 using value_type = ValueType;
102 using index_type = IndexType;
132 algorithm, trisolve_algorithm::sparselib);
169 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
172 LinOp* x)
const override;
180 explicit LowerTrs(std::shared_ptr<const Executor> exec)
184 explicit LowerTrs(
const Factory* factory,
185 std::shared_ptr<const LinOp> system_matrix)
191 parameters_{factory->get_parameters()}
197 std::shared_ptr<solver::SolveStruct> solve_struct_;
201template <
typename ValueType,
typename IndexType>
205 static int num_vectors(
const Solver&);
207 static int num_arrays(
const Solver&);
209 static std::vector<std::string> op_names(
const Solver&);
211 static std::vector<std::string> array_names(
const Solver&);
213 static std::vector<int> scalars(
const Solver&);
215 static std::vector<int> vectors(
const Solver&);
218 constexpr static int transposed_b = 0;
220 constexpr static int transposed_x = 1;
241template <
typename ValueType = default_precision,
typename IndexType =
int32>
244 matrix::Csr<ValueType, IndexType>>,
248 friend class LowerTrs<ValueType, IndexType>;
251 using value_type = ValueType;
252 using index_type = IndexType;
282 algorithm, trisolve_algorithm::sparselib);
319 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
322 LinOp* x)
const override;
330 explicit UpperTrs(std::shared_ptr<const Executor> exec)
334 explicit UpperTrs(
const Factory* factory,
335 std::shared_ptr<const LinOp> system_matrix)
341 parameters_{factory->get_parameters()}
347 std::shared_ptr<solver::SolveStruct> solve_struct_;
351template <
typename ValueType,
typename IndexType>
355 static int num_vectors(
const Solver&);
357 static int num_arrays(
const Solver&);
359 static std::vector<std::string> op_names(
const Solver&);
361 static std::vector<std::string> array_names(
const Solver&);
363 static std::vector<int> scalars(
const Solver&);
365 static std::vector<int> vectors(
const Solver&);
368 constexpr static int transposed_b = 0;
370 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: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
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:146
A LinOp deriving from this CRTP class stores a system matrix.
Definition solver_base.hpp:570
Definition triangular.hpp:134
LowerTrs is the triangular solver which solves the system L x = b, when L is a lower triangular matri...
Definition triangular.hpp:95
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:284
UpperTrs is the triangular solver which solves the system U x = b, when U is an upper triangular matr...
Definition triangular.hpp:245
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:308
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:473
#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
trisolve_algorithm
A helper for algorithm selection in the triangular solvers.
Definition triangular.hpp:67
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:267