5#ifndef GKO_PUBLIC_CORE_FACTORIZATION_PAR_ICT_HPP_
6#define GKO_PUBLIC_CORE_FACTORIZATION_PAR_ICT_HPP_
11#include <ginkgo/core/base/composition.hpp>
12#include <ginkgo/core/base/lin_op.hpp>
13#include <ginkgo/core/base/types.hpp>
14#include <ginkgo/core/config/config.hpp>
15#include <ginkgo/core/config/registry.hpp>
16#include <ginkgo/core/matrix/csr.hpp>
68template <
typename ValueType = default_precision,
typename IndexType =
int32>
71 using value_type = ValueType;
72 using index_type = IndexType;
75 std::shared_ptr<const matrix_type> get_l_factor()
const
78 return std::static_pointer_cast<const matrix_type>(
82 std::shared_ptr<const matrix_type> get_lt_factor()
const
85 return std::static_pointer_cast<const matrix_type>(
91 template <
typename... Args>
92 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
175 std::shared_ptr<typename matrix_type::strategy_type>
182 std::shared_ptr<typename matrix_type::strategy_type>
204 config::make_type_descriptor<ValueType, IndexType>());
207 explicit ParIct(
const Factory* factory,
208 std::shared_ptr<const LinOp> system_matrix)
210 parameters_{factory->get_parameters()}
212 if (parameters_.l_strategy ==
nullptr) {
213 parameters_.l_strategy =
214 std::make_shared<typename matrix_type::classical>();
216 if (parameters_.lt_strategy ==
nullptr) {
217 parameters_.lt_strategy =
218 std::make_shared<typename matrix_type::classical>();
220 generate_l_lt(std::move(system_matrix))->move_to(
this);
235 std::unique_ptr<Composition<ValueType>> generate_l_lt(
236 const std::shared_ptr<const LinOp>& system_matrix)
const;
Composition(const Composition &)
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Definition composition.hpp:54
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:243
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:167
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
Definition par_ict.hpp:185
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.
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
#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:1017
The Factorization namespace.
Definition ic.hpp:26
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
Definition par_ict.hpp:96
bool approximate_select
true means the candidate selection will use an inexact selection algorithm.
Definition par_ict.hpp:136
bool skip_sorting
true means it is known that the matrix given to this factory will be sorted first by row,...
Definition par_ict.hpp:120
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ict.hpp:176
size_type iterations
The number of total iterations of ParICT that will be executed.
Definition par_ict.hpp:101
bool deterministic_sample
true means the sample used for the selection algorithm will be chosen deterministically.
Definition par_ict.hpp:155
double fill_in_limit
the amount of fill-in that is allowed in L compared to the lower triangle of A.
Definition par_ict.hpp:169
std::shared_ptr< typename matrix_type::strategy_type > lt_strategy
Strategy which will be used by the L^T matrix.
Definition par_ict.hpp:183