SELL-P is a matrix format similar to ELL format. More...

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

Inheritance diagram for gko::matrix::Sellp< ValueType, IndexType >:

Collaboration diagram for gko::matrix::Sellp< ValueType, IndexType >:

Public Types
using	value_type = ValueType

using	index_type = IndexType

using	mat_data = matrix_data< ValueType, IndexType >

using	device_mat_data = device_matrix_data< ValueType, IndexType >

using	absolute_type = remove_complex< Sellp >

using	device_view = matrix::view::sellp< value_type, index_type >

using	const_device_view = matrix::view::sellp< const value_type, const index_type >

Public Types inherited from gko::EnableCloneable< Sellp< ValueType, IndexType > >
using	result_type = Sellp< ValueType, IndexType >

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

Public Types inherited from gko::ConvertibleTo< Sellp< next_precision< ValueType >, IndexType > >
using	result_type = Sellp< 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 Types inherited from gko::DiagonalExtractable< ValueType >
using	value_type = ValueType

Public Types inherited from gko::ReadableFromMatrixData< ValueType, IndexType >
using	value_type = ValueType

using	index_type = IndexType

Public Types inherited from gko::WritableToMatrixData< ValueType, IndexType >
using	value_type = ValueType

using	index_type = IndexType

Public Types inherited from gko::EnableAbsoluteComputation< remove_complex< Sellp< ValueType, IndexType > > >
using	absolute_type = remove_complex< Sellp< ValueType, IndexType > >

Public Member Functions
void	convert_to (Sellp< next_precision< ValueType >, IndexType > *result) const override

void	move_to (Sellp< 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	read (const device_mat_data &data) override
	Reads a matrix from a device_matrix_data structure. More...

void	read (device_mat_data &&data) override
	Reads a matrix from a device_matrix_data structure. More...

void	write (mat_data &data) const override
	Writes a matrix to a matrix_data structure. More...

std::unique_ptr< Diagonal< ValueType > >	extract_diagonal () const override
	Extracts the diagonal entries of the matrix into a vector. More...

std::unique_ptr< absolute_type >	compute_absolute () const override
	Gets the AbsoluteLinOp. More...

void	compute_absolute_inplace () override
	Compute absolute inplace on each element.

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

size_type *	get_slice_lengths () noexcept
	Returns the lengths(columns) of slices. More...

const size_type *	get_const_slice_lengths () const noexcept
	Returns the lengths(columns) of slices. More...

size_type *	get_slice_sets () noexcept
	Returns the offsets of slices. More...

const size_type *	get_const_slice_sets () const noexcept
	Returns the offsets of slices. More...

size_type	get_slice_size () const noexcept
	Returns the size of a slice. More...

size_type	get_stride_factor () const noexcept
	Returns the stride factor(t) of SELL-P. More...

size_type	get_total_cols () const noexcept
	Returns the total column number. More...

size_type	get_num_stored_elements () const noexcept
	Returns the number of elements explicitly stored in the matrix. More...

value_type &	val_at (size_type row, size_type slice_set, size_type idx) noexcept
	Returns the `idx`-th non-zero element of the `row`-th row with `slice_set` slice set. More...

value_type	val_at (size_type row, size_type slice_set, size_type idx) const noexcept
	Returns the `idx`-th non-zero element of the `row`-th row with `slice_set` slice set. More...

index_type &	col_at (size_type row, size_type slice_set, size_type idx) noexcept
	Returns the `idx`-th column index of the `row`-th row with `slice_set` slice set. More...

index_type	col_at (size_type row, size_type slice_set, size_type idx) const noexcept
	Returns the `idx`-th column index of the `row`-th row with `slice_set` slice set. More...

device_view	get_device_view ()
	get the non-owning device view

const_device_view	get_const_device_view () const
	get the const non-owning device view

Sellp &	operator= (const Sellp &)
	Copy-assigns a Sellp matrix. More...

Sellp &	operator= (Sellp &&)
	Move-assigns a Sellp matrix. More...

	Sellp (const Sellp &)
	Copy-assigns a Sellp matrix. More...

	Sellp (Sellp &&)
	Move-assigns a Sellp matrix. More...

Public Member Functions inherited from gko::LinOp
void	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
	Applies a linear operator to a vector (or a sequence of vectors). More...

void	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< 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...

LinOp &	operator= (const LinOp &)=default
	Copy-assigns a LinOp. More...

LinOp &	operator= (LinOp &&other)
	Move-assigns a LinOp. More...

	LinOp (const LinOp &)=default
	Copy-constructs a LinOp. More...

	LinOp (LinOp &&other)
	Move-constructs a LinOp. More...

Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)

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

