gko::batch::BatchLinOp Class Reference

Inheritance diagram for gko::batch::BatchLinOp:

Collaboration diagram for gko::batch::BatchLinOp:

Public Member Functions
size_type	get_num_batch_items () const noexcept
	Returns the number of items in the batch operator. More...
dim< 2 >	get_common_size () const
	Returns the common size of the batch items. More...
const batch_dim< 2 > &	get_size () const noexcept
	Returns the size of the batch operator. More...
template<typename ValueType >
void	validate_application_parameters (const MultiVector< ValueType > *b, MultiVector< ValueType > *x) const
	Validates the sizes for the apply(b,x) operation in the concrete BatchLinOp.
template<typename ValueType >
void	validate_application_parameters (const MultiVector< ValueType > *alpha, const MultiVector< ValueType > *b, const MultiVector< ValueType > *beta, MultiVector< ValueType > *x) const
	Validates the sizes for the apply(alpha, b , beta, x) operation in the concrete BatchLinOp.
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)

Member Function Documentation

get_common_size()

dim<2> gko::batch::BatchLinOp::get_common_size ( ) const

inline

Returns the common size of the batch items.

Returns

the common size stored

References gko::batch_dim< Dimensionality, DimensionType >::get_common_size(), and get_size().

Referenced by gko::batch::matrix::Dense< ValueType >::get_cumulative_offset(), and validate_application_parameters().

get_num_batch_items()

size_type gko::batch::BatchLinOp::get_num_batch_items ( ) const

inlinenoexcept

Returns the number of items in the batch operator.

Returns

number of items in the batch operator

References gko::batch_dim< Dimensionality, DimensionType >::get_num_batch_items(), and get_size().

Referenced by gko::batch::matrix::Dense< ValueType >::at(), gko::batch::matrix::Ell< ValueType, IndexType >::get_col_idxs_for_item(), gko::batch::matrix::Ell< ValueType, IndexType >::get_const_col_idxs_for_item(), gko::batch::matrix::Dense< ValueType >::get_const_values_for_item(), gko::batch::matrix::Csr< ValueType, IndexType >::get_const_values_for_item(), gko::batch::matrix::Ell< ValueType, IndexType >::get_const_values_for_item(), gko::batch::matrix::Dense< ValueType >::get_cumulative_offset(), gko::batch::matrix::Ell< ValueType, IndexType >::get_num_elements_per_item(), gko::batch::matrix::Csr< ValueType, IndexType >::get_num_elements_per_item(), gko::batch::matrix::Dense< ValueType >::get_num_elements_per_item(), gko::batch::matrix::Csr< ValueType, IndexType >::get_values_for_item(), gko::batch::matrix::Dense< ValueType >::get_values_for_item(), gko::batch::matrix::Ell< ValueType, IndexType >::get_values_for_item(), and validate_application_parameters().

get_size()

const batch_dim<2>& gko::batch::BatchLinOp::get_size ( ) const

inlinenoexcept

Returns the size of the batch operator.

Returns

size of the batch operator, a batch_dim object

Referenced by get_common_size(), and get_num_batch_items().

---

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

• ginkgo/core/base/batch_lin_op.hpp