#include <ginkgo/core/preconditioner/ic.hpp>

Inheritance diagram for gko::preconditioner::Ic< LSolverType, IndexType >:

Classes
class	Factory

struct	parameters_type

Public Types
using	value_type = typename LSolverType::value_type

using	l_solver_type = LSolverType

using	lh_solver_type = typename LSolverType::transposed_type

using	index_type = IndexType

using	transposed_type = Ic< LSolverType, IndexType >

Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
using	result_type = ConcreteLinOp

Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

Public Member Functions
const parameters_type &	get_parameters () const

std::shared_ptr< const l_solver_type >	get_l_solver () const

std::shared_ptr< const lh_solver_type >	get_lh_solver () const

std::unique_ptr< LinOp >	transpose () const override

std::unique_ptr< LinOp >	conj_transpose () const override

Ic &	operator= (const Ic &other)

Ic &	operator= (Ic &&other)

	Ic (const Ic &other)

	Ic (Ic &&other)

Public Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
const ConcreteLinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

ConcreteLinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const ConcreteLinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

ConcreteLinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< AbstractObject, PolymorphicBase >
std::unique_ptr< AbstractObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	create_default () const

std::unique_ptr< AbstractObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	clone () const

AbstractObject *	copy_from (const PolymorphicObject *other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (std::unique_ptr< Derived > &&other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (const std::unique_ptr< Derived > &other)

AbstractObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

AbstractObject *	move_from (ptr_param< PolymorphicObject > other)

AbstractObject *	clear ()

Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)

std::unique_ptr< PolymorphicObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	create_default () const

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (std::unique_ptr< Derived, Deleter > &&other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (const std::unique_ptr< Derived, Deleter > &other)

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override

void	remove_logger (const Logger *logger) override

void	remove_logger (ptr_param< const Logger > logger)

const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override

void	clear_loggers () override

Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Public Member Functions inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
void	convert_to (result_type *result) const override

void	move_to (result_type *result) override

Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void	convert_to (result_type *result) const =0

void	convert_to (ptr_param< result_type > result) const

virtual void	move_to (result_type *result)=0

void	move_to (ptr_param< result_type > result)

Static Public Member Functions
static auto	build () -> decltype(Factory ::create())

static parameters_type	parse (const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< value_type, index_type >())

Protected Member Functions
void	apply_impl (const LinOp b, LinOp x) const override

void	apply_impl (const LinOp alpha, const LinOp b, const LinOp beta, LinOp x) const override

	Ic (std::shared_ptr< const Executor > exec)

	Ic (const Factory *factory, std::shared_ptr< const LinOp > lin_op)

void	set_cache_to (const LinOp *b) const

Protected Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
ConcreteLinOp *	self () noexcept

const ConcreteLinOp *	self () const noexcept

Protected Member Functions inherited from gko::EnablePolymorphicObject< ConcreteObject, PolymorphicBase >
std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const override

PolymorphicObject *	copy_from_impl (const PolymorphicObject *other) override

PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	move_from_impl (PolymorphicObject *other) override

PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	clear_impl () override

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Static Protected Member Functions
template<typename SolverType >
static std::enable_if_t< solver::has_with_criteria< SolverType >::value, std::unique_ptr< SolverType > >	generate_default_solver (const std::shared_ptr< const Executor > &exec, const std::shared_ptr< const LinOp > &mtx)

template<typename SolverType >
static std::enable_if_t<!solver::has_with_criteria< SolverType >::value, std::unique_ptr< SolverType > >	generate_default_solver (const std::shared_ptr< const Executor > &exec, const std::shared_ptr< const LinOp > &mtx)

Friends
class	EnableLinOp< Ic >

class	EnablePolymorphicObject< Ic, LinOp >

Additional Inherited Members
Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

Detailed Description

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>
class gko::preconditioner::Ic< LSolverType, IndexType >

The Incomplete Cholesky (IC) preconditioner solves the equation \(LL^H*x = b\) for a given lower triangular matrix L and the right hand side b (can contain multiple right hand sides).

It allows to set both the solver for L defaulting to solver::LowerTrs, which is a direct triangular solvers. The solver for L^H is the conjugate-transposed solver for L, ensuring that the preconditioner is symmetric and positive-definite. For this L solver, a factory can be provided (using with_l_solver) to have more control over their behavior. In particular, it is possible to use an iterative method for solving the triangular systems. The default parameters for an iterative triangluar solver are:

reduction factor = 1e-4
max iteration = <number of rows of the matrix given to the solver> Solvers without such criteria can also be used, in which case none are set.

An object of this class can be created with a matrix or a gko::Composition containing two matrices. If created with a matrix, it is factorized before creating the solver. If a gko::Composition (containing two matrices) is used, the first operand will be taken as the L matrix, the second will be considered the L^H matrix, which helps to avoid the otherwise necessary transposition of L inside the solver. ParIc can be directly used, since it orders the factors in the correct way.

Note: When providing a gko::Composition, the first matrix must be the lower matrix ( \(L\)), and the second matrix must be its conjugate-transpose ( \(L^H\)). If they are swapped, solving might crash or return the wrong result.; Do not use symmetric solvers (like CG) for the L solver since both matrices (L and L^H) are, by design, not symmetric.; This class is not thread safe (even a const object is not) because it uses an internal cache to accelerate multiple (sequential) applies. Using it in parallel can lead to segmentation faults, wrong results and other unwanted behavior.

Template Parameters

LSolverType	type of the solver used for the L matrix. Defaults to solver::LowerTrs
IndexType	type of the indices when ParIc is used to generate the L and L^H factors. Irrelevant otherwise.

Constructor & Destructor Documentation

◆ Ic() [1/2]

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

gko::preconditioner::Ic< LSolverType, IndexType >::Ic ( const Ic< LSolverType, IndexType > & other )

inline

Copy-constructs an IC preconditioner. Inherits the executor, shallow-copies the solvers and parameters.

◆ Ic() [2/2]

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

gko::preconditioner::Ic< LSolverType, IndexType >::Ic ( Ic< LSolverType, IndexType > && other )

inline

Move-constructs an IC preconditioner. Inherits the executor, moves the solvers and parameters. The moved-from object is empty (0x0 with nullptr solvers and default parameters)

Member Function Documentation

◆ conj_transpose()

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

std::unique_ptr< LinOp > gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose ( ) const

inlineoverridevirtual

Returns a LinOp representing the conjugate transpose of the Transposable object.

Returns: a pointer to the new conjugate transposed object

Implements gko::Transposable.

References gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose(), gko::PolymorphicObject::get_executor(), gko::preconditioner::Ic< LSolverType, IndexType >::get_l_solver(), gko::preconditioner::Ic< LSolverType, IndexType >::get_lh_solver(), gko::share(), and gko::transpose().

Referenced by gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose().

◆ generate_default_solver() [1/2]

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

template<typename SolverType >

static std::enable_if_t< solver::has_with_criteria< SolverType >::value, std::unique_ptr< SolverType > > gko::preconditioner::Ic< LSolverType, IndexType >::generate_default_solver	(	const std::shared_ptr< const Executor > &	exec,
		const std::shared_ptr< const LinOp > &	mtx
	)

inlinestaticprotected

Generates a default solver of type SolverType.

Also checks whether SolverType can be assigned a criteria, and if it can, it is assigned default values which should be well suited for a preconditioner.

◆ generate_default_solver() [2/2]

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

template<typename SolverType >

static std::enable_if_t<!solver::has_with_criteria< SolverType >::value, std::unique_ptr< SolverType > > gko::preconditioner::Ic< LSolverType, IndexType >::generate_default_solver	(	const std::shared_ptr< const Executor > &	exec,
		const std::shared_ptr< const LinOp > &	mtx
	)

inlinestaticprotected

Generates a default solver of type SolverType.

Also checks whether SolverType can be assigned a criteria, and if it can, it is assigned default values which should be well suited for a preconditioner.

◆ get_l_solver()

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

std::shared_ptr< const l_solver_type > gko::preconditioner::Ic< LSolverType, IndexType >::get_l_solver ( ) const

inline

Returns the solver which is used for the provided L matrix.

Returns: the solver which is used for the provided L matrix

Referenced by gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose(), and gko::preconditioner::Ic< LSolverType, IndexType >::transpose().

◆ get_lh_solver()

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

std::shared_ptr< const lh_solver_type > gko::preconditioner::Ic< LSolverType, IndexType >::get_lh_solver ( ) const

inline

Returns the solver which is used for the L^H matrix.

Returns: the solver which is used for the L^H matrix

Referenced by gko::preconditioner::Ic< LSolverType, IndexType >::conj_transpose(), and gko::preconditioner::Ic< LSolverType, IndexType >::transpose().

◆ operator=() [1/2]

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

Ic & gko::preconditioner::Ic< LSolverType, IndexType >::operator= ( const Ic< LSolverType, IndexType > & other )

inline

Copy-assigns an IC preconditioner. Preserves the executor, shallow-copies the solvers and parameters. Creates a clone of the solvers if they are on the wrong executor.

References gko::clone(), and gko::PolymorphicObject::get_executor().

◆ operator=() [2/2]

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

Ic & gko::preconditioner::Ic< LSolverType, IndexType >::operator= ( Ic< LSolverType, IndexType > && other )

inline

Move-assigns an IC preconditioner. Preserves the executor, moves the solvers and parameters. Creates a clone of the solvers if they are on the wrong executor. The moved-from object is empty (0x0 with nullptr solvers and default parameters)

References gko::clone(), and gko::PolymorphicObject::get_executor().

◆ parse()

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

static parameters_type gko::preconditioner::Ic< LSolverType, IndexType >::parse	(	const config::pnode &	config,
		const config::registry &	context,
		const config::type_descriptor &	td_for_child = `config::make_type_descriptor<value_type, index_type>()`
	)

inlinestatic

Create the parameters from the property_tree. Because this is directly tied to the specific type, the value/index type settings within config are ignored and type_descriptor is only used for children configs.

Parameters

config	the property tree for setting
context	the registry
td_for_child	the type descriptor for children configs. The default uses the value/index type of this class.

Returns: parameters

Note: only support the following for l_solver: Ir, Gmres, LowerTrs, and LowerIsai

◆ set_cache_to()

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

void gko::preconditioner::Ic< LSolverType, IndexType >::set_cache_to ( const LinOp * b ) const

inlineprotected

Prepares the intermediate vector for the solve by creating it and by copying the values from b, so b acts as the initial guess.

Parameters

b	Right hand side of the first solve. Also acts as the initial guess, meaning the intermediate value will be a copy of b

References gko::matrix::Dense< ValueType >::create(), and gko::PolymorphicObject::get_executor().

◆ transpose()

template<typename LSolverType = solver::LowerTrs<>, typename IndexType = int32>

std::unique_ptr< LinOp > gko::preconditioner::Ic< LSolverType, IndexType >::transpose ( ) const

inlineoverridevirtual

Returns a LinOp representing the transpose of the Transposable object.

Returns: a pointer to the new transposed object

Implements gko::Transposable.

References gko::PolymorphicObject::get_executor(), gko::preconditioner::Ic< LSolverType, IndexType >::get_l_solver(), gko::preconditioner::Ic< LSolverType, IndexType >::get_lh_solver(), gko::share(), gko::preconditioner::Ic< LSolverType, IndexType >::transpose(), and gko::transpose().

Referenced by gko::preconditioner::Ic< LSolverType, IndexType >::transpose().

The documentation for this class was generated from the following file:

ginkgo/core/preconditioner/ic.hpp

Ic< LSolverType, IndexType > Class Template Reference

Ic< LSolverType, IndexType > Class Template Reference#

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ic() [1/2]

◆ Ic() [2/2]

Member Function Documentation

◆ conj_transpose()

◆ generate_default_solver() [1/2]

◆ generate_default_solver() [2/2]

◆ get_l_solver()

◆ get_lh_solver()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse()

◆ set_cache_to()

◆ transpose()

Ic< LSolverType, IndexType > Class Template Reference

Ic&lt; LSolverType, IndexType &gt; Class Template Reference#

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ic() [1/2]

◆ Ic() [2/2]

Member Function Documentation

◆ conj_transpose()

◆ generate_default_solver() [1/2]

◆ generate_default_solver() [2/2]

◆ get_l_solver()

◆ get_lh_solver()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parse()

◆ set_cache_to()

◆ transpose()

Ic< LSolverType, IndexType > Class Template Reference#