Ginkgo: ginkgo/core/factorization/cholesky.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
cholesky.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#include <memory>
6
7#include <ginkgo/core/base/composition.hpp>
8#include <ginkgo/core/base/lin_op.hpp>
9#include <ginkgo/core/base/polymorphic_object.hpp>
10#include <ginkgo/core/config/config.hpp>
11#include <ginkgo/core/config/registry.hpp>
12#include <ginkgo/core/factorization/factorization.hpp>
13#include <ginkgo/core/matrix/csr.hpp>
14#include <ginkgo/core/matrix/sparsity_csr.hpp>
15
16
17namespace gko {
18namespace experimental {
19namespace factorization {
20
21
34template <typename ValueType, typename IndexType>
35 class Cholesky
36 : public EnablePolymorphicObject<Cholesky<ValueType, IndexType>,
37 LinOpFactory>,
38 public EnablePolymorphicAssignment<Cholesky<ValueType, IndexType>> {
39 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
40
41public:
42 struct parameters_type;
43 friend class EnablePolymorphicObject<Cholesky, LinOpFactory>;
44 friend class enable_parameters_type<parameters_type, Cholesky>;
45
46 using value_type = ValueType;
47 using index_type = IndexType;
48 using matrix_type = matrix::Csr<value_type, index_type>;
49 using sparsity_pattern_type = matrix::SparsityCsr<value_type, index_type>;
50 using factorization_type = Factorization<value_type, index_type>;
51
52 struct parameters_type
53 : public enable_parameters_type<parameters_type, Cholesky> {
60 std::shared_ptr<const sparsity_pattern_type>
61 GKO_FACTORY_PARAMETER_SCALAR(symbolic_factorization, nullptr);
62
73 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
74 };
75
81 const parameters_type& get_parameters() { return parameters_; }
82
86 const parameters_type& get_parameters() const { return parameters_; }
87
95 std::unique_ptr<factorization_type> generate(
96 std::shared_ptr<const LinOp> system_matrix) const;
97
99 static parameters_type build() { return {}; }
100
114 static parameters_type parse(
115 const config::pnode& config, const config::registry& context,
116 const config::type_descriptor& td_for_child =
117 config::make_type_descriptor<ValueType, IndexType>());
118
119protected:
120 explicit Cholesky(std::shared_ptr<const Executor> exec,
121 const parameters_type& params = {});
122
123 std::unique_ptr<LinOp> generate_impl(
124 std::shared_ptr<const LinOp> system_matrix) const override;
125
126private:
127 parameters_type parameters_;
128};
129
130
131} // namespace factorization
132} // namespace experimental
133} // namespace gko
gko::EnablePolymorphicAssignment
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:743
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::LinOpFactory
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:385
gko::config::pnode
pnode describes a tree of properties.
Definition property_tree.hpp:28
gko::config::registry
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
gko::config::type_descriptor
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
gko::enable_parameters_type
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:211
gko::experimental::factorization::Cholesky::build
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition cholesky.hpp:99
gko::experimental::factorization::Cholesky::get_parameters
const parameters_type & get_parameters() const
Returns the parameters used to construct the factory.
Definition cholesky.hpp:86
gko::experimental::factorization::Cholesky::get_parameters
const parameters_type & get_parameters()
Returns the parameters used to construct the factory.
Definition cholesky.hpp:81
gko::experimental::factorization::Cholesky::generate
std::unique_ptr< factorization_type > generate(std::shared_ptr< const LinOp > system_matrix) const
Creates a new product from the given components.
gko::experimental::factorization::Cholesky::parse
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.
gko::experimental::factorization::Factorization
Represents a generic factorization consisting of two triangular factors (upper and lower) and an opti...
Definition factorization.hpp:76
gko::matrix::Csr
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
gko::matrix::SparsityCsr
SparsityCsr is a matrix format which stores only the sparsity pattern of a sparse matrix by compressi...
Definition sparsity_csr.hpp:56
GKO_FACTORY_PARAMETER_SCALAR
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::experimental::factorization::Cholesky::parameters_type
Definition cholesky.hpp:53
gko::experimental::factorization::Cholesky::parameters_type::symbolic_factorization
std::shared_ptr< const sparsity_pattern_type > symbolic_factorization
The combined sparsity pattern L + L^H of the factors L and L^H.
Definition cholesky.hpp:61
gko::experimental::factorization::Cholesky::parameters_type::skip_sorting
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition cholesky.hpp:73