gko::factorization::Ilu< ValueType, IndexType > Class Template Reference

Represents an incomplete LU factorization – ILU(0) – of a sparse matrix. More...

#include <ginkgo/core/factorization/ilu.hpp>

Inheritance diagram for gko::factorization::Ilu< ValueType, IndexType >:

Collaboration diagram for gko::factorization::Ilu< ValueType, IndexType >:

Classes
class	Factory
struct	parameters_type

Public Types
using	value_type = ValueType
using	index_type = IndexType
using	matrix_type = matrix::Csr< ValueType, IndexType >
Public Types inherited from gko::Composition< ValueType >
using	value_type = ValueType
using	transposed_type = Composition< ValueType >

Public Member Functions
std::shared_ptr< const matrix_type >	get_l_factor () const
std::shared_ptr< const matrix_type >	get_u_factor () const
const parameters_type &	get_parameters () const
Public Member Functions inherited from gko::Composition< ValueType >
const std::vector< std::shared_ptr< const LinOp > > &	get_operators () const noexcept
	Returns a list of operators of the composition. More...
std::unique_ptr< LinOp >	transpose () const override
	Returns a LinOp representing the transpose of the Transposable object. More...
std::unique_ptr< LinOp >	conj_transpose () const override
	Returns a LinOp representing the conjugate transpose of the Transposable object. More...
Composition &	operator= (const Composition &)
	Copy-assigns a Composition. More...
Composition &	operator= (Composition &&)
	Move-assigns a Composition. More...
	Composition (const Composition &)
	Copy-constructs a Composition. More...
	Composition (Composition &&)
	Move-constructs a Composition. More...
Public Member Functions inherited from gko::LinOp
void	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
	Applies a linear operator to a vector (or a sequence of vectors). More...
void	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
	Performs the operation x = alpha * op(b) + beta * x. More...
const dim< 2 > &	get_size () const noexcept
	Returns the size of the operator. More...
virtual bool	apply_uses_initial_guess () const
	Returns true if the linear operator uses the data given in x as an initial guess. More...
LinOp &	operator= (const LinOp &)=default
	Copy-assigns a LinOp. More...
LinOp &	operator= (LinOp &&other)
	Move-assigns a LinOp. More...
	LinOp (const LinOp &)=default
	Copy-constructs a LinOp. More...
	LinOp (LinOp &&other)
	Move-constructs a LinOp. More...
Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)
std::shared_ptr< const Executor >	get_executor () const noexcept
	Returns the Executor of the object. More...
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)

Static Public Member Functions
template<typename... Args>
static std::unique_ptr< Composition< ValueType > >	create (Args &&... args)=delete
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< ValueType, IndexType >())
	Create the parameters from the property_tree. More...
Static Public Member Functions inherited from gko::EnableCreateMethod< Composition< ValueType > >
static std::unique_ptr< Composition< ValueType > >	create (Args &&... args)

Detailed Description

template<typename ValueType = gko::default_precision, typename IndexType = gko::int32>
class gko::factorization::Ilu< ValueType, IndexType >

Represents an incomplete LU factorization – ILU(0) – of a sparse matrix.

More specifically, it consists of a lower unitriangular factor and an upper triangular factor with sparsity pattern = fulfilling at every non-zero location of .

Template Parameters

ValueType	Type of the values of all matrices used in this class
IndexType	Type of the indices of all matrices used in this class

Member Function Documentation

parse()

template<typename ValueType = gko::default_precision, typename IndexType = gko::int32>

static parameters_type gko::factorization::Ilu< ValueType, IndexType >::parse ( const config::pnode &  config, const config::registry &  context, const config::type_descriptor &  td_for_child = config::make_type_descriptor< ValueType, IndexType >()  )

static

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

---

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

• ginkgo/core/factorization/ilu.hpp