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::Csr< ValueType, IndexType > Class Template Reference

CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matrix (compressed sparse row format). More...

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

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

Classes

class  automatical
 
class  classical
 classical is a strategy_type which uses the same number of threads on each row. More...
 
class  cusparse
 cusparse is a strategy_type which uses the sparselib csr. More...
 
class  load_balance
 load_balance is a strategy_type which uses the load balance algorithm. More...
 
class  merge_path
 merge_path is a strategy_type which uses the merge_path algorithm. More...
 
class  sparselib
 sparselib is a strategy_type which uses the sparselib csr. More...
 
class  strategy_type
 strategy_type is to decide how to set the csr algorithm. More...
 

Public Types

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

Public Member Functions

void convert_to (Csr< ValueType, IndexType > *result) const override
 
void move_to (Csr< ValueType, IndexType > *result) override
 
void convert_to (Csr< next_precision< ValueType >, IndexType > *result) const override
 
void move_to (Csr< next_precision< ValueType >, IndexType > *result) override
 
void convert_to (Dense< ValueType > *other) const override
 
void move_to (Dense< ValueType > *other) override
 
void convert_to (Coo< ValueType, IndexType > *result) const override
 
void move_to (Coo< ValueType, IndexType > *result) override
 
void convert_to (Ell< ValueType, IndexType > *result) const override
 
void move_to (Ell< ValueType, IndexType > *result) override
 
void convert_to (Hybrid< ValueType, IndexType > *result) const override
 
void move_to (Hybrid< ValueType, IndexType > *result) override
 
void convert_to (Sellp< ValueType, IndexType > *result) const override
 
void move_to (Sellp< ValueType, IndexType > *result) override
 
void convert_to (SparsityCsr< ValueType, IndexType > *result) const override
 
void move_to (SparsityCsr< ValueType, IndexType > *result) 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...
 
std::unique_ptr< LinOptranspose () const override
 Returns a LinOp representing the transpose of the Transposable object. More...
 
std::unique_ptr< LinOpconj_transpose () const override
 Returns a LinOp representing the conjugate transpose of the Transposable object. More...
 
std::unique_ptr< LinOprow_permute (const Array< IndexType > *permutation_indices) const override
 Returns a LinOp representing the row permutation of the Permutable object. More...
 
std::unique_ptr< LinOpcolumn_permute (const Array< IndexType > *permutation_indices) const override
 Returns a LinOp representing the column permutation of the Permutable object. More...
 
std::unique_ptr< LinOpinverse_row_permute (const Array< IndexType > *inverse_permutation_indices) const override
 Returns a LinOp representing the row permutation of the inverse permuted object. More...
 
std::unique_ptr< LinOpinverse_column_permute (const Array< IndexType > *inverse_permutation_indices) const override
 Returns a LinOp representing the row permutation of the inverse permuted object. More...
 
void sort_by_column_index ()
 Sorts all (value, col_idx) pairs in each row by column index.
 
bool is_sorted_by_column_index () const
 
value_type * get_values () noexcept
 Returns the values of the matrix. More...
 
const value_type * get_const_values () const noexcept
 Returns the values of the matrix. More...
 
index_type * get_col_idxs () noexcept
 Returns the column indexes of the matrix. More...
 
const index_type * get_const_col_idxs () const noexcept
 Returns the column indexes of the matrix. More...
 
index_type * get_row_ptrs () noexcept
 Returns the row pointers of the matrix. More...
 
const index_type * get_const_row_ptrs () const noexcept
 Returns the row pointers of the matrix. More...
 
index_type * get_srow () noexcept
 Returns the starting rows. More...
 
const index_type * get_const_srow () const noexcept
 Returns the starting rows. More...
 
size_type get_num_srow_elements () const noexcept
 Returns the number of the srow stored elements (involved warps) 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...
 
void set_strategy (std::shared_ptr< strategy_type > strategy)
 Set the strategy. More...
 
- Public Member Functions inherited from gko::EnableLinOp< Csr< ValueType, IndexType > >
const Csr< ValueType, IndexType > * apply (const LinOp *b, LinOp *x) const
 
Csr< ValueType, IndexType > * apply (const LinOp *b, LinOp *x)
 
const Csr< ValueType, IndexType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 
Csr< ValueType, IndexType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Csr< ValueType, IndexType >, LinOp >
std::unique_ptr< Csr< ValueType, IndexType > > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Csr< ValueType, IndexType > > create_default () const
 
std::unique_ptr< Csr< ValueType, IndexType > > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Csr< ValueType, IndexType > > clone () const
 
Csr< ValueType, IndexType > * copy_from (const PolymorphicObject *other)
 
Csr< ValueType, IndexType > * copy_from (std::unique_ptr< PolymorphicObject > other)
 
Csr< 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< Csr< 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< Csr< 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< Coo< 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< Ell< 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< Hybrid< 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< Sellp< 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< SparsityCsr< 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< Csr >
 
class EnablePolymorphicObject< Csr, LinOp >
 
class Coo< ValueType, IndexType >
 
class Dense< ValueType >
 
class Ell< ValueType, IndexType >
 
class Hybrid< ValueType, IndexType >
 
class Sellp< ValueType, IndexType >
 
class SparsityCsr< ValueType, IndexType >
 
class CsrBuilder< ValueType, IndexType >
 