void	remove_logger (const Logger *logger) override

void	remove_logger (ptr_param< const Logger > logger)

const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override

void	clear_loggers () override

Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Public Member Functions inherited from gko::EnableCloneable< Sellp< ValueType, IndexType > >
std::unique_ptr< Sellp< ValueType, IndexType > >	clone (std::shared_ptr< const Executor > exec) const
	Creates a clone of the object. More...

std::unique_ptr< Sellp< ValueType, IndexType > >	clone () const
	Creates a clone of the object. More...

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

std::unique_ptr< Sellp< ValueType, IndexType > >	create_default () const

std::unique_ptr< Sellp< ValueType, IndexType > >	create_default (std::shared_ptr< const Executor > exec) const

Public Member Functions inherited from gko::ConvertibleTo< Sellp< ValueType, IndexType > >
void	convert_to (ptr_param< result_type > result) const

void	move_to (ptr_param< result_type > result)

Public Member Functions inherited from gko::Cloneable
std::unique_ptr< Cloneable >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Cloneable >	clone () const

Cloneable *	copy_from (ptr_param< const Cloneable > other)

Cloneable *	move_from (ptr_param< Cloneable > other)

std::unique_ptr< Cloneable >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Cloneable >	create_default () const

Public Member Functions inherited from gko::ConvertibleTo< Sellp< next_precision< ValueType >, IndexType > >
virtual void	convert_to (result_type *result) const=0
	Converts the implementer to an object of type result_type. More...

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

void	move_to (ptr_param< result_type > result)

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

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

void	move_to (ptr_param< result_type > result)

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

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

void	move_to (ptr_param< result_type > result)

Public Member Functions inherited from gko::DiagonalExtractable< ValueType >
std::unique_ptr< LinOp >	extract_diagonal_linop () const override
	Extracts the diagonal entries of the matrix into a vector. More...

Public Member Functions inherited from gko::ReadableFromMatrixData< ValueType, IndexType >
void	read (const matrix_assembly_data< ValueType, IndexType > &data)
	Reads a matrix from a matrix_assembly_data structure. More...

Public Member Functions inherited from gko::EnableAbsoluteComputation< remove_complex< Sellp< ValueType, IndexType > > >
std::unique_ptr< LinOp >	compute_absolute_linop () const override
	Gets the absolute LinOp. More...

Static Public Member Functions
static std::unique_ptr< Sellp >	create (std::shared_ptr< const Executor > exec, const dim< 2 > &size={}, size_type total_cols=0)
	Creates an uninitialized Sellp matrix of the specified size. More...

static std::unique_ptr< Sellp >	create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type slice_size, size_type stride_factor, size_type total_cols)
	Creates an uninitialized Sellp matrix of the specified size. More...

Friends
class	EnableCloneable< Sellp >

class	Dense< ValueType >

class	Csr< ValueType, IndexType >

class	Sellp< to_complex< ValueType >, IndexType >

class	Sellp< previous_precision< ValueType >, IndexType >

Detailed Description

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

SELL-P is a matrix format similar to ELL format.

The difference is that SELL-P format divides rows into smaller slices and store each slice with ELL format.

This implementation uses the column index value invalid_index<IndexType>() to mark padding entries that are not part of the sparsity pattern.

Template Parameters

ValueType	precision of matrix elements
IndexType	precision of matrix indexes

Constructor & Destructor Documentation

◆ Sellp() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>

gko::matrix::Sellp< ValueType, IndexType >::Sellp ( const Sellp< ValueType, IndexType > & )

Copy-assigns a Sellp matrix.

Inherits the executor, copies the data and parameters.

◆ Sellp() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>

gko::matrix::Sellp< ValueType, IndexType >::Sellp ( Sellp< ValueType, IndexType > && )

Move-assigns a Sellp matrix.

Inherits the executor, moves the data and parameters. The moved-from object is empty (0x0 with valid slice_sets and unchanged parameters).

Member Function Documentation

◆ col_at() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>

index_type gko::matrix::Sellp< ValueType, IndexType >::col_at	(	size_type	row,
		size_type	slice_set,
		size_type	idx
	)		const

inlinenoexcept

