5#ifndef GKO_PUBLIC_CORE_FACTORIZATION_PAR_IC_HPP_
6#define GKO_PUBLIC_CORE_FACTORIZATION_PAR_IC_HPP_
12#include <ginkgo/core/base/composition.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/types.hpp>
15#include <ginkgo/core/matrix/csr.hpp>
24namespace factorization {
67template <
typename ValueType = default_precision,
typename IndexType =
int32>
70 using value_type = ValueType;
71 using index_type = IndexType;
74 std::shared_ptr<const matrix_type> get_l_factor()
const
77 return std::static_pointer_cast<const matrix_type>(
81 std::shared_ptr<const matrix_type> get_lt_factor()
const
85 return std::static_pointer_cast<const matrix_type>(
88 return std::static_pointer_cast<const matrix_type>(
95 template <
typename...
Args>
96 static std::unique_ptr<Composition<ValueType>> create(
Args&&...
args) =
125 std::shared_ptr<typename matrix_type::strategy_type>
140 std::shared_ptr<const LinOp> system_matrix)
142 parameters_{factory->get_parameters()}
146 std::make_shared<typename matrix_type::classical>();
153 std::unique_ptr<Composition<ValueType>> generate(
154 const std::shared_ptr<const LinOp>& system_matrix,
bool skip_sorting,
155 bool both_factors)
const;
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:41
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:54
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
Definition par_ic.hpp:135
ParIC is an incomplete Cholesky factorization which is computed in parallel.
Definition par_ic.hpp:68
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:117
#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:280
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
#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:394
#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:1018
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:92
detail::shared_type< OwningPointer > share(OwningPointer &&p)
Marks the object pointed to by p as shared.
Definition utils_helper.hpp:226
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition par_ic.hpp:119
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:133
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ic.hpp:126