Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
gko::matrix::ScaledPermutation< ValueType, IndexType > Class Template Referencefinal

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 >:
[legend]
Collaboration diagram for gko::matrix::ScaledPermutation< ValueType, IndexType >:
[legend]

Public Types

using value_type = ValueType
 
using index_type = IndexType
 
- Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
using result_type
 
- Public Types inherited from gko::ConvertibleTo< ResultType >
using result_type = ResultType
 
- 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.
 
const value_type * get_const_scaling_factors () const noexcept
 Returns a pointer to the scaling factors.
 
index_type * get_permutation () noexcept
 Returns a pointer to the permutation indices.
 
const index_type * get_const_permutation () const noexcept
 Returns a pointer to the permutation indices.
 
std::unique_ptr< ScaledPermutationcompute_inverse () const
 Returns the inverse of this operator as a scaled permutation.
 
std::unique_ptr< ScaledPermutationcompose (ptr_param< const ScaledPermutation > other) const
 Composes this scaled permutation with another scaled permutation.
 
void write (gko::matrix_data< value_type, index_type > &data) const override
 Writes a matrix to a matrix_data structure.
 
- Public Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
const ConcreteLinOpapply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
 
ConcreteLinOpapply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
 
const ConcreteLinOpapply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
 
ConcreteLinOpapply (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< AbstractObjectcreate_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< AbstractObjectcreate_default () const
 
std::unique_ptr< AbstractObjectclone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< AbstractObjectclone () const
 
AbstractObjectcopy_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)
 
AbstractObjectcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 
AbstractObjectmove_from (ptr_param< PolymorphicObject > other)
 
AbstractObjectclear ()
 
- Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObjectoperator= (const PolymorphicObject &)
 
std::unique_ptr< PolymorphicObjectcreate_default (std::shared_ptr< const Executor > exec) const
 Creates a new "default" object of the same dynamic type as this object.
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object.
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object.
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object.
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object.
 
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.
 
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.
 
PolymorphicObjectcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 Copies another object into this object.
 
PolymorphicObjectmove_from (ptr_param< PolymorphicObject > other)
 Moves another object into this object.
 
PolymorphicObjectclear ()
 Transforms the object into its default state.
 
std::shared_ptr< const Executorget_executor () const noexcept
 Returns the Executor of the object.
 
- Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void add_logger (std::shared_ptr< const Logger > logger) override
 Adds a new logger to the list of subscribed loggers.
 
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers.
 
void remove_logger (ptr_param< const Logger > logger)
 
const std::vector< std::shared_ptr< const Logger > > & get_loggers () const override
 Returns the vector containing all loggers registered at this object.
 
void clear_loggers () override
 Remove all loggers registered at this object.
 
- 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
 Converts the implementer to an object of type result_type.
 
void move_to (result_type *result) override
 Converts the implementer to an object of type result_type by moving data from this object.
 
- Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void convert_to (result_type *result) const =0
 Converts the implementer to an object of type result_type.
 
void convert_to (ptr_param< result_type > result) const
 
virtual void move_to (result_type *result)=0
 Converts the implementer to an object of type result_type by moving data from this object.
 
void move_to (ptr_param< result_type > result)
 

Static Public Member Functions

static std::unique_ptr< ScaledPermutationcreate (std::shared_ptr< const Executor > exec, size_type size=0)
 Creates an uninitialized ScaledPermutation matrix.
 
static std::unique_ptr< ScaledPermutationcreate (ptr_param< const Permutation< IndexType > > permutation)
 Create a ScaledPermutation from a Permutation.
 
static std::unique_ptr< ScaledPermutationcreate (std::shared_ptr< const Executor > exec, array< value_type > scaling_factors, array< index_type > permutation_indices)
 Creates a ScaledPermutation matrix from already allocated arrays.
 
static std::unique_ptr< const ScaledPermutationcreate_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.
 

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
IndexTypeindex type of permutation indices
ValueTypevalue 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
otherthe 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
permutationthe permutation
Returns
the scaled permutation.

◆ 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
execExecutor associated to the matrix
permutation_indicesarray of permutation indices
scaling_factorsarray of scaling factors

◆ 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
execExecutor associated to the matrix
sizedimensions of the (square) scaled permutation 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
execthe executor to create the object on
perm_idxsthe permutation index array of the matrix
scalethe 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
datathe matrix_data structure

Implements gko::WritableToMatrixData< ValueType, IndexType >.


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