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
par_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_PAR_IC_HPP_
34#define GKO_PUBLIC_CORE_FACTORIZATION_PAR_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
95template <typename ValueType = default_precision, typename IndexType = int32>
96class ParIc : public Composition<ValueType> {
97public:
98 using value_type = ValueType;
99 using index_type = IndexType;
101
102 std::shared_ptr<const matrix_type> get_l_factor() const
103 {
104 // Can be `static_cast` since the type is guaranteed in this class
105 return std::static_pointer_cast<const matrix_type>(
106 this->get_operators()[0]);
107 }
108
109 std::shared_ptr<const matrix_type> get_lt_factor() const
110 {
111 if (this->get_operators().size() == 2) {
112 // Can be `static_cast` since the type is guaranteed in this class
113 return std::static_pointer_cast<const matrix_type>(
114 this->get_operators()[1]);
115 } else {
116 return std::static_pointer_cast<const matrix_type>(
117 share(get_l_factor()->conj_transpose()));
118 }
119 }
120
121 // Remove the possibility of calling `create`, which was enabled by
122 // `Composition`
123 template <typename... Args>
124 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
125 delete;
126
128 {
136
147 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
148
153 std::shared_ptr<typename matrix_type::strategy_type>
154 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
155
161 bool GKO_FACTORY_PARAMETER_SCALAR(both_factors, true);
162 };
165
166protected:
167 explicit ParIc(const Factory* factory,
168 std::shared_ptr<const LinOp> system_matrix)
169 : Composition<ValueType>(factory->get_executor()),
170 parameters_{factory->get_parameters()}
171 {
172 if (parameters_.l_strategy == nullptr) {
173 parameters_.l_strategy =
174 std::make_shared<typename matrix_type::classical>();
175 }
176 generate(system_matrix, parameters_.skip_sorting,
177 parameters_.both_factors)
178 ->move_to(this);
179 }
180
181 std::unique_ptr<Composition<ValueType>> generate(
182 const std::shared_ptr<const LinOp>& system_matrix, bool skip_sorting,
183 bool both_factors) const;
184};
185
186
187} // namespace factorization
188} // namespace gko
189
190
191#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_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
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:263
Definition par_ic.hpp:163
ParIC is an incomplete Cholesky factorization which is computed in parallel.
Definition par_ic.hpp:96
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::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
detail::shared_type< OwningPointer > share(OwningPointer &&p)
Marks the object pointed to by p as shared.
Definition utils_helper.hpp:254
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition par_ic.hpp:147
bool both_factors
true will generate both L and L^H, false will only generate the L factor, resulting in a Composition ...
Definition par_ic.hpp:161
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ic.hpp:154