Represents a generic factorization consisting of two triangular factors (upper and lower) and an optional diagonal scaling matrix. More...

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

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

[legend]

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

[legend]

Public Types
using	value_type = ValueType

using	index_type = IndexType

using	matrix_type = matrix::Csr< ValueType, IndexType >

using	diag_type = matrix::Diagonal< ValueType >

using	composition_type = Composition< ValueType >

Public Types inherited from gko::EnablePolymorphicAssignment< Factorization< ValueType, IndexType > >
using	result_type = Factorization< ValueType, IndexType >

Public Types inherited from gko::ConvertibleTo< Factorization< ValueType, IndexType > >
using	result_type = Factorization< ValueType, IndexType >

Public Member Functions
std::unique_ptr< Factorization >	unpack () const
	Transforms the factorization from a compact representation suitable only for triangular solves to a composition representation that can also be used to access individual factors and multiply with the factorization. More...

storage_type	get_storage_type () const
	Returns the storage type used by this factorization.

std::shared_ptr< const matrix_type >	get_lower_factor () const
	Returns the lower triangular factor of the factorization, if available, nullptr otherwise.

std::shared_ptr< const diag_type >	get_diagonal () const
	Returns the diagonal scaling matrix of the factorization, if available, nullptr otherwise.

std::shared_ptr< const matrix_type >	get_upper_factor () const
	Returns the upper triangular factor of the factorization, if available, nullptr otherwise.

std::shared_ptr< const matrix_type >	get_combined () const
	Returns the matrix storing a compact representation of the factorization, if available, nullptr otherwise.

	Factorization (const Factorization &)
	Creates a deep copy of the factorization.

	Factorization (Factorization &&)
	Moves from the given factorization, leaving it empty.

Factorization &	operator= (const Factorization &)

Factorization &	operator= (Factorization &&)

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

Factorization< ValueType, IndexType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const Factorization< ValueType, IndexType > *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

Factorization< ValueType, IndexType > *	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< Factorization< ValueType, IndexType >, LinOp >
std::unique_ptr< Factorization< ValueType, IndexType > >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Factorization< ValueType, IndexType > >	create_default () const

std::unique_ptr< Factorization< ValueType, IndexType > >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Factorization< ValueType, IndexType > >	clone () const

Factorization< ValueType, IndexType > *	copy_from (const PolymorphicObject *other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Factorization< ValueType, IndexType > > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Factorization< ValueType, IndexType > > *	copy_from (const std::unique_ptr< Derived > &other)

Factorization< ValueType, IndexType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

Factorization< ValueType, IndexType > *	move_from (ptr_param< PolymorphicObject > other)

Factorization< ValueType, IndexType > *	clear ()

Public Member Functions inherited from gko::LinOp
LinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
	Applies a linear operator to a vector (or a sequence of vectors). More...

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

LinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)
	Performs the operation x = alpha * op(b) + beta * x. More...

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

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::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOp >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< LinOp >	create_default () const

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

std::unique_ptr< LinOp >	clone () const

LinOp *	copy_from (const PolymorphicObject *other)

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

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

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

LinOp *	move_from (ptr_param< PolymorphicObject > other)

LinOp *	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
	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< Factorization< 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< Factorization< ValueType, IndexType > >
void	convert_to (ptr_param< result_type > result) const

void	move_to (ptr_param< result_type > result)

Static Public Member Functions
static std::unique_ptr< Factorization >	create_from_composition (std::unique_ptr< composition_type > composition)
	Creates a Factorization from an existing composition. More...

static std::unique_ptr< Factorization >	create_from_symm_composition (std::unique_ptr< composition_type > composition)
	Creates a Factorization from an existing symmetric composition. More...

static std::unique_ptr< Factorization >	create_from_combined_lu (std::unique_ptr< matrix_type > matrix)
	Creates a Factorization from an existing combined representation of an LU factorization. More...

static std::unique_ptr< Factorization >	create_from_combined_ldu (std::unique_ptr< matrix_type > matrix)

static std::unique_ptr< Factorization >	create_from_combined_cholesky (std::unique_ptr< matrix_type > matrix)

static std::unique_ptr< Factorization >	create_from_combined_ldl (std::unique_ptr< matrix_type > matrix)

Friends
class	EnablePolymorphicObject< Factorization, LinOp >

Detailed Description

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

Represents a generic factorization consisting of two triangular factors (upper and lower) and an optional diagonal scaling matrix.

This class is used to represent a wide range of different factorizations to be passed on to direct solvers and other similar operations. The storage_type represents how the individual factors are stored internally: They may be stored as separate matrices or in a single matrix, and be symmetric or unsymmetric, with the diagonal belonging to both factory, a single factor or being a separate scaling factor (Cholesky vs. LDL^H vs. LU vs. LDU).

Template Parameters

ValueType	the value type used to store the factorization entries
IndexType	the index type used to represent the sparsity pattern

Member Function Documentation

◆ create_from_combined_lu()

template<typename ValueType , typename IndexType >

static std::unique_ptr<Factorization> gko::experimental::factorization::Factorization< ValueType, IndexType >::create_from_combined_lu ( std::unique_ptr< matrix_type > matrix )

static

Creates a Factorization from an existing combined representation of an LU factorization.

Parameters

matrix the composition consisting of 2 or 3 elements. We expect the first entry to be a lower triangular matrix, and the last entry to be the transpose of the first entry. If the composition has 3 elements, we expect the middle entry to be a diagonal matrix.

Returns: a symmetric Factorization storing the elements from the Composition.

◆ create_from_composition()

template<typename ValueType , typename IndexType >

static std::unique_ptr<Factorization> gko::experimental::factorization::Factorization< ValueType, IndexType >::create_from_composition ( std::unique_ptr< composition_type > composition )

static

Creates a Factorization from an existing composition.

Parameters

composition the composition consisting of 2 or 3 elements. We expect the first entry to be a lower triangular matrix, and the last entry to be an upper triangular matrix. If the composition has 3 elements, we expect the middle entry to be a diagonal matrix.

Returns: a Factorization storing the elements from the Composition.

◆ create_from_symm_composition()

template<typename ValueType , typename IndexType >

static std::unique_ptr<Factorization> gko::experimental::factorization::Factorization< ValueType, IndexType >::create_from_symm_composition ( std::unique_ptr< composition_type > composition )

static

Creates a Factorization from an existing symmetric composition.

Parameters

composition the composition consisting of 2 or 3 elements. We expect the first entry to be a lower triangular matrix, and the last entry to be the transpose of the first entry. If the composition has 3 elements, we expect the middle entry to be a diagonal matrix.

Returns: a symmetric Factorization storing the elements from the Composition.

◆ unpack()

template<typename ValueType , typename IndexType >

std::unique_ptr<Factorization> gko::experimental::factorization::Factorization< ValueType, IndexType >::unpack ( ) const

Transforms the factorization from a compact representation suitable only for triangular solves to a composition representation that can also be used to access individual factors and multiply with the factorization.

Returns: a new Factorization object containing this factorization represented as storage_type::composition.

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

ginkgo/core/factorization/factorization.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

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

Member Function Documentation

◆ create_from_combined_lu()

◆ create_from_composition()

◆ create_from_symm_composition()

◆ unpack()

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