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::Permutation< IndexType > Class Template Reference

Permutation is a matrix format that represents a permutation matrix, i.e. More...

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

Inheritance diagram for gko::matrix::Permutation< IndexType >:
[legend]
Collaboration diagram for gko::matrix::Permutation< IndexType >:
[legend]

Public Types

using value_type = default_precision
 
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

index_type * get_permutation () noexcept
 Returns a pointer to the array of permutation.
 
const index_type * get_const_permutation () const noexcept
 Returns a pointer to the array of permutation.
 
size_type get_permutation_size () const noexcept
 Returns the number of elements explicitly stored in the permutation array.
 
mask_type get_permute_mask () const
 
void set_permute_mask (mask_type permute_mask)
 
std::unique_ptr< Permutationcompute_inverse () const
 Returns the inverse permutation.
 
std::unique_ptr< Permutationcompose (ptr_param< const Permutation > other) const
 Composes this permutation with another permutation.
 
void write (gko::matrix_data< value_type, index_type > &data) const override
 
- 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)
 
- Public Member Functions inherited from gko::WritableToMatrixData< ValueType, IndexType >
virtual void write (matrix_data< ValueType, IndexType > &data) const =0
 Writes a matrix to a matrix_data structure.
 

Static Public Member Functions

static std::unique_ptr< const Permutationcreate_const (std::shared_ptr< const Executor > exec, size_type size, gko::detail::const_array_view< IndexType > &&perm_idxs, mask_type enabled_permute=row_permute)
 Creates a constant (immutable) Permutation matrix from a constant array.
 
static std::unique_ptr< const Permutationcreate_const (std::shared_ptr< const Executor > exec, gko::detail::const_array_view< IndexType > &&perm_idxs)
 Creates a constant (immutable) Permutation matrix from a constant array.
 
- Static Public Member Functions inherited from gko::EnableCreateMethod< ConcreteType >
template<typename... Args>
static std::unique_ptr< ConcreteTypecreate (Args &&... args)
 

Friends

class EnableCreateMethod< Permutation >
 
class EnablePolymorphicObject< Permutation, LinOp >
 

Detailed Description

template<typename IndexType = int32>
class gko::matrix::Permutation< IndexType >

Permutation is a matrix format that represents a permutation matrix, i.e.

a matrix where each row and column has exactly one entry. The matrix can only be applied to Dense inputs, where it represents a row permutation: $A' = PA$ means $A'(i, j) = A(p[i], j)$.

Template Parameters
IndexTypeprecision of permutation array indices.

Member Function Documentation

◆ compose()

template<typename IndexType = int32>
std::unique_ptr< Permutation > gko::matrix::Permutation< IndexType >::compose ( ptr_param< const Permutation< IndexType > > other) const

Composes this permutation with another permutation.

The resulting permutation fulfills result[i] = this[other[i]] or result = other * this from the matrix perspective, which is equivalent to first permuting by this and then by other: Combining permutations $P_1$ and $P_2$ with P = P_1.combine(P_2) performs the operation permute(A, P) = permute(permute(A, P_1), P_2).

Parameters
otherthe other permutation
Returns
the combined permutation

◆ compute_inverse()

template<typename IndexType = int32>
std::unique_ptr< Permutation > gko::matrix::Permutation< IndexType >::compute_inverse ( ) const

Returns the inverse permutation.

Returns
a newly created Permutation object storing the inverse permutation of this Permutation.

◆ create_const() [1/2]

template<typename IndexType = int32>
static std::unique_ptr< const Permutation > gko::matrix::Permutation< IndexType >::create_const ( std::shared_ptr< const Executor > exec,
gko::detail::const_array_view< IndexType > && perm_idxs )
static

Creates a constant (immutable) Permutation matrix from a constant array.

Parameters
execthe executor to create the matrix on
sizethe size of the square matrix
perm_idxsthe permutation index array of the matrix
enabled_permutethe mask describing the type of permutation
Returns
A smart pointer to the constant matrix wrapping the input array (if it resides on the same executor as the matrix) or a copy of the array on the correct executor.

References gko::one().

◆ create_const() [2/2]

template<typename IndexType = int32>
static std::unique_ptr< const Permutation > gko::matrix::Permutation< IndexType >::create_const ( std::shared_ptr< const Executor > exec,
size_type size,
gko::detail::const_array_view< IndexType > && perm_idxs,
mask_type enabled_permute = row_permute )
static

Creates a constant (immutable) Permutation matrix from a constant array.

Parameters
execthe executor to create the matrix on
sizethe size of the square matrix
perm_idxsthe permutation index array of the matrix
enabled_permutethe mask describing the type of permutation
Returns
A smart pointer to the constant matrix wrapping the input array (if it resides on the same executor as the matrix) or a copy of the array on the correct executor.

◆ get_const_permutation()

template<typename IndexType = int32>
const index_type * gko::matrix::Permutation< IndexType >::get_const_permutation ( ) const
inlinenoexcept

Returns a pointer to the array of permutation.

Returns
the pointer to the row permutation array.
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 IndexType = int32>
index_type * gko::matrix::Permutation< IndexType >::get_permutation ( )
inlinenoexcept

Returns a pointer to the array of permutation.

Returns
the pointer to the row permutation array.

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

◆ get_permutation_size()

template<typename IndexType = int32>
size_type gko::matrix::Permutation< IndexType >::get_permutation_size ( ) const
noexcept

Returns the number of elements explicitly stored in the permutation array.

Returns
the number of elements explicitly stored in the permutation array.

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