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

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

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

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

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	device_mat_data = device_matrix_data< ValueType, IndexType >

using	coo_type = Coo< ValueType, IndexType >

using	ell_type = Ell< ValueType, IndexType >

using	absolute_type = remove_complex< Hybrid >

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 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< Hybrid< ValueType, IndexType > > >
using	absolute_type = remove_complex< Hybrid< 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	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_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_type *	get_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_type *	get_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_type >	get_strategy () const noexcept
	Returns the strategy. More...

template<typename HybType >
std::shared_ptr< typename HybType::strategy_type >	get_strategy () const
	Returns the current strategy allowed in given hybrid format. More...

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

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

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

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

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

Hybrid< ValueType, IndexType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const Hybrid< ValueType, IndexType > *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

Hybrid< ValueType, IndexType > *	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< 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)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Hybrid< ValueType, IndexType > > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Hybrid< ValueType, IndexType > > *	copy_from (const std::unique_ptr< Derived > &other)

Hybrid< ValueType, IndexType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

Hybrid< ValueType, IndexType > *	move_from (ptr_param< PolymorphicObject > other)

Hybrid< ValueType, IndexType > *	clear ()

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

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

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

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

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

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > *	copy_from (const std::unique_ptr< Derived > &other)

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

LinOp *	move_from (ptr_param< 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...

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)
	Moves another object into this object. More...

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)
	Copies another object into this object. More...

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
	Copies another object into this object. More...

PolymorphicObject *	move_from (ptr_param< 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

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

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< Hybrid< ValueType, IndexType > > >
std::unique_ptr< LinOp >	compute_absolute_linop () const override
	Gets the absolute LinOp. More...

Static Public Member Functions
static std::unique_ptr< Hybrid >	create (std::shared_ptr< const Executor > exec, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >())
	Creates an uninitialized Hybrid matrix of specified method. More...

static std::unique_ptr< Hybrid >	create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >())
	Creates an uninitialized Hybrid matrix of the specified size and method. More...

static std::unique_ptr< Hybrid >	create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type num_stored_elements_per_row, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >())
	Creates an uninitialized Hybrid matrix of the specified size and method. More...

static std::unique_ptr< Hybrid >	create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type num_stored_elements_per_row, size_type stride, std::shared_ptr< strategy_type > strategy)
	Creates an uninitialized Hybrid matrix of the specified size and method. More...

static std::unique_ptr< Hybrid >	create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type num_stored_elements_per_row, size_type stride, size_type num_nonzeros={}, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >())
	Creates an uninitialized Hybrid matrix of the specified size and method. More...

Friends
class	EnablePolymorphicObject< Hybrid, LinOp >

class	Dense< ValueType >

class	Csr< ValueType, IndexType >

class	Hybrid< to_complex< ValueType >, IndexType >

class	Hybrid< next_precision< ValueType >, IndexType >

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

ValueType	precision of matrix elements
IndexType	precision of matrix indexes

Constructor & Destructor Documentation

◆ Hybrid() [1/2]

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

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

Copy-assigns a Hybrid matrix.

Inherits the executor, copies the Ell and Coo matrices.

◆ Hybrid() [2/2]

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

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

Move-assigns a Hybrid matrix.

Inherits the executor, moves the Ell and Coo matrices. The moved-from matrix is empty (0x0 with empty Ell/Coo matrices).

Member Function Documentation

◆ compute_absolute()

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

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

overridevirtual

Gets the AbsoluteLinOp.

Returns: a pointer to the new absolute object

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

◆ create() [1/5]

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

static std::unique_ptr<Hybrid> gko::matrix::Hybrid< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size,
		size_type	num_stored_elements_per_row,
		size_type	stride,
		size_type	num_nonzeros = `{}`,
		std::shared_ptr< strategy_type >	strategy = `std::make_shared< automatic >()`
	)

static

Creates an uninitialized Hybrid matrix of the specified size and method.

Parameters

exec	Executor associated to the matrix
size	size of the matrix
num_stored_elements_per_row	the number of stored elements per row
stride	stride of the rows
num_nonzeros	number of nonzeros
strategy	strategy of deciding the Hybrid config

Returns: A smart pointer to the newly created matrix.

◆ create() [2/5]

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

static std::unique_ptr<Hybrid> gko::matrix::Hybrid< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size,
		size_type	num_stored_elements_per_row,
		size_type	stride,
		std::shared_ptr< strategy_type >	strategy
	)

static

Creates an uninitialized Hybrid matrix of the specified size and method.

Parameters

