5#ifndef GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
12#include <ginkgo/core/base/abstract_factory.hpp>
13#include <ginkgo/core/base/array.hpp>
14#include <ginkgo/core/base/dim.hpp>
15#include <ginkgo/core/base/exception_helpers.hpp>
16#include <ginkgo/core/base/lin_op.hpp>
17#include <ginkgo/core/base/polymorphic_object.hpp>
18#include <ginkgo/core/base/types.hpp>
19#include <ginkgo/core/base/utils.hpp>
20#include <ginkgo/core/config/config.hpp>
21#include <ginkgo/core/config/registry.hpp>
22#include <ginkgo/core/log/logger.hpp>
23#include <ginkgo/core/matrix/csr.hpp>
24#include <ginkgo/core/matrix/identity.hpp>
25#include <ginkgo/core/solver/solver_base.hpp>
43template <
typename ValueType,
typename IndexType>
64template <
typename ValueType = default_precision,
typename IndexType =
int32>
66 public EnableSolverBase<LowerTrs<ValueType, IndexType>,
67 matrix::Csr<ValueType, IndexType>>,
71 friend class UpperTrs<ValueType, IndexType>;
74 using value_type = ValueType;
75 using index_type = IndexType;
126 config::make_type_descriptor<ValueType, IndexType>());
160 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
163 LinOp* x)
const override;
171 explicit LowerTrs(std::shared_ptr<const Executor> exec)
175 explicit LowerTrs(
const Factory* factory,
176 std::shared_ptr<const LinOp> system_matrix)
182 parameters_{factory->get_parameters()}
188 std::shared_ptr<solver::SolveStruct> solve_struct_;
192template <
typename ValueType,
typename IndexType>
196 static int num_vectors(
const Solver&);
198 static int num_arrays(
const Solver&);
200 static std::vector<std::string> op_names(
const Solver&);
202 static std::vector<std::string> array_names(
const Solver&);
204 static std::vector<int> scalars(
const Solver&);
206 static std::vector<int> vectors(
const Solver&);
209 constexpr static int transposed_b = 0;
211 constexpr static int transposed_x = 1;
232template <
typename ValueType = default_precision,
typename IndexType =
int32>
234 public EnableSolverBase<UpperTrs<ValueType, IndexType>,
235 matrix::Csr<ValueType, IndexType>>,
239 friend class LowerTrs<ValueType, IndexType>;
242 using value_type = ValueType;
243 using index_type = IndexType;
294 config::make_type_descriptor<ValueType, IndexType>());
328 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
331 LinOp* x)
const override;
339 explicit UpperTrs(std::shared_ptr<const Executor> exec)
343 explicit UpperTrs(
const Factory* factory,
344 std::shared_ptr<const LinOp> system_matrix)
350 parameters_{factory->get_parameters()}
356 std::shared_ptr<solver::SolveStruct> solve_struct_;
360template <
typename ValueType,
typename IndexType>
364 static int num_vectors(
const Solver&);
366 static int num_arrays(
const Solver&);
368 static std::vector<std::string> op_names(
const Solver&);
370 static std::vector<std::string> array_names(
const Solver&);
372 static std::vector<int> scalars(
const Solver&);
374 static std::vector<int> vectors(
const Solver&);
377 constexpr static int transposed_b = 0;
379 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:879
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
Definition lin_op.hpp:117
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:210
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:243
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
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:167
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
A LinOp deriving from this CRTP class stores a system matrix.
Definition solver_base.hpp:556
Definition triangular.hpp:107
LowerTrs is the triangular solver which solves the system L x = b, when L is a lower triangular matri...
Definition triangular.hpp:68
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:275
UpperTrs is the triangular solver which solves the system U x = b, when U is an upper triangular matr...
Definition triangular.hpp:236
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:1017
The ginkgo Solve namespace.
Definition bicg.hpp:28
trisolve_algorithm
A helper for algorithm selection in the triangular solvers.
Definition triangular.hpp:40
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
batch_dim< 2, DimensionType > transpose(const batch_dim< 2, DimensionType > &input)
Returns a batch_dim object with its dimensions swapped for batched operators.
Definition batch_dim.hpp:119
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:571
gko::size_type num_rhs
Number of right hand sides.
Definition triangular.hpp:90
trisolve_algorithm algorithm
Select the implementation which is supposed to be used for the triangular solver.
Definition triangular.hpp:105
bool unit_diagonal
Should the solver use the values on the diagonal of the system matrix (false) or should it assume the...
Definition triangular.hpp:96
gko::size_type num_rhs
Number of right hand sides.
Definition triangular.hpp:258
bool unit_diagonal
Should the solver use the values on the diagonal of the system matrix (false) or should it assume the...
Definition triangular.hpp:264
trisolve_algorithm algorithm
Select the implementation which is supposed to be used for the triangular solver.
Definition triangular.hpp:273
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:238