Ginkgo  Generated from pipelines/164546034 branch based on develop. Ginkgo version 1.2.0
A numerical linear algebra library targeting many-core architectures
Classes | Public Types | Public Member Functions | Friends | List of all members
gko::matrix::Hybrid< ValueType, IndexType > Class Template Reference

HYBRID is a matrix format which splits the matrix into ELLPACK and COO format. More...

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

Collaboration diagram for gko::matrix::Hybrid< ValueType, IndexType >:
[legend]

Classes

class  automatic
 automatic is a strategy_type which decides the number of stored elements per row of the ell part automatically. More...
 
class  column_limit
 column_limit is a strategy_type which decides the number of stored elements per row of the ell part by specifying the number of columns. More...
 
class  imbalance_bounded_limit
 imbalance_bounded_limit is a strategy_type which decides the number of stored elements per row of the ell part. More...
 
class  imbalance_limit
 imbalance_limit is a strategy_type which decides the number of stored elements per row of the ell part according to the percent. More...
 
class  minimal_storage_limit
 minimal_storage_limit is a strategy_type which decides the number of stored elements per row of the ell part. More...
 
class  strategy_type
 strategy_type is to decide how to set the hybrid config. More...
 

Public Types

using value_type = ValueType
 
using index_type = IndexType
 
using mat_data = matrix_data< ValueType, IndexType >
 
using coo_type = Coo< ValueType, IndexType >
 
using ell_type = Ell< ValueType, IndexType >
 
- Public Types inherited from gko::EnablePolymorphicAssignment< Hybrid< ValueType, IndexType > >
using result_type = Hybrid< ValueType, IndexType >
 
- Public Types inherited from gko::ConvertibleTo< Hybrid< ValueType, IndexType > >
using result_type = Hybrid< ValueType, IndexType >
 
- Public Types inherited from gko::ConvertibleTo< Hybrid< next_precision< ValueType >, IndexType > >
using result_type = Hybrid< next_precision< ValueType >, IndexType >
 
- Public Types inherited from gko::ConvertibleTo< Dense< ValueType > >
using result_type = Dense< ValueType >
 
- Public Types inherited from gko::ConvertibleTo< Csr< ValueType, IndexType > >
using result_type = Csr< ValueType, IndexType >
 

Public Member Functions

void convert_to (Hybrid< next_precision< ValueType >, IndexType > *result) const override
 
void move_to (Hybrid< next_precision< ValueType >, IndexType > *result) override
 
void convert_to (Dense< ValueType > *other) const override
 
void move_to (Dense< ValueType > *other) override
 
void convert_to (Csr< ValueType, IndexType > *other) const override
 
void move_to (Csr< ValueType, IndexType > *other) override
 
void read (const mat_data &data) override
 Reads a matrix from a matrix_data structure. More...
 
void write (mat_data &data) const override
 Writes a matrix to a matrix_data structure. More...
 
value_type * get_ell_values () noexcept
 Returns the values of the ell part. More...
 
const value_type * get_const_ell_values () const noexcept
 Returns the values of the ell part. More...
 
index_type * get_ell_col_idxs () noexcept
 Returns the column indexes of the ell part. More...
 
const index_type * get_const_ell_col_idxs () const noexcept
 Returns the column indexes of the ell part. More...
 
size_type get_ell_num_stored_elements_per_row () const noexcept
 Returns the number of stored elements per row of ell part. More...
 
size_type get_ell_stride () const noexcept
 Returns the stride of the ell part. More...
 
size_type get_ell_num_stored_elements () const noexcept
 Returns the number of elements explicitly stored in the ell part. More...
 
value_type & ell_val_at (size_type row, size_type idx) noexcept
 Returns the idx-th non-zero element of the row-th row in the ell part. More...
 
value_type ell_val_at (size_type row, size_type idx) const noexcept
 Returns the idx-th non-zero element of the row-th row in the ell part. More...
 
index_type & ell_col_at (size_type row, size_type idx) noexcept
 Returns the idx-th column index of the row-th row in the ell part. More...
 
index_type ell_col_at (size_type row, size_type idx) const noexcept
 Returns the idx-th column index of the row-th row in the ell part. More...
 
