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

class	cusparse

class	load_balance

class	merge_path

class	strategy_type

Public Types
using	value_type = ValueType

using	index_type = 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< 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< Sellp< ValueType, IndexType > >
using	result_type = Sellp< ValueType, IndexType >

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

Public Member Functions
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 (Sellp< ValueType, IndexType > *result) const override

void	move_to (Sellp< ValueType, IndexType > *result) override

void	convert_to (Ell< ValueType, IndexType > *result) const override

void	move_to (Ell< 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< LinOp >	transpose () const override
	Returns a LinOp representing the transpose of the Transposable object. More...

std::unique_ptr< LinOp >	conj_transpose () const override
	Returns a LinOp representing the conjugate transpose of the Transposable object. More...

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_type >	get_strategy () const noexcept
	Returns 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
LinOp *	apply (const LinOp b, LinOp x)
	Applies a linear operator to a vector (or a sequence of vectors). More...

const LinOp *	apply (const LinOp b, LinOp x) const
	Applies a linear operator to a vector (or a sequence of vectors). More...

LinOp *	apply (const LinOp alpha, const LinOp b, const LinOp beta, LinOp x)
	Performs the operation x = alpha * op(b) + beta * x. More...

const LinOp *	apply (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...

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)

LinOp *	copy_from (std::unique_ptr< 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...

PolymorphicObject *	copy_from (std::unique_ptr< 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
	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< 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< 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< 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...

Friends
class	EnableCreateMethod< Csr >

class	EnablePolymorphicObject< Csr, LinOp >

class	Coo< ValueType, IndexType >

class	Dense< ValueType >

class	Sellp< ValueType, IndexType >

class	Ell< 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.

Template Parameters

ValueType	precision of matrix elements
IndexType	precision of matrix indexes

Member Function Documentation

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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.

◆ 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)

◆ 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

◆ 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.

◆ 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.

◆ 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

References gko::LinOp::get_size().

◆ 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.

◆ 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

data	the matrix_data structure

Implements gko::ReadableFromMatrixData< ValueType, IndexType >.

◆ 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

data	the matrix_data structure

Implements gko::WritableToMatrixData< ValueType, IndexType >.

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

ginkgo/core/matrix/coo.hpp (5545d209)
ginkgo/core/matrix/csr.hpp (8045ac75)

Classes

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

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

Member Function Documentation

◆ conj_transpose()

◆ get_col_idxs()

◆ get_const_col_idxs()

◆ get_const_row_ptrs()

◆ get_const_srow()

◆ get_const_values()

◆ get_num_srow_elements()

◆ get_num_stored_elements()

◆ get_row_ptrs()

◆ get_srow()

◆ get_strategy()

◆ get_values()

◆ read()

◆ transpose()

◆ write()

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