Ginkgo Generated from branch based on main. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
triangular.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
7
8
9#include <memory>
10#include <utility>
11
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>
26
27
28namespace gko {
29namespace solver {
30
31
32struct SolveStruct;
33
34
40enum class trisolve_algorithm { sparselib, syncfree };
41
42
43template <typename ValueType, typename IndexType>
44class UpperTrs;
45
46
64template <typename ValueType = default_precision, typename IndexType = int32>
65class LowerTrs : public EnableLinOp<LowerTrs<ValueType, IndexType>>,
66 public EnableSolverBase<LowerTrs<ValueType, IndexType>,
67 matrix::Csr<ValueType, IndexType>>,
68 public Transposable {
69 friend class EnableLinOp<LowerTrs>;
71 friend class UpperTrs<ValueType, IndexType>;
72
73public:
74 using value_type = ValueType;
75 using index_type = IndexType;
77
78 std::unique_ptr<LinOp> transpose() const override;
79
80 std::unique_ptr<LinOp> conj_transpose() const override;
81
83 {
91
96 bool GKO_FACTORY_PARAMETER_SCALAR(unit_diagonal, false);
97
105 algorithm, trisolve_algorithm::sparselib);
106 };
109
124 const config::pnode& config, const config::registry& context,
125 const config::type_descriptor& td_for_child =
126 config::make_type_descriptor<ValueType, IndexType>());
127
134
142
149
156
157protected:
159
160 void apply_impl(const LinOp* b, LinOp* x) const override;
161
162 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
163 LinOp* x) const override;
164
169 void generate();
170
171 explicit LowerTrs(std::shared_ptr<const Executor> exec)
172 : EnableLinOp<LowerTrs>(std::move(exec))
173 {}
174
175 explicit LowerTrs(const Factory* factory,
176 std::shared_ptr<const LinOp> system_matrix)
177 : EnableLinOp<LowerTrs>(factory->get_executor(),
178 gko::transpose(system_matrix->get_size())),
179 EnableSolverBase<LowerTrs<ValueType, IndexType>, CsrMatrix>{
180 copy_and_convert_to<CsrMatrix>(factory->get_executor(),
181 system_matrix)},
182 parameters_{factory->get_parameters()}
183 {
184 this->generate();
185 }
186
187private:
188 std::shared_ptr<solver::SolveStruct> solve_struct_;
189};
190
191
192template <typename ValueType, typename IndexType>
193struct workspace_traits<LowerTrs<ValueType, IndexType>> {
195 // number of vectors used by this workspace
196 static int num_vectors(const Solver&);
197 // number of arrays used by this workspace
198 static int num_arrays(const Solver&);
199 // array containing the num_vectors names for the workspace vectors
200 static std::vector<std::string> op_names(const Solver&);
201 // array containing the num_arrays names for the workspace vectors
202 static std::vector<std::string> array_names(const Solver&);
203 // array containing all varying scalar vectors (independent of problem size)
204 static std::vector<int> scalars(const Solver&);
205 // array containing all varying vectors (dependent on problem size)
206 static std::vector<int> vectors(const Solver&);
207
208 // transposed input vector
209 constexpr static int transposed_b = 0;
210 // transposed output vector
211 constexpr static int transposed_x = 1;
212};
213
214
232template <typename ValueType = default_precision, typename IndexType = int32>
233class UpperTrs : public EnableLinOp<UpperTrs<ValueType, IndexType>>,
234 public EnableSolverBase<UpperTrs<ValueType, IndexType>,
235 matrix::Csr<ValueType, IndexType>>,
236 public Transposable {
237 friend class EnableLinOp<UpperTrs>;
239 friend class LowerTrs<ValueType, IndexType>;
240
241public:
242 using value_type = ValueType;
243 using index_type = IndexType;
245
246 std::unique_ptr<LinOp> transpose() const override;
247
248 std::unique_ptr<LinOp> conj_transpose() const override;
249
251 {
259
264 bool GKO_FACTORY_PARAMETER_SCALAR(unit_diagonal, false);
265
273 algorithm, trisolve_algorithm::sparselib);
274 };
277
292 const config::pnode& config, const config::registry& context,
293 const config::type_descriptor& td_for_child =
294 config::make_type_descriptor<ValueType, IndexType>());
295
302
310
317
324
325protected:
327
328 void apply_impl(const LinOp* b, LinOp* x) const override;
329
330 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
331 LinOp* x) const override;
332
337 void generate();
338
339 explicit UpperTrs(std::shared_ptr<const Executor> exec)
340 : EnableLinOp<UpperTrs>(std::move(exec))
341 {}
342
343 explicit UpperTrs(const Factory* factory,
344 std::shared_ptr<const LinOp> system_matrix)
345 : EnableLinOp<UpperTrs>(factory->get_executor(),
346 gko::transpose(system_matrix->get_size())),
347 EnableSolverBase<UpperTrs<ValueType, IndexType>, CsrMatrix>{
348 copy_and_convert_to<CsrMatrix>(factory->get_executor(),
349 system_matrix)},
350 parameters_{factory->get_parameters()}
351 {
352 this->generate();
353 }
354
355private:
356 std::shared_ptr<solver::SolveStruct> solve_struct_;
357};
358
359
360template <typename ValueType, typename IndexType>
361struct workspace_traits<UpperTrs<ValueType, IndexType>> {
363 // number of vectors used by this workspace
364 static int num_vectors(const Solver&);
365 // number of arrays used by this workspace
366 static int num_arrays(const Solver&);
367 // array containing the num_vectors names for the workspace vectors
368 static std::vector<std::string> op_names(const Solver&);
369 // array containing the num_arrays names for the workspace vectors
370 static std::vector<std::string> array_names(const Solver&);
371 // array containing all varying scalar vectors (independent of problem size)
372 static std::vector<int> scalars(const Solver&);
373 // array containing all varying vectors (dependent on problem size)
374 static std::vector<int> vectors(const Solver&);
375
376 // transposed input vector
377 constexpr static int transposed_b = 0;
378 // transposed output vector
379 constexpr static int transposed_x = 1;
380};
381
382
383} // namespace solver
384} // namespace gko
385
386
387#endif // GKO_PUBLIC_CORE_SOLVER_TRIANGULAR_HPP_
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:662
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:234
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 sparsity_csr.hpp:21
A LinOp deriving from this CRTP class stores a system matrix.
Definition solver_base.hpp:541
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
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:89
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:562
STL namespace.
Definition triangular.hpp:83
Definition triangular.hpp:251
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:238