Returns the idx-th column index of the row-th row with slice_set slice set.

Parameters

row	the row of the requested element in the slice
slice_set	the slice set of the slice
idx	the idx-th stored element of the row in the slice

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 CPU results in a runtime error)

◆ col_at() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>

index_type& gko::matrix::Sellp< ValueType, IndexType >::col_at	(	size_type	row,
		size_type	slice_set,
		size_type	idx
	)

inlinenoexcept

Returns the idx-th column index of the row-th row with slice_set slice set.

Parameters

row	the row of the requested element in the slice
slice_set	the slice set of the slice
idx	the idx-th stored element of the row in the slice

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 CPU results in a runtime error)

References gko::matrix::Sellp< ValueType, IndexType >::get_col_idxs().

◆ compute_absolute()

template<typename ValueType = default_precision, typename IndexType = int32>

std::unique_ptr<absolute_type> gko::matrix::Sellp< ValueType, IndexType >::compute_absolute ( ) const

overridevirtual

Gets the AbsoluteLinOp.

Returns: a pointer to the new absolute object

Implements gko::EnableAbsoluteComputation< remove_complex< Sellp< ValueType, IndexType > > >.

◆ create() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>

static std::unique_ptr<Sellp> gko::matrix::Sellp< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size,
		size_type	slice_size,
		size_type	stride_factor,
		size_type	total_cols
	)

static

Creates an uninitialized Sellp matrix of the specified size.

Parameters

exec	Executor associated to the matrix
size	size of the matrix
slice_size	number of rows in each slice
stride_factor	factor for the stride in each slice (strides should be multiples of the stride_factor)
total_cols	number of the sum of all cols in every slice.

Returns: A smart pointer to the newly created matrix.

◆ create() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>

static std::unique_ptr<Sellp> gko::matrix::Sellp< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size = `{}`,
		size_type	total_cols = `0`
	)

static

Creates an uninitialized Sellp matrix of the specified size.

(The slice_size and stride_factor are set to the default values.)

Parameters

exec	Executor associated to the matrix
size	size of the matrix
total_cols	number of the sum of all cols in every slice.

Returns: A smart pointer to the newly created matrix.

◆ extract_diagonal()

template<typename ValueType = default_precision, typename IndexType = int32>

std::unique_ptr<Diagonal<ValueType> > gko::matrix::Sellp< ValueType, IndexType >::extract_diagonal ( ) const

overridevirtual

Extracts the diagonal entries of the matrix into a vector.

Parameters

diag	the vector into which the diagonal will be written

Implements gko::DiagonalExtractable< ValueType >.

◆ get_col_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>

index_type* gko::matrix::Sellp< 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().

Referenced by gko::matrix::Sellp< ValueType, IndexType >::col_at().

◆ get_const_col_idxs()

template<typename ValueType = default_precision, typename IndexType = int32>

const index_type* gko::matrix::Sellp< 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_slice_lengths()

template<typename ValueType = default_precision, typename IndexType = int32>

const size_type* gko::matrix::Sellp< ValueType, IndexType >::get_const_slice_lengths ( ) const

inlinenoexcept

Returns the lengths(columns) of slices.

Returns: the lengths(columns) of slices.

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_slice_sets()

template<typename ValueType = default_precision, typename IndexType = int32>

const size_type* gko::matrix::Sellp< ValueType, IndexType >::get_const_slice_sets ( ) const

inlinenoexcept

Returns the offsets of slices.

Returns: the offsets of slices.

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::Sellp< 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_stored_elements()

template<typename ValueType = default_precision, typename IndexType = int32>

size_type gko::matrix::Sellp< 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_size().

◆ get_slice_lengths()

template<typename ValueType = default_precision, typename IndexType = int32>

size_type* gko::matrix::Sellp< ValueType, IndexType >::get_slice_lengths ( )

inlinenoexcept

Returns the lengths(columns) of slices.

Returns: the lengths(columns) of slices.

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

◆ get_slice_sets()

template<typename ValueType = default_precision, typename IndexType = int32>

size_type* gko::matrix::Sellp< ValueType, IndexType >::get_slice_sets ( )

inlinenoexcept

Returns the offsets of slices.

Returns: the offsets of slices.

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

◆ get_slice_size()

template<typename ValueType = default_precision, typename IndexType = int32>

size_type gko::matrix::Sellp< ValueType, IndexType >::get_slice_size ( ) const