class Csr< next_precision< ValueType >, IndexType >
 

Additional Inherited Members

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

Detailed Description

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

CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matrix (compressed sparse row format).

The nonzero elements are stored in a 1D array row-wise, and accompanied with a row pointer array which stores the starting index of each row. An additional column index array is used to identify the column of each nonzero element.

The Csr LinOp supports different operations:

matrix::Csr *A, *B, *C; // matrices
matrix::Dense *b, *x; // vectors tall-and-skinny matrices
matrix::Dense *alpha, *beta; // scalars of dimension 1x1
matrix::Identity *I; // identity matrix
// Applying to Dense matrices computes an SpMV/SpMM product
A->apply(b, x) // x = A*b
A->apply(alpha, b, beta, x) // x = alpha*A*b + beta*x
// Applying to Csr matrices computes a SpGEMM product of two sparse matrices
A->apply(B, C) // C = A*B
A->apply(alpha, B, beta, C) // C = alpha*A*B + beta*C
// Applying to an Identity matrix computes a SpGEAM sparse matrix addition
A->apply(alpha, I, beta, B) // B = alpha*A + beta*B

Both the SpGEMM and SpGEAM operation require the input matrices to be sorted by column index, otherwise the algorithms will produce incorrect results.

Template Parameters
ValueTypeprecision of matrix elements
IndexTypeprecision of matrix indexes

Member Function Documentation

◆ column_permute()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<LinOp> gko::matrix::Csr< ValueType, IndexType >::column_permute ( const Array< IndexType > *  permutation_indices) const
overridevirtual

Returns a LinOp representing the column permutation of the Permutable object.

Parameters
permutation_indicesthe array of indices contaning the permutation order.
Returns
a pointer to the new column permuted object

Implements gko::Permutable< IndexType >.

◆ conj_transpose()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<LinOp> gko::matrix::Csr< ValueType, IndexType >::conj_transpose ( ) const
overridevirtual

Returns a LinOp representing the conjugate transpose of the Transposable object.

Returns
a pointer to the new conjugate transposed object

Implements gko::Transposable.

◆ get_col_idxs()

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

Returns the column indexes of the matrix.

Returns
the column indexes of the matrix.

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

◆ get_const_col_idxs()

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

Returns the column indexes of the matrix.

Returns
the column indexes of the matrix.
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_row_ptrs()

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

Returns the row pointers of the matrix.

Returns
the row pointers of the matrix.
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_srow()

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

Returns the starting rows.

Returns
the starting rows.
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_values()

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

Returns the values of the matrix.

Returns
the values of the matrix.
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_num_srow_elements()

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

Returns the number of the srow stored elements (involved warps)

Returns
the number of the srow stored elements (involved warps)

References gko::Array< ValueType >::get_num_elems().

◆ get_num_stored_elements()

template<typename ValueType = default_precision, typename IndexType = int32>
size_type gko::matrix::Csr< 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

References gko::Array< ValueType >::get_num_elems().

◆ get_row_ptrs()

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

Returns the row pointers of the matrix.

Returns
the row pointers of the matrix.

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

◆ get_srow()

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

Returns the starting rows.

Returns
the starting rows.

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

◆ get_strategy()

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

Returns the strategy.

Returns
the strategy

◆ get_values()

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

Returns the values of the matrix.

Returns
the values of the matrix.

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

◆ inverse_column_permute()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<LinOp> gko::matrix::Csr< ValueType, IndexType >::inverse_column_permute ( const Array< IndexType > *  inverse_permutation_indices) const
overridevirtual

Returns a LinOp representing the row permutation of the inverse permuted object.

Parameters
inverse_permutation_indicesthe array of indices contaning the inverse permutation order.
Returns
a pointer to the new inverse permuted object

Implements gko::Permutable< IndexType >.

◆ inverse_row_permute()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<LinOp> gko::matrix::Csr< ValueType, IndexType >::inverse_row_permute ( const Array< IndexType > *  inverse_permutation_indices) const
overridevirtual

Returns a LinOp representing the row permutation of the inverse permuted object.

Parameters
inverse_permutation_indicesthe array of indices contaning the inverse permutation order.
Returns
a pointer to the new inverse permuted object

Implements gko::Permutable< IndexType >.

◆ read()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::Csr< 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 >.

◆ row_permute()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<LinOp> gko::matrix::Csr< ValueType, IndexType >::row_permute ( const Array< IndexType > *  permutation_indices) const
overridevirtual

Returns a LinOp representing the row permutation of the Permutable object.

Parameters
permutation_indicesthe array of indices contaning the permutation order.
Returns
a pointer to the new permuted object

Implements gko::Permutable< IndexType >.

◆ set_strategy()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::Csr< ValueType, IndexType >::set_strategy ( std::shared_ptr< strategy_type strategy)
inline

Set the strategy.

Parameters
strategythe csr strategy

◆ transpose()

template<typename ValueType = default_precision, typename IndexType = int32>
std::unique_ptr<LinOp> gko::matrix::Csr< ValueType, IndexType >::transpose ( ) const
overridevirtual

Returns a LinOp representing the transpose of the Transposable object.

Returns
a pointer to the new transposed object

Implements gko::Transposable.

◆ write()

template<typename ValueType = default_precision, typename IndexType = int32>
void gko::matrix::Csr< 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: