33#ifndef GKO_PUBLIC_CORE_FACTORIZATION_IC_HPP_
34#define GKO_PUBLIC_CORE_FACTORIZATION_IC_HPP_
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>
52namespace factorization {
73 using value_type = ValueType;
74 using index_type = IndexType;
77 std::shared_ptr<const matrix_type> get_l_factor()
const
80 return std::static_pointer_cast<const matrix_type>(
84 std::shared_ptr<const matrix_type> get_lt_factor()
const
88 return std::static_pointer_cast<const matrix_type>(
91 return std::static_pointer_cast<const matrix_type>(
98 template <
typename...
Args>
99 static std::unique_ptr<Composition<ValueType>> create(
Args&&...
args) =
108 std::shared_ptr<typename matrix_type::strategy_type>
134 Ic(
const Factory* factory, std::shared_ptr<const gko::LinOp> system_matrix)
136 parameters_{factory->get_parameters()}
140 std::make_shared<typename matrix_type::classical>();
147 std::unique_ptr<Composition<ValueType>> generate(
148 const std::shared_ptr<const LinOp>& system_matrix,
bool skip_sorting,
149 bool both_factors)
const;
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
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