const ell_typeget_ell () const noexcept
 Returns the matrix of the ell part. More...
 
value_type * get_coo_values () noexcept
 Returns the values of the coo part. More...
 
const value_type * get_const_coo_values () const noexcept
 Returns the values of the coo part. More...
 
index_type * get_coo_col_idxs () noexcept
 Returns the column indexes of the coo part. More...
 
const index_type * get_const_coo_col_idxs () const noexcept
 Returns the column indexes of the coo part. More...
 
index_type * get_coo_row_idxs () noexcept
 Returns the row indexes of the coo part. More...
 
const index_type * get_const_coo_row_idxs () const noexcept
 Returns the row indexes of the coo part. More...
 
size_type get_coo_num_stored_elements () const noexcept
 Returns the number of elements explicitly stored in the coo part. More...
 
const coo_typeget_coo () const noexcept
 Returns the matrix of the coo part. More...
 
size_type get_num_stored_elements () const noexcept
 Returns the number of elements explicitly stored in the matrix. More...
 
std::shared_ptr< strategy_typeget_strategy () const noexcept
 Returns the strategy. More...
 
Hybridoperator= (const Hybrid &other)
 Copies data from another Hybrid. More...
 
- Public Member Functions inherited from gko::EnableLinOp< Hybrid< ValueType, IndexType > >
const Hybrid< ValueType, IndexType > * apply (const LinOp *b, LinOp *x) const
 
Hybrid< ValueType, IndexType > * apply (const LinOp *b, LinOp *x)
 
const Hybrid< ValueType, IndexType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 
Hybrid< ValueType, IndexType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Hybrid< ValueType, IndexType >, LinOp >
std::unique_ptr< Hybrid< ValueType, IndexType > > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Hybrid< ValueType, IndexType > > create_default () const
 
std::unique_ptr< Hybrid< ValueType, IndexType > > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Hybrid< ValueType, IndexType > > clone () const
 
Hybrid< ValueType, IndexType > * copy_from (const PolymorphicObject *other)
 
Hybrid< ValueType, IndexType > * copy_from (std::unique_ptr< PolymorphicObject > other)
 
Hybrid< ValueType, IndexType > * clear ()
 
- Public Member Functions inherited from gko::LinOp
LinOpapply (const LinOp *b, LinOp *x)
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
const LinOpapply (const LinOp *b, LinOp *x) const
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
LinOpapply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 Performs the operation x = alpha * op(b) + beta * x. More...
 
const LinOpapply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 Performs the operation x = alpha * op(b) + beta * x. More...
 
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...
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOpcreate_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpcreate_default () const
 
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpclone () const
 
LinOpcopy_from (const PolymorphicObject *other)
 
LinOpcopy_from (std::unique_ptr< PolymorphicObject > other)
 
LinOpclear ()
 
- 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. More...
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object. More...
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object. More...
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object. More...
 
PolymorphicObjectcopy_from (std::unique_ptr< PolymorphicObject > other)
 Moves another object into this object. More...
 
PolymorphicObjectclear ()
 Transforms the object into its default state. More...
 
std::shared_ptr< const Executorget_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
 Adds a new logger to the list of subscribed loggers. More...
 
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers. More...
 
- Public Member Functions inherited from gko::EnablePolymorphicAssignment< Hybrid< 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< Hybrid< next_precision< ValueType >, IndexType > >
virtual void convert_to (result_type *result) const=0
 Converts the implementer to an object of type result_type. More...
 
virtual void move_to (result_type *result)=0
 Converts the implementer to an object of type result_type by moving data from this object. More...
 
- Public Member Functions inherited from gko::ConvertibleTo< Dense< ValueType > >
virtual void convert_to (result_type *result) const=0
 Converts the implementer to an object of type result_type. More...
 
virtual void move_to (result_type *result)=0
 Converts the implementer to an object of type result_type by moving data from this object. More...
 
- Public Member Functions inherited from gko::ConvertibleTo< Csr< ValueType, IndexType > >
virtual void convert_to (result_type *result) const=0
 Converts the implementer to an object of type result_type. More...
 
virtual void move_to (result_type *result)=0
 Converts the implementer to an object of type result_type by moving data from this object. More...
 

Friends

