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

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

Classes
class	automatic

class	column_limit

class	imbalance_bounded_limit

class	imbalance_limit

class	minimal_storage_limit

class	strategy_type

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

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

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

void	move_to (Hybrid< 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_ell_values () noexcept

const value_type *	get_const_ell_values () const noexcept

index_type *	get_ell_col_idxs () noexcept

const index_type *	get_const_ell_col_idxs () const noexcept

size_type	get_ell_num_stored_elements_per_row () const noexcept

size_type	get_ell_stride () const noexcept

size_type	get_ell_num_stored_elements () const noexcept

value_type &	ell_val_at (size_type row, size_type idx) noexcept

value_type	ell_val_at (size_type row, size_type idx) const noexcept

index_type &	ell_col_at (size_type row, size_type idx) noexcept

index_type	ell_col_at (size_type row, size_type idx) const noexcept

const ell_type *	get_ell () const noexcept

value_type *	get_coo_values () noexcept

const value_type *	get_const_coo_values () const noexcept

index_type *	get_coo_col_idxs () noexcept

const index_type *	get_const_coo_col_idxs () const noexcept

index_type *	get_coo_row_idxs () noexcept

const index_type *	get_const_coo_row_idxs () const noexcept

size_type	get_coo_num_stored_elements () const noexcept

const coo_type *	get_coo () const noexcept

size_type	get_num_stored_elements () const noexcept

std::shared_ptr< strategy_type >	get_strategy () const noexcept

template<typename HybType >
std::shared_ptr< typename HybType::strategy_type >	get_strategy () const

Hybrid &	operator= (const Hybrid &)

Hybrid &	operator= (Hybrid &&)

	Hybrid (const Hybrid &)

	Hybrid (Hybrid &&)

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< Hybrid >	create (std::shared_ptr< const Executor > exec, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >())

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

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

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)

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

Protected Member Functions
	Hybrid (std::shared_ptr< const Executor > exec, const dim< 2 > &size={}, size_type num_stored_elements_per_row=0, size_type stride=0, size_type num_nonzeros=0, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >())

void	resize (dim< 2 > new_size, size_type ell_row_nnz, size_type coo_nnz)

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

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< Hybrid, LinOp >

class	Dense< ValueType >

class	Csr< ValueType, IndexType >

class	Hybrid< to_complex< ValueType >, IndexType >

class	Hybrid< previous_precision< ValueType >, IndexType >

class	Hybrid< 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::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< AbsoluteLinOp >.

◆ compute_absolute_inplace()

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

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

overridevirtual

Compute absolute inplace on each element.

Implements gko::AbsoluteComputable.

◆ 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 , typename IndexType >

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

◆ resize()

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

void gko::matrix::Hybrid< ValueType, IndexType >::resize	(	dim< 2 >	new_size,
		size_type	ell_row_nnz,
		size_type	coo_nnz
	)

protected

Resizes the matrix to the given dimensions and storage sizes.

Parameters

new_size	the new matrix dimensions
ell_row_nnz	the number of non-zeros per row stored in ELL
coo_nnz	the number of non-zeros stored in COO

See also: Ell::resize(dim<2>, size_type); Coo::resize(dim<2>, size_type)

◆ 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

Hybrid< ValueType, IndexType > Class Template Reference

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Hybrid() [1/2]

◆ Hybrid() [2/2]

Member Function Documentation

◆ compute_absolute()

◆ compute_absolute_inplace()

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

◆ resize()

◆ write()

Hybrid< ValueType, IndexType > Class Template Reference#