ScaledPermutation is a matrix combining a permutation with scaling factors. More...

#include <ginkgo/core/matrix/scaled_permutation.hpp>

Inheritance diagram for gko::matrix::ScaledPermutation< ValueType, IndexType >:

Collaboration diagram for gko::matrix::ScaledPermutation< ValueType, IndexType >:

Public Types
using	value_type = ValueType

using	index_type = IndexType

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

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

Public Types inherited from gko::WritableToMatrixData< ValueType, IndexType >
using	value_type = ValueType

using	index_type = IndexType

Public Member Functions
value_type *	get_scaling_factors () noexcept
	Returns a pointer to the scaling factors. More...

const value_type *	get_const_scaling_factors () const noexcept
	Returns a pointer to the scaling factors. More...

index_type *	get_permutation () noexcept
	Returns a pointer to the permutation indices. More...

const index_type *	get_const_permutation () const noexcept
	Returns a pointer to the permutation indices. More...

std::unique_ptr< ScaledPermutation >	compute_inverse () const
	Returns the inverse of this operator as a scaled permutation. More...

std::unique_ptr< ScaledPermutation >	compose (ptr_param< const ScaledPermutation > other) const
	Composes this scaled permutation with another scaled permutation. More...

void	write (gko::matrix_data< value_type, index_type > &data) const override
	Writes a matrix to a matrix_data structure. More...

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

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

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

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

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

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

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

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

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

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

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

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

ScaledPermutation< 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< ScaledPermutation< 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< ScaledPermutation< 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< ScaledPermutation >	create (std::shared_ptr< const Executor > exec, size_type size=0)
	Creates an uninitialized ScaledPermutation matrix. More...

static std::unique_ptr< ScaledPermutation >	create (ptr_param< const Permutation< IndexType >> permutation)
	Create a ScaledPermutation from a Permutation. More...

static std::unique_ptr< ScaledPermutation >	create (std::shared_ptr< const Executor > exec, array< value_type > scaling_factors, array< index_type > permutation_indices)
	Creates a ScaledPermutation matrix from already allocated arrays. More...

static std::unique_ptr< const ScaledPermutation >	create_const (std::shared_ptr< const Executor > exec, gko::detail::const_array_view< value_type > &&scale, gko::detail::const_array_view< index_type > &&perm_idxs)
	Creates a constant (immutable) ScaledPermutation matrix from constant arrays. More...

Friends
class	EnablePolymorphicObject< ScaledPermutation, LinOp >

Detailed Description

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

ScaledPermutation is a matrix combining a permutation with scaling factors.

It is a combination of Diagonal and Permutation, and can be read as $SP = P \cdot S$ , i.e. the scaling gets applied before the permutation.

Template Parameters

IndexType	index type of permutation indices
ValueType	value type of the scaling factors

Member Function Documentation

◆ compose()

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

std::unique_ptr<ScaledPermutation> gko::matrix::ScaledPermutation< ValueType, IndexType >::compose ( ptr_param< const ScaledPermutation< ValueType, IndexType > > other ) const

Composes this scaled permutation with another scaled permutation.

This means result = other * this from the matrix perspective, which is equivalent to first scaling and permuting by this and then by other.

Parameters

other the other permutation

Returns: the combined permutation

◆ compute_inverse()

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

std::unique_ptr<ScaledPermutation> gko::matrix::ScaledPermutation< ValueType, IndexType >::compute_inverse ( ) const

Returns the inverse of this operator as a scaled permutation.

It is computed via $(P S)^-1 = P^{-1} (P S P^{-1})$ .

Returns: a newly created ScaledPermutation object storing the inverse of the permutation and scaling factors of this ScaledPermutation.

◆ create() [1/3]

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

static std::unique_ptr<ScaledPermutation> gko::matrix::ScaledPermutation< ValueType, IndexType >::create ( ptr_param< const Permutation< IndexType >> permutation )

static

Create a ScaledPermutation from a Permutation.

The permutation will be copied, the scaling factors are all set to 1.0.

Parameters

permutation the permutation

Returns: A smart pointer to the newly created matrix.

◆ create() [2/3]

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

static std::unique_ptr<ScaledPermutation> gko::matrix::ScaledPermutation< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		array< value_type >	scaling_factors,
		array< index_type >	permutation_indices
	)

static

Creates a ScaledPermutation matrix from already allocated arrays.

Parameters

exec	Executor associated to the matrix
permutation_indices	array of permutation indices
scaling_factors	array of scaling factors

Returns: A smart pointer to the newly created matrix.

◆ create() [3/3]

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

static std::unique_ptr<ScaledPermutation> gko::matrix::ScaledPermutation< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		size_type	size = `0`
	)

static

Creates an uninitialized ScaledPermutation matrix.

Parameters

exec	Executor associated to the matrix
size	dimensions of the (square) scaled permutation matrix

Returns: A smart pointer to the newly created matrix.

◆ create_const()

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

static std::unique_ptr<const ScaledPermutation> gko::matrix::ScaledPermutation< ValueType, IndexType >::create_const	(	std::shared_ptr< const Executor >	exec,
		gko::detail::const_array_view< value_type > &&	scale,
		gko::detail::const_array_view< index_type > &&	perm_idxs
	)

static

Creates a constant (immutable) ScaledPermutation matrix from constant arrays.

Parameters

exec	the executor to create the object on
perm_idxs	the permutation index array of the matrix
scale	the scaling factor array

Returns: A smart pointer to the constant matrix wrapping the input arrays (if it resides on the same executor as the matrix) or a copy of the arrays on the correct executor.

◆ get_const_permutation()

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

const index_type* gko::matrix::ScaledPermutation< ValueType, IndexType >::get_const_permutation ( ) const

inlinenoexcept

Returns a pointer to the permutation indices.

Returns: the pointer to the permutation indices.

Note: This is the constant version of the function, which can be significantly more memory efficient than the non-constant version, so always prefer this version.

References gko::array< ValueType >::get_const_data().

◆ get_const_scaling_factors()

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

const value_type* gko::matrix::ScaledPermutation< ValueType, IndexType >::get_const_scaling_factors ( ) const

inlinenoexcept

Returns a pointer to the scaling factors.

Returns: the pointer to the scaling factors.

Note: This is the constant version of the function, which can be significantly more memory efficient than the non-constant version, so always prefer this version.

References gko::array< ValueType >::get_const_data().

◆ get_permutation()

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

index_type* gko::matrix::ScaledPermutation< ValueType, IndexType >::get_permutation ( )

inlinenoexcept

Returns a pointer to the permutation indices.

Returns: the pointer to the permutation indices.

References gko::array< ValueType >::get_data().

◆ get_scaling_factors()

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

value_type* gko::matrix::ScaledPermutation< ValueType, IndexType >::get_scaling_factors ( )

inlinenoexcept

Returns a pointer to the scaling factors.

Returns: the pointer to the scaling factors.

References gko::array< ValueType >::get_data().

◆ write()

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

void gko::matrix::ScaledPermutation< ValueType, IndexType >::write ( gko::matrix_data< value_type, index_type > & data ) const

overridevirtual

Writes a matrix to a matrix_data structure.

Parameters

data	the matrix_data structure

Implements gko::WritableToMatrixData< ValueType, IndexType >.

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

ginkgo/core/matrix/scaled_permutation.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

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

Member Function Documentation

◆ compose()

◆ compute_inverse()

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ create_const()

◆ get_const_permutation()

◆ get_const_scaling_factors()

◆ get_permutation()

◆ get_scaling_factors()

◆ write()

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