class EnableCreateMethod< Hybrid >
 
class EnablePolymorphicObject< Hybrid, LinOp >
 
class Dense< ValueType >
 
class Csr< ValueType, IndexType >
 
class Hybrid< next_precision< ValueType >, IndexType >
 

Additional Inherited Members

- Static Public Member Functions inherited from gko::EnableCreateMethod< Hybrid< ValueType, IndexType > >
static std::unique_ptr< Hybrid< ValueType, IndexType > > create (Args &&... args)
 

Detailed Description

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

HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.

Achieve the excellent performance with a proper partition of ELLPACK and COO.

Template Parameters
ValueTypeprecision of matrix elements
IndexTypeprecision of matrix indexes

Member Function Documentation

◆ ell_col_at() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>
index_type gko::matrix::Hybrid< ValueType, IndexType >::ell_col_at ( size_type  row,
size_type  idx 
) const
inlinenoexcept

Returns the idx-th column index of the row-th row in the ell part.

Parameters
rowthe row of the requested element
idxthe idx-th stored element of the row
Note
the method has to be called on the same Executor the matrix is stored at (e.g. trying to call this method on a GPU matrix from the OMP results in a runtime error)

◆ ell_col_at() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>
index_type& gko::matrix::Hybrid< ValueType, IndexType >::ell_col_at ( size_type  row,
size_type  idx 
)
inlinenoexcept

Returns the idx-th column index of the row-th row in the ell part.

Parameters
rowthe row of the requested element
idxthe idx-th stored element of the row
Note
the method has to be called on the same Executor the matrix is stored at (e.g. trying to call this method on a GPU matrix from the OMP results in a runtime error)

◆ ell_val_at() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>
value_type gko::matrix::Hybrid< ValueType, IndexType >::ell_val_at ( size_type  row,
size_type  idx 
) const
inlinenoexcept

Returns the idx-th non-zero element of the row-th row in the ell part.

Parameters
rowthe row of the requested element
idxthe idx-th stored element of the row
Note
the method has to be called on the same Executor the matrix is stored at (e.g. trying to call this method on a GPU matrix from the OMP results in a runtime error)

◆ ell_val_at() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>
value_type& gko::matrix::Hybrid< ValueType, IndexType >::ell_val_at ( size_type  row,
size_type  idx 
)
inlinenoexcept

Returns the idx-th non-zero element of the row-th row in the ell part.

Parameters
rowthe row of the requested element
idxthe idx-th stored element of the row
Note
the method has to be called on the same Executor the matrix is stored at (e.g. trying to call this method on a GPU matrix from the OMP results in a runtime error)

◆ get_const_coo_col_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>
const index_type* gko::matrix::Hybrid< ValueType, IndexType >::get_const_coo_col_idxs ( ) const
inlinenoexcept

Returns the column indexes of the coo part.

Returns
the column indexes of the coo part.
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.

◆ get_const_coo_row_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>
const index_type* gko::matrix::Hybrid< ValueType, IndexType >::get_const_coo_row_idxs ( ) const
inlinenoexcept

Returns the row indexes of the coo part.

Returns
the row indexes of the coo part.
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.

◆ get_const_coo_values()

template<typename ValueType = default_precision, typename IndexType = int32>
const value_type* gko::matrix::Hybrid< ValueType, IndexType >::get_const_coo_values ( ) const
inlinenoexcept

Returns the values of the coo part.

Returns
the values of the coo part.
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.

◆ get_const_ell_col_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>
const index_type* gko::matrix::Hybrid< ValueType, IndexType >::get_const_ell_col_idxs ( ) const
inlinenoexcept

Returns the column indexes of the ell part.

Returns
the column indexes of the ell part
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.

◆ get_const_ell_values()

template<typename ValueType = default_precision, typename IndexType = int32>
const value_type* gko::matrix::Hybrid< ValueType, IndexType >::get_const_ell_values ( ) const
inlinenoexcept

Returns the values of the ell part.

Returns
the values of the ell part
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.

◆ get_coo()

template<typename ValueType = default_precision, typename IndexType = int32>
const coo_type* gko::matrix::Hybrid< ValueType, IndexType >::get_coo ( ) const
inlinenoexcept

Returns the matrix of the coo part.

