gko::batch::matrix::Identity< ValueType > Class Template Reference

The batch Identity matrix, which represents a batch of Identity matrices. More...

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

Inheritance diagram for gko::batch::matrix::Identity< ValueType >:

Collaboration diagram for gko::batch::matrix::Identity< ValueType >:

Public Types
using	value_type = ValueType
using	index_type = int32
using	unbatch_type = gko::matrix::Identity< ValueType >
using	absolute_type = remove_complex< Identity >
using	complex_type = to_complex< Identity >
Public Types inherited from gko::EnableCloneable< Identity< ValueType > >
using	result_type = Identity< ValueType >
Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

Public Member Functions
void	apply (ptr_param< const MultiVector< value_type >> b, ptr_param< MultiVector< value_type >> x)
	Apply the matrix to a multi-vector. More...
void	apply (ptr_param< const MultiVector< value_type >> alpha, ptr_param< const MultiVector< value_type >> b, ptr_param< const MultiVector< value_type >> beta, ptr_param< MultiVector< value_type >> x)
	Apply the matrix to a multi-vector with a linear combination of the given input vector. More...
void	apply (ptr_param< const MultiVector< value_type >> b, ptr_param< MultiVector< value_type >> x) const
void	apply (ptr_param< const MultiVector< value_type >> alpha, ptr_param< const MultiVector< value_type >> b, ptr_param< const MultiVector< value_type >> beta, ptr_param< MultiVector< value_type >> x) const
Public Member Functions inherited from gko::batch::BatchLinOp
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)
Public Member Functions inherited from gko::EnableCloneable< Identity< ValueType > >
std::unique_ptr< Identity< ValueType > >	clone (std::shared_ptr< const Executor > exec) const
	Creates a clone of the object. More...
std::unique_ptr< Identity< ValueType > >	clone () const
	Creates a clone of the object. More...
void	convert_to (result_type *result) const override
	Converts the implementer to an object of type result_type. More...
void	move_to (result_type *result) override
	Converts the implementer to an object of type result_type by moving data from this object. More...
std::unique_ptr< Identity< ValueType > >	create_default () const
std::unique_ptr< Identity< ValueType > >	create_default (std::shared_ptr< const Executor > exec) const
Public Member Functions inherited from gko::ConvertibleTo< ResultType >
void	convert_to (ptr_param< result_type > result) const
void	move_to (ptr_param< result_type > result)
Public Member Functions inherited from gko::Cloneable
std::unique_ptr< Cloneable >	clone (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Cloneable >	clone () const
Cloneable *	copy_from (ptr_param< const Cloneable > other)
Cloneable *	move_from (ptr_param< Cloneable > other)
std::unique_ptr< Cloneable >	create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Cloneable >	create_default () const

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

Friends
class	EnableCloneable< Identity >

Detailed Description

template<typename ValueType = default_precision>
class gko::batch::matrix::Identity< ValueType >

The batch Identity matrix, which represents a batch of Identity matrices.

Template Parameters

ValueType

precision of matrix elements

Member Function Documentation

apply() [1/4]

template<typename ValueType = default_precision>

void gko::batch::matrix::Identity< ValueType >::apply	(	ptr_param< const MultiVector< value_type >>	alpha,
		ptr_param< const MultiVector< value_type >>	b,
		ptr_param< const MultiVector< value_type >>	beta,
		ptr_param< MultiVector< value_type >>	x
	)

Apply the matrix to a multi-vector with a linear combination of the given input vector.

Represents the matrix vector multiplication, x = alpha * I

• b + beta * x, where x and b are both multi-vectors.

Parameters

alpha	the scalar to scale the matrix-vector product with
b	the multi-vector to be applied to
beta	the scalar to scale the x vector with
x	the output multi-vector

apply() [2/4]

template<typename ValueType = default_precision>

void gko::batch::matrix::Identity< ValueType >::apply	(	ptr_param< const MultiVector< value_type >>	alpha,
		ptr_param< const MultiVector< value_type >>	b,
		ptr_param< const MultiVector< value_type >>	beta,
		ptr_param< MultiVector< value_type >>	x
	)		const

apply() [3/4]

template<typename ValueType = default_precision>

void gko::batch::matrix::Identity< ValueType >::apply	(	ptr_param< const MultiVector< value_type >>	b,
		ptr_param< MultiVector< value_type >>	x
	)

Apply the matrix to a multi-vector.

Represents the matrix vector multiplication, x = I * b, where x and b are both multi-vectors.

Parameters

b	the multi-vector to be applied to
x	the output multi-vector

apply() [4/4]

template<typename ValueType = default_precision>

void gko::batch::matrix::Identity< ValueType >::apply	(	ptr_param< const MultiVector< value_type >>	b,
		ptr_param< MultiVector< value_type >>	x
	)		const

create()

template<typename ValueType = default_precision>

static std::unique_ptr<Identity> gko::batch::matrix::Identity< ValueType >::create ( std::shared_ptr< const Executor >  exec, const batch_dim< 2 > &  size = batch_dim< 2 >{}  )

static

Creates an Identity matrix of the specified size.

Parameters

exec	Executor associated to the matrix
size	size of the batch matrices in a batch_dim object

Returns

A smart pointer to the newly created matrix.

---

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

• ginkgo/core/matrix/batch_identity.hpp