gko::experimental::factorization::Cholesky< ValueType, IndexType > Class Template Reference

Computes a Cholesky factorization of a symmetric, positive-definite sparse matrix. More...

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

Inheritance diagram for gko::experimental::factorization::Cholesky< ValueType, IndexType >:

Collaboration diagram for gko::experimental::factorization::Cholesky< ValueType, IndexType >:

Classes
struct	parameters_type

Public Types
using	value_type = ValueType
using	index_type = IndexType
using	matrix_type = matrix::Csr< value_type, index_type >
using	sparsity_pattern_type = matrix::SparsityCsr< value_type, index_type >
using	factorization_type = Factorization< value_type, index_type >
Public Types inherited from gko::EnablePolymorphicAssignment< Cholesky< ValueType, IndexType > >
using	result_type = Cholesky< ValueType, IndexType >
Public Types inherited from gko::ConvertibleTo< Cholesky< ValueType, IndexType > >
using	result_type = Cholesky< ValueType, IndexType >

Public Member Functions
const parameters_type &	get_parameters ()
	Returns the parameters used to construct the factory. More...
const parameters_type &	get_parameters () const
	Returns the parameters used to construct the factory. More...
std::unique_ptr< factorization_type >	generate (std::shared_ptr< const LinOp > system_matrix) const
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Cholesky< ValueType, IndexType >, LinOpFactory >
std::unique_ptr< Cholesky< ValueType, IndexType > >	create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Cholesky< ValueType, IndexType > >	create_default () const
std::unique_ptr< Cholesky< ValueType, IndexType > >	clone (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Cholesky< ValueType, IndexType > >	clone () const
Cholesky< ValueType, IndexType > *	copy_from (const PolymorphicObject *other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Cholesky< ValueType, IndexType > > *	copy_from (std::unique_ptr< Derived > &&other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Cholesky< ValueType, IndexType > > *	copy_from (const std::unique_ptr< Derived > &other)
Cholesky< ValueType, IndexType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
Cholesky< ValueType, IndexType > *	move_from (ptr_param< PolymorphicObject > other)
Cholesky< ValueType, IndexType > *	clear ()
Public Member Functions inherited from gko::LinOpFactory
std::unique_ptr< LinOp >	generate (std::shared_ptr< const LinOp > input) const
Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)
std::unique_ptr< PolymorphicObject >	create_default (std::shared_ptr< const Executor > exec) const
	Creates a new "default" object of the same dynamic type as this object. More...
std::unique_ptr< PolymorphicObject >	create_default () const
	Creates a new "default" object of the same dynamic type as this object. More...
std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const
	Creates a clone of the object. More...
std::unique_ptr< PolymorphicObject >	clone () const
	Creates a clone of the object. More...
PolymorphicObject *	copy_from (const PolymorphicObject *other)
	Copies another object into this object. More...
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)
	Moves another object into this object. More...
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)
	Copies another object into this object. More...
PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
	Copies another object into this object. More...
PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)
	Moves another object into this object. More...
PolymorphicObject *	clear ()
	Transforms the object into its default state. More...
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)
Public Member Functions inherited from gko::EnablePolymorphicAssignment< Cholesky< ValueType, IndexType > >
void	convert_to (result_type *result) const override
	Converts the implementer to an object of type result_type. More...
void	move_to (result_type *result) override
	Converts the implementer to an object of type result_type by moving data from this object. More...
Public Member Functions inherited from gko::ConvertibleTo< Cholesky< ValueType, IndexType > >
void	convert_to (ptr_param< result_type > result) const
void	move_to (ptr_param< result_type > result)

Static Public Member Functions
static parameters_type	build ()
	Creates a new parameter_type to set up the factory.
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...

Friends
class	EnablePolymorphicObject< Cholesky, LinOpFactory >
class	enable_parameters_type< parameters_type, Cholesky >

Detailed Description

template<typename ValueType, typename IndexType>
class gko::experimental::factorization::Cholesky< ValueType, IndexType >

Computes a Cholesky factorization of a symmetric, positive-definite sparse matrix.

This LinOpFactory returns a Factorization storing the L and L^H factors for the provided system matrix in matrix::Csr format. If no symbolic factorization is provided, it will be computed first. It expects all fill-in entries to be present in the symbolic factorization. If the symbolic factorization is missing some entries, please refer to Ic.

Template Parameters

ValueType	the type used to store values of the system matrix
IndexType	the type used to store sparsity pattern indices of the system matrix

Member Function Documentation

generate()

template<typename ValueType , typename IndexType >

std::unique_ptr<factorization_type> gko::experimental::factorization::Cholesky< ValueType, IndexType >::generate

(

std::shared_ptr< const LinOp >

system_matrix

)

const

Note

This function overrides the default LinOpFactory::generate to return a Factorization instead of a generic LinOp, which would need to be cast to Factorization again to access its factors. It is only necessary because smart pointers aren't covariant.

get_parameters() [1/2]

template<typename ValueType , typename IndexType >

const parameters_type& gko::experimental::factorization::Cholesky< ValueType, IndexType >::get_parameters ( )

inline

Returns the parameters used to construct the factory.

Returns

the parameters used to construct the factory.

get_parameters() [2/2]

template<typename ValueType , typename IndexType >

const parameters_type& gko::experimental::factorization::Cholesky< ValueType, IndexType >::get_parameters ( ) const

inline

Returns the parameters used to construct the factory.

Returns

the parameters used to construct the factory.

parse()

template<typename ValueType , typename IndexType >

static parameters_type gko::experimental::factorization::Cholesky< 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/cholesky.hpp