Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
ic.hpp
1/*******************************<GINKGO LICENSE>******************************
2Copyright (c) 2017-2023, the Ginkgo authors
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions
7are met:
8
91. Redistributions of source code must retain the above copyright
10notice, this list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright
13notice, this list of conditions and the following disclaimer in the
14documentation and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17contributors may be used to endorse or promote products derived from
18this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31******************************<GINKGO LICENSE>*******************************/
32
33#ifndef GKO_PUBLIC_CORE_FACTORIZATION_IC_HPP_
34#define GKO_PUBLIC_CORE_FACTORIZATION_IC_HPP_
35
36
37#include <memory>
38
39
40#include <ginkgo/core/base/composition.hpp>
41#include <ginkgo/core/base/lin_op.hpp>
42#include <ginkgo/core/base/types.hpp>
43#include <ginkgo/core/matrix/csr.hpp>
44
45
46namespace gko {
52namespace factorization {
53
54
69template <typename ValueType = gko::default_precision,
70 typename IndexType = gko::int32>
71class Ic : public Composition<ValueType> {
72public:
73 using value_type = ValueType;
74 using index_type = IndexType;
76
77 std::shared_ptr<const matrix_type> get_l_factor() const
78 {
79 // Can be `static_cast` since the type is guaranteed in this class
80 return std::static_pointer_cast<const matrix_type>(
81 this->get_operators()[0]);
82 }
83
84 std::shared_ptr<const matrix_type> get_lt_factor() const
85 {
86 if (this->get_operators().size() == 2) {
87 // Can be `static_cast` since the type is guaranteed in this class
88 return std::static_pointer_cast<const matrix_type>(
89 this->get_operators()[1]);
90 } else {
91 return std::static_pointer_cast<const matrix_type>(
92 share(get_l_factor()->conj_transpose()));
93 }
94 }
95
96 // Remove the possibility of calling `create`, which was enabled by
97 // `Composition`
98 template <typename... Args>
99 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
100 delete;
101
103 {
108 std::shared_ptr<typename matrix_type::strategy_type>
109 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
110
121 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
122
128 bool GKO_FACTORY_PARAMETER_SCALAR(both_factors, true);
129 };
132
133protected:
134 Ic(const Factory* factory, std::shared_ptr<const gko::LinOp> system_matrix)
135 : Composition<ValueType>{factory->get_executor()},
136 parameters_{factory->get_parameters()}
137 {
138 if (parameters_.l_strategy == nullptr) {
139 parameters_.l_strategy =
140 std::make_shared<typename matrix_type::classical>();
141 }
142 generate(system_matrix, parameters_.skip_sorting,
143 parameters_.both_factors)
144 ->move_to(this);
145 }
146
147 std::unique_ptr<Composition<ValueType>> generate(
148 const std::shared_ptr<const LinOp>& system_matrix, bool skip_sorting,
149 bool both_factors) const;
150};
151
152
153} // namespace factorization
154} // namespace gko
155
156
157#endif // GKO_PUBLIC_CORE_FACTORIZATION_IC_HPP_
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:69
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Returns a list of operators of the composition.
Definition composition.hpp:82
Definition ic.hpp:130
Represents an incomplete Cholesky factorization (IC(0)) of a sparse matrix.
Definition ic.hpp:71
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:146
#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:308
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:473
#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:422
#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:1046
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:137
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:205
detail::shared_type< OwningPointer > share(OwningPointer &&p)
Marks the object pointed to by p as shared.
Definition utils_helper.hpp:254
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition ic.hpp:109
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition ic.hpp:121
bool both_factors
true will generate both L and L^H, false will only generate the L factor, resulting in a Composition ...
Definition ic.hpp:128