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
cholesky.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#include <memory>
6
7
8#include <ginkgo/core/base/composition.hpp>
9#include <ginkgo/core/base/lin_op.hpp>
10#include <ginkgo/core/base/polymorphic_object.hpp>
11#include <ginkgo/core/config/config.hpp>
12#include <ginkgo/core/config/registry.hpp>
13#include <ginkgo/core/factorization/factorization.hpp>
14#include <ginkgo/core/matrix/csr.hpp>
15#include <ginkgo/core/matrix/sparsity_csr.hpp>
16
17
18namespace gko {
19namespace experimental {
20namespace factorization {
21
22
33template <typename ValueType, typename IndexType>
35 : public EnablePolymorphicObject<Cholesky<ValueType, IndexType>,
36 LinOpFactory>,
37 public EnablePolymorphicAssignment<Cholesky<ValueType, IndexType>> {
38public:
39 struct parameters_type;
42
43 using value_type = ValueType;
44 using index_type = IndexType;
48
50 : public enable_parameters_type<parameters_type, Cholesky> {
57 std::shared_ptr<const sparsity_pattern_type>
59
71 };
72
78 const parameters_type& get_parameters() { return parameters_; }
79
83 const parameters_type& get_parameters() const { return parameters_; }
84
92 std::unique_ptr<factorization_type> generate(
93 std::shared_ptr<const LinOp> system_matrix) const;
94
96 static parameters_type build() { return {}; }
97
112 const config::pnode& config, const config::registry& context,
113 const config::type_descriptor& td_for_child =
114 config::make_type_descriptor<ValueType, IndexType>());
115
116protected:
117 explicit Cholesky(std::shared_ptr<const Executor> exec,
118 const parameters_type& params = {});
119
120 std::unique_ptr<LinOp> generate_impl(
121 std::shared_ptr<const LinOp> system_matrix) const override;
122
123private:
124 parameters_type parameters_;
125};
126
127
128} // namespace factorization
129} // namespace experimental
130} // namespace gko
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:724
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:386
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
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:211
Computes a Cholesky factorization of a symmetric, positive-definite sparse matrix.
Definition cholesky.hpp:37
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition cholesky.hpp:96
const parameters_type & get_parameters() const
Returns the parameters used to construct the factory.
Definition cholesky.hpp:83
const parameters_type & get_parameters()
Returns the parameters used to construct the factory.
Definition cholesky.hpp:78
std::unique_ptr< factorization_type > generate(std::shared_ptr< const LinOp > system_matrix) const
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.
Represents a generic factorization consisting of two triangular factors (upper and lower) and an opti...
Definition factorization.hpp:76
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition sparsity_csr.hpp:22
SparsityCsr is a matrix format which stores only the sparsity pattern of a sparse matrix by compressi...
Definition sparsity_csr.hpp:57
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
The Ginkgo namespace.
Definition abstract_factory.hpp:20
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:58
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition cholesky.hpp:70