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

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

Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
using	result_type = ConcreteLinOp

Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

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< AbsoluteLinOp >
using	absolute_type = AbsoluteLinOp

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

void	move_to (Sellp< next_precision< 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

void	read (const device_mat_data &data) override

void	read (device_mat_data &&data) override

void	write (mat_data &data) const override

std::unique_ptr< Diagonal< ValueType > >	extract_diagonal () const override

std::unique_ptr< absolute_type >	compute_absolute () const override

void	compute_absolute_inplace () override

value_type *	get_values () noexcept

const value_type *	get_const_values () const noexcept

index_type *	get_col_idxs () noexcept

const index_type *	get_const_col_idxs () const noexcept

size_type *	get_slice_lengths () noexcept

const size_type *	get_const_slice_lengths () const noexcept

size_type *	get_slice_sets () noexcept

const size_type *	get_const_slice_sets () const noexcept

size_type	get_slice_size () const noexcept

size_type	get_stride_factor () const noexcept

size_type	get_total_cols () const noexcept

size_type	get_num_stored_elements () const noexcept

value_type &	val_at (size_type row, size_type slice_set, size_type idx) noexcept

value_type	val_at (size_type row, size_type slice_set, size_type idx) const noexcept

index_type &	col_at (size_type row, size_type slice_set, size_type idx) noexcept

index_type	col_at (size_type row, size_type slice_set, size_type idx) const noexcept

Sellp &	operator= (const Sellp &)

Sellp &	operator= (Sellp &&)

	Sellp (const Sellp &)

	Sellp (Sellp &&)

Public Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
const ConcreteLinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

ConcreteLinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const ConcreteLinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

ConcreteLinOp *	apply (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< AbstractObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	create_default () const

std::unique_ptr< AbstractObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	clone () const

AbstractObject *	copy_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)

AbstractObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

AbstractObject *	move_from (ptr_param< PolymorphicObject > other)

AbstractObject *	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

std::unique_ptr< PolymorphicObject >	create_default () const

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

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)

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)

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

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::EnablePolymorphicAssignment< ConcreteLinOp >
void	convert_to (result_type *result) const override

void	move_to (result_type *result) override

Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void	convert_to (result_type *result) const =0

void	convert_to (ptr_param< result_type > result) const

virtual void	move_to (result_type *result)=0

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

Public Member Functions inherited from gko::ReadableFromMatrixData< ValueType, IndexType >
void	read (const matrix_assembly_data< ValueType, IndexType > &data)

Public Member Functions inherited from gko::EnableAbsoluteComputation< AbsoluteLinOp >
std::unique_ptr< LinOp >	compute_absolute_linop () const override

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)

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)

Protected Member Functions
	Sellp (std::shared_ptr< const Executor > exec, const dim< 2 > &size={}, size_type total_cols={})

	Sellp (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type slice_size, size_type stride_factor, size_type total_cols)

void	apply_impl (const LinOp b, LinOp x) const override

void	apply_impl (const LinOp alpha, const LinOp b, const LinOp beta, LinOp x) const override

size_type	linearize_index (size_type row, size_type slice_set, size_type col) const noexcept

Protected Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
ConcreteLinOp *	self () noexcept

const ConcreteLinOp *	self () const noexcept

Protected Member Functions inherited from gko::EnablePolymorphicObject< ConcreteObject, PolymorphicBase >
std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const override

PolymorphicObject *	copy_from_impl (const PolymorphicObject *other) override

PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	move_from_impl (PolymorphicObject *other) override

PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	clear_impl () override

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Friends
class	EnablePolymorphicObject< Sellp, LinOp >

class	Dense< ValueType >

class	Csr< ValueType, IndexType >

class	Sellp< to_complex< ValueType >, IndexType >

class	Sellp< previous_precision< ValueType >, IndexType >

class	Sellp< previous_precision< previous_precision< ValueType > >, IndexType >

Additional Inherited Members
Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

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

◆ compute_absolute_inplace()

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

void gko::matrix::Sellp< ValueType, IndexType >::compute_absolute_inplace ( )

overridevirtual

Compute absolute inplace on each element.

Implements gko::AbsoluteComputable.

◆ 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

Sellp< ValueType, IndexType > Class Template Reference

Sellp< ValueType, IndexType > Class Template Reference#

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Sellp() [1/2]

◆ Sellp() [2/2]

Member Function Documentation

◆ col_at() [1/2]

◆ col_at() [2/2]

◆ compute_absolute()

◆ compute_absolute_inplace()

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

Sellp< ValueType, IndexType > Class Template Reference

Sellp&lt; ValueType, IndexType &gt; Class Template Reference#

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Sellp() [1/2]

◆ Sellp() [2/2]

Member Function Documentation

◆ col_at() [1/2]

◆ col_at() [2/2]

◆ compute_absolute()

◆ compute_absolute_inplace()

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

Sellp< ValueType, IndexType > Class Template Reference#