inlinenoexcept

Returns the size of a slice.

Returns: the size of a slice.

◆ get_stride_factor()

template<typename ValueType = default_precision, typename IndexType = int32>

size_type gko::matrix::Sellp< ValueType, IndexType >::get_stride_factor ( ) const

inlinenoexcept

Returns the stride factor(t) of SELL-P.

Returns: the stride factor(t) of SELL-P.

◆ get_total_cols()

template<typename ValueType = default_precision, typename IndexType = int32>

size_type gko::matrix::Sellp< ValueType, IndexType >::get_total_cols ( ) const

inlinenoexcept

Returns the total column number.

Returns: the total column number.

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

◆ get_values()

template<typename ValueType = default_precision, typename IndexType = int32>

value_type* gko::matrix::Sellp< ValueType, IndexType >::get_values ( )

inlinenoexcept

Returns the values of the matrix.

Returns: the values of the matrix.

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

◆ operator=() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>

Sellp& gko::matrix::Sellp< ValueType, IndexType >::operator= ( const Sellp< ValueType, IndexType > & )

Copy-assigns a Sellp matrix.

Preserves the executor, copies the data and parameters.

◆ operator=() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>

Sellp& gko::matrix::Sellp< ValueType, IndexType >::operator= ( Sellp< ValueType, IndexType > && )

Move-assigns a Sellp matrix.

Preserves the executor, moves the data and parameters. The moved-from object is empty (0x0 with valid slice_sets and unchanged parameters).

◆ read() [1/3]

template<typename ValueType = default_precision, typename IndexType = int32>

void gko::matrix::Sellp< ValueType, IndexType >::read ( const device_mat_data & data )

overridevirtual

Reads a matrix from a device_matrix_data structure.

Parameters

data	the device_matrix_data structure.

Reimplemented from gko::ReadableFromMatrixData< ValueType, IndexType >.

◆ read() [2/3]

template<typename ValueType = default_precision, typename IndexType = int32>

void gko::matrix::Sellp< 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 >.

◆ read() [3/3]

template<typename ValueType = default_precision, typename IndexType = int32>

void gko::matrix::Sellp< ValueType, IndexType >::read ( device_mat_data && data )

overridevirtual

Reads a matrix from a device_matrix_data structure.

The structure may be emptied by this function.

Parameters

data	the device_matrix_data structure.

Reimplemented from gko::ReadableFromMatrixData< ValueType, IndexType >.

◆ val_at() [1/2]

template<typename ValueType = default_precision, typename IndexType = int32>

value_type gko::matrix::Sellp< ValueType, IndexType >::val_at	(	size_type	row,
		size_type	slice_set,
		size_type	idx
	)		const

inlinenoexcept

Returns the idx-th non-zero element of the row-th row with slice_set slice set.

Parameters

row	the row of the requested element in the slice
slice_set	the slice set of the slice
idx	the idx-th stored element of the row in the slice

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 CPU results in a runtime error)

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

◆ val_at() [2/2]

template<typename ValueType = default_precision, typename IndexType = int32>

value_type& gko::matrix::Sellp< ValueType, IndexType >::val_at	(	size_type	row,
		size_type	slice_set,
		size_type	idx
	)

inlinenoexcept

Returns the idx-th non-zero element of the row-th row with slice_set slice set.

Parameters

row	the row of the requested element in the slice
slice_set	the slice set of the slice
idx	the idx-th stored element of the row in the slice

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 CPU results in a runtime error)

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

◆ write()

template<typename ValueType = default_precision, typename IndexType = int32>

void gko::matrix::Sellp< 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/csr.hpp
ginkgo/core/matrix/sellp.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

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

Constructor & Destructor Documentation

◆ Sellp() [1/2]

◆ Sellp() [2/2]

Member Function Documentation

◆ col_at() [1/2]

◆ col_at() [2/2]

◆ compute_absolute()

◆ create() [1/2]

◆ create() [2/2]

◆ extract_diagonal()

◆ get_col_idxs()

◆ get_const_col_idxs()

◆ get_const_slice_lengths()

◆ get_const_slice_sets()

◆ get_const_values()

◆ get_num_stored_elements()

◆ get_slice_lengths()

◆ get_slice_sets()

◆ get_slice_size()

◆ get_stride_factor()

◆ get_total_cols()

◆ get_values()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ val_at() [1/2]

◆ val_at() [2/2]

◆ write()

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