Returns
the matrix of the coo part

◆ get_coo_col_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>
index_type* gko::matrix::Hybrid< ValueType, IndexType >::get_coo_col_idxs ( )
inlinenoexcept

Returns the column indexes of the coo part.

Returns
the column indexes of the coo part.

◆ get_coo_num_stored_elements()

template<typename ValueType = default_precision, typename IndexType = int32>
size_type gko::matrix::Hybrid< ValueType, IndexType >::get_coo_num_stored_elements ( ) const
inlinenoexcept

Returns the number of elements explicitly stored in the coo part.

Returns
the number of elements explicitly stored in the coo part

◆ get_coo_row_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>
index_type* gko::matrix::Hybrid< ValueType, IndexType >::get_coo_row_idxs ( )
inlinenoexcept

Returns the row indexes of the coo part.

Returns
the row indexes of the coo part.

◆ get_coo_values()

template<typename ValueType = default_precision, typename IndexType = int32>
value_type* gko::matrix::Hybrid< ValueType, IndexType >::get_coo_values ( )
inlinenoexcept

Returns the values of the coo part.

Returns
the values of the coo part.

◆ get_ell()

template<typename ValueType = default_precision, typename IndexType = int32>
const ell_type* gko::matrix::Hybrid< ValueType, IndexType >::get_ell ( ) const
inlinenoexcept

Returns the matrix of the ell part.

Returns
the matrix of the ell part

◆ get_ell_col_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>
index_type* gko::matrix::Hybrid< ValueType, IndexType >::get_ell_col_idxs ( )
inlinenoexcept

Returns the column indexes of the ell part.

Returns
the column indexes of the ell part

◆ get_ell_num_stored_elements()

template<typename ValueType = default_precision, typename IndexType = int32>
size_type gko::matrix::Hybrid< ValueType, IndexType >::get_ell_num_stored_elements ( ) const
inlinenoexcept

Returns the number of elements explicitly stored in the ell part.

Returns
the number of elements explicitly stored in the ell part

◆ get_ell_num_stored_elements_per_row()

template<typename ValueType = default_precision, typename IndexType = int32>
size_type gko::matrix::Hybrid< ValueType, IndexType >::get_ell_num_stored_elements_per_row ( ) const
inlinenoexcept

Returns the number of stored elements per row of ell part.

Returns
the number of stored elements per row of ell part

◆ get_ell_stride()

template<typename ValueType = default_precision, typename IndexType = int32>
size_type gko::matrix::Hybrid< ValueType, IndexType >::get_ell_stride ( ) const
inlinenoexcept

Returns the stride of the ell part.

Returns
the stride of the ell part

◆ get_ell_values()

template<typename ValueType = default_precision, typename IndexType = int32>
value_type* gko::matrix::Hybrid< ValueType, IndexType >::get_ell_values ( )
inlinenoexcept

Returns the values of the ell part.

Returns
the values of the ell part

◆ get_num_stored_elements()

template<typename ValueType = default_precision, typename IndexType = int32>
size_type gko::matrix::Hybrid< ValueType, IndexType >::get_num_stored_elements ( ) const
inlinenoexcept

Returns the number of elements explicitly stored in the matrix.

Returns
the number of elements explicitly stored in the matrix

◆ get_strategy()

template<typename ValueType = default_precision, typename IndexType = int32>
std::shared_ptr<strategy_type> gko::matrix::Hybrid< ValueType, IndexType >::get_strategy ( ) const
inlinenoexcept

Returns the strategy.

Returns
the strategy

◆ operator=()

template<typename ValueType = default_precision, typename IndexType = int32>
Hybrid& gko::matrix::Hybrid< ValueType, IndexType >::operator= ( const Hybrid< ValueType, IndexType > &  other)
inline

Copies data from another Hybrid.

Parameters
otherthe Hybrid to copy from
Returns
this

◆ read()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::Hybrid< ValueType, IndexType >::read ( const mat_data data)
overridevirtual

Reads a matrix from a matrix_data structure.

Parameters
datathe matrix_data structure

Implements gko::ReadableFromMatrixData< ValueType, IndexType >.

◆ write()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::Hybrid< ValueType, IndexType >::write ( mat_data 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 files: