Ginkgo Generated from branch based on master. Ginkgo version 1.8.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
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>
27
28
29namespace gko {
30namespace solver {
31
32
33struct SolveStruct;
34
35
41enum class trisolve_algorithm { sparselib, syncfree };
42
43
44template <typename ValueType, typename IndexType>
45class UpperTrs;
46
47
65template <typename ValueType = default_precision, typename IndexType = int32>
66class LowerTrs : public EnableLinOp<LowerTrs<ValueType, IndexType>>,
67 public EnableSolverBase<LowerTrs<ValueType, IndexType>,
68 matrix::Csr<ValueType, IndexType>>,
69 public Transposable {
70 friend class EnableLinOp<LowerTrs>;
72 friend class UpperTrs<ValueType, IndexType>;
73
74public:
75 using value_type = ValueType;
76 using index_type = IndexType;
78
79 std::unique_ptr<LinOp> transpose() const override;
80
81 std::unique_ptr<LinOp> conj_transpose() const override;
82
84 {
92
97 bool GKO_FACTORY_PARAMETER_SCALAR(unit_diagonal, false);
98
106 algorithm, trisolve_algorithm::sparselib);
107 };
110
125 const config::pnode& config, const config::registry& context,
126 const config::type_descriptor& td_for_child =
127 config::make_type_descriptor<ValueType, IndexType>());
128
135
143
150
157
158protected:
160
161 void apply_impl(const LinOp* b, LinOp* x) const override;
162
163 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
164 LinOp* x) const override;
165
170 void generate();
171
172 explicit LowerTrs(std::shared_ptr<const Executor> exec)
173 : EnableLinOp<LowerTrs>(std::move(exec))
174 {}
175
176 explicit LowerTrs(const Factory* factory,
177 std::shared_ptr<const LinOp> system_matrix)
178 : EnableLinOp<LowerTrs>(factory->get_executor(),
179 gko::transpose(system_matrix->get_size())),
180 EnableSolverBase<LowerTrs<ValueType, IndexType>, CsrMatrix>{
181 copy_and_convert_to<CsrMatrix>(factory->get_executor(),
182 system_matrix)},
183 parameters_{factory->get_parameters()}
184 {
185 this->generate();
186 }
187
188private:
189 std::shared_ptr<solver::SolveStruct> solve_struct_;
190};
191
192
193template <typename ValueType, typename IndexType>
194struct workspace_traits<LowerTrs<ValueType, IndexType>> {
196 // number of vectors used by this workspace
197 static int num_vectors(const Solver&);
198 // number of arrays used by this workspace
199 static int num_arrays(const Solver&);
200 // array containing the num_vectors names for the workspace vectors
201 static std::vector<std::string> op_names(const Solver&);
202 // array containing the num_arrays names for the workspace vectors
203 static std::vector<std::string> array_names(const Solver&);
204 // array containing all varying scalar vectors (independent of problem size)
205 static std::vector<int> scalars(const Solver&);
206 // array containing all varying vectors (dependent on problem size)
207 static std::vector<int> vectors(const Solver&);
208
209 // transposed input vector
210 constexpr static int transposed_b = 0;
211 // transposed output vector
212 constexpr static int transposed_x = 1;
213};
214
215
233template <typename ValueType = default_precision, typename IndexType = int32>
234class UpperTrs : public EnableLinOp<UpperTrs<ValueType, IndexType>>,
235 public EnableSolverBase<UpperTrs<ValueType, IndexType>,
236 matrix::Csr<ValueType, IndexType>>,
237 public Transposable {
238 friend class EnableLinOp<UpperTrs>;
240 friend class LowerTrs<ValueType, IndexType>;
241
242public:
243 using value_type = ValueType;
244 using index_type = IndexType;
246
247 std::unique_ptr<LinOp> transpose() const override;
248
249 std::unique_ptr<LinOp> conj_transpose() const override;
250
252 {
260
265 bool GKO_FACTORY_PARAMETER_SCALAR(unit_diagonal, false);
266
274 algorithm, trisolve_algorithm::sparselib);
275 };
278
293 const config::pnode& config, const config::registry& context,
294 const config::type_descriptor& td_for_child =
295 config::make_type_descriptor<ValueType, IndexType>());
296
303
311
318
325
326protected:
328
329 void apply_impl(const LinOp* b, LinOp* x) const override;
330
331 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
332 LinOp* x) const override;
333
338 void generate();
339
340 explicit UpperTrs(std::shared_ptr<const Executor> exec)
341 : EnableLinOp<UpperTrs>(std::move(exec))
342 {}
343
344 explicit UpperTrs(const Factory* factory,
345 std::shared_ptr<const LinOp> system_matrix)
346 : EnableLinOp<UpperTrs>(factory->get_executor(),
347 gko::transpose(system_matrix->get_size())),
348 EnableSolverBase<UpperTrs<ValueType, IndexType>, CsrMatrix>{
349 copy_and_convert_to<CsrMatrix>(factory->get_executor(),
350 system_matrix)},
351 parameters_{factory->get_parameters()}
352 {
353 this->generate();
354 }
355
356private:
357 std::shared_ptr<solver::SolveStruct> solve_struct_;
358};
359
360
361template <typename ValueType, typename IndexType>
362struct workspace_traits<UpperTrs<ValueType, IndexType>> {
364 // number of vectors used by this workspace
365 static int num_vectors(const Solver&);
366 // number of arrays used by this workspace
367 static int num_arrays(const Solver&);
368 // array containing the num_vectors names for the workspace vectors
369 static std::vector<std::string> op_names(const Solver&);
370 // array containing the num_arrays names for the workspace vectors
371 static std::vector<std::string> array_names(const Solver&);
372 // array containing all varying scalar vectors (independent of problem size)
373 static std::vector<int> scalars(const Solver&);
374 // array containing all varying vectors (dependent on problem size)
375 static std::vector<int> vectors(const Solver&);
376
377 // transposed input vector
378 constexpr static int transposed_b = 0;
379 // transposed output vector
380 constexpr static int transposed_x = 1;
381};
382
383
384} // namespace solver
385} // namespace gko
386
387
388#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: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