Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Friends | List of all members
gko::batch::matrix::Identity< ValueType > Class Template Referencefinal

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 >:
[legend]
Collaboration diagram for gko::batch::matrix::Identity< ValueType >:
[legend]

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::EnablePolymorphicAssignment< ConcreteBatchLinOp >
using result_type
 
- Public Types inherited from gko::ConvertibleTo< ResultType >
using result_type = ResultType
 

Public Member Functions

Identityapply (ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x)
 Apply the matrix to a multi-vector.
 
Identityapply (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.
 
const Identityapply (ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x) const
 
const Identityapply (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::EnableAbstractPolymorphicObject< AbstractObject, PolymorphicBase >
std::unique_ptr< AbstractObjectcreate_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< AbstractObjectcreate_default () const
 
std::unique_ptr< AbstractObjectclone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< AbstractObjectclone () const
 
AbstractObjectcopy_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)
 
AbstractObjectcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 
AbstractObjectmove_from (ptr_param< PolymorphicObject > other)
 
AbstractObjectclear ()
 
- Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObjectoperator= (const PolymorphicObject &)
 
std::unique_ptr< PolymorphicObjectcreate_default (std::shared_ptr< const Executor > exec) const
 Creates a new "default" object of the same dynamic type as this object.
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object.
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object.
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object.
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object.
 
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.
 
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.
 
PolymorphicObjectcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 Copies another object into this object.
 
PolymorphicObjectmove_from (ptr_param< PolymorphicObject > other)
 Moves another object into this object.
 
PolymorphicObjectclear ()
 Transforms the object into its default state.
 
std::shared_ptr< const Executorget_executor () const noexcept
 Returns the Executor of the object.
 
- Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void add_logger (std::shared_ptr< const Logger > logger) override
 Adds a new logger to the list of subscribed loggers.
 
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers.
 
void remove_logger (ptr_param< const Logger > logger)
 
const std::vector< std::shared_ptr< const Logger > > & get_loggers () const override
 Returns the vector containing all loggers registered at this object.
 
void clear_loggers () override
 Remove all loggers registered at this object.
 
- Public Member Functions inherited from gko::log::Loggable
void remove_logger (ptr_param< const Logger > logger)
 
- Public Member Functions inherited from gko::EnablePolymorphicAssignment< ConcreteBatchLinOp >
void convert_to (result_type *result) const override
 Converts the implementer to an object of type result_type.
 
void move_to (result_type *result) override
 Converts the implementer to an object of type result_type by moving data from this object.
 
- Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void convert_to (result_type *result) const =0
 Converts the implementer to an object of type result_type.
 
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.
 
void move_to (ptr_param< result_type > result)
 

Friends

class EnableCreateMethod< Identity >
 
class EnablePolymorphicObject< Identity, BatchLinOp >
 

Additional Inherited Members

- Static Public Member Functions inherited from gko::EnableCreateMethod< ConcreteType >
template<typename... Args>
static std::unique_ptr< ConcreteTypecreate (Args &&... args)
 

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
ValueTypeprecision of matrix elements

Member Function Documentation

◆ apply() [1/4]

template<typename ValueType = default_precision>
Identity * 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
alphathe scalar to scale the matrix-vector product with
bthe multi-vector to be applied to
betathe scalar to scale the x vector with
xthe output multi-vector

◆ apply() [2/4]

template<typename ValueType = default_precision>
const Identity * 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>
Identity * 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
bthe multi-vector to be applied to
xthe output multi-vector

◆ apply() [4/4]

template<typename ValueType = default_precision>
const Identity * gko::batch::matrix::Identity< ValueType >::apply ( ptr_param< const MultiVector< value_type > > b,
ptr_param< MultiVector< value_type > > x ) const


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