exec	Executor associated to the matrix
size	size of the matrix
num_stored_elements_per_row	the number of stored elements per row
stride	stride of the rows
strategy	strategy of deciding the Hybrid config

Returns: A smart pointer to the newly created matrix.

◆ create() [3/5]

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

static std::unique_ptr<Hybrid> gko::matrix::Hybrid< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size,
		size_type	num_stored_elements_per_row,
		std::shared_ptr< strategy_type >	strategy = `std::make_shared< automatic >()`
	)

static

Creates an uninitialized Hybrid matrix of the specified size and method.

(ell_stride is set to the number of rows of the matrix.)

Parameters

exec	Executor associated to the matrix
size	size of the matrix
num_stored_elements_per_row	the number of stroed elements per row
strategy	strategy of deciding the Hybrid config

Returns: A smart pointer to the newly created matrix.

◆ create() [4/5]

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

static std::unique_ptr<Hybrid> gko::matrix::Hybrid< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size,
		std::shared_ptr< strategy_type >	strategy = `std::make_shared< automatic >()`
	)

static

Creates an uninitialized Hybrid matrix of the specified size and method.

(ell_num_stored_elements_per_row is set to the number of cols of the matrix. ell_stride is set to the number of rows of the matrix.)

Parameters

exec	Executor associated to the matrix
size	size of the matrix
strategy	strategy of deciding the Hybrid config

Returns: A smart pointer to the newly created matrix.

◆ create() [5/5]

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

static std::unique_ptr<Hybrid> gko::matrix::Hybrid< ValueType, IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		std::shared_ptr< strategy_type >	strategy = `std::make_shared< automatic >()`
	)

static

Creates an uninitialized Hybrid matrix of specified method.

(ell_num_stored_elements_per_row is set to the number of cols of the matrix. ell_stride is set to the number of rows of the matrix.)

Parameters

exec	Executor associated to the matrix
strategy	strategy of deciding the Hybrid config

Returns: A smart pointer to the newly created matrix.

◆ 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

row	the row of the requested element
idx	the 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

row	the row of the requested element
idx	the 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

row	the row of the requested element
idx	the 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

row	the row of the requested element
idx	the 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)

◆ extract_diagonal()

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

std::unique_ptr<Diagonal<ValueType> > gko::matrix::Hybrid< 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_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() [1/2]

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

template<typename HybType >

std::shared_ptr<typename HybType::strategy_type> gko::matrix::Hybrid< ValueType, IndexType >::get_strategy ( ) const

Returns the current strategy allowed in given hybrid format.

Template Parameters

HybType hybrid type

Returns: the strategy

◆ get_strategy() [2/2]

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

std::shared_ptr< typename HybType::strategy_type > gko::matrix::Hybrid< ValueType, IndexType >::get_strategy ( ) const

inlinenoexcept

Returns the strategy.

Returns: the strategy

◆ operator=() [1/2]

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

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

Copy-assigns a Hybrid matrix.

Preserves the executor, copy-assigns the Ell and Coo matrices.

◆ operator=() [2/2]

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

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

Move-assigns a Hybrid matrix.

Preserves the executor, move-assigns the Ell and Coo matrices. The moved-from matrix is empty (0x0 with empty Ell/Coo matrices).

◆ read() [1/3]

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

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

◆ 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

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
ginkgo/core/matrix/hybrid.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

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

Constructor & Destructor Documentation

◆ Hybrid() [1/2]

◆ Hybrid() [2/2]

Member Function Documentation

◆ compute_absolute()

◆ create() [1/5]

◆ create() [2/5]

◆ create() [3/5]

◆ create() [4/5]

◆ create() [5/5]

◆ ell_col_at() [1/2]

◆ ell_col_at() [2/2]

◆ ell_val_at() [1/2]

◆ ell_val_at() [2/2]

◆ extract_diagonal()

◆ get_const_coo_col_idxs()

◆ get_const_coo_row_idxs()

◆ get_const_coo_values()

◆ get_const_ell_col_idxs()

◆ get_const_ell_values()

◆ get_coo()

◆ get_coo_col_idxs()

◆ get_coo_num_stored_elements()

◆ get_coo_row_idxs()

◆ get_coo_values()

◆ get_ell()

◆ get_ell_col_idxs()

◆ get_ell_num_stored_elements()

◆ get_ell_num_stored_elements_per_row()

◆ get_ell_stride()

◆ get_ell_values()

◆ get_num_stored_elements()

◆ get_strategy() [1/2]

◆ get_strategy() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ write()

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