gko::matrix::IdentityFactory< ValueType > Class Template Reference

This factory is a utility which can be used to generate Identity operators. More...

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

Inheritance diagram for gko::matrix::IdentityFactory< ValueType >:

Collaboration diagram for gko::matrix::IdentityFactory< ValueType >:

Public Types
using	value_type = ValueType

Static Public Member Functions
static std::unique_ptr< IdentityFactory >	create (std::shared_ptr< const Executor > exec)
	Creates a new Identity factory. More...

Friends
class	EnablePolymorphicObject< IdentityFactory, LinOpFactory >

Additional Inherited Members
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< IdentityFactory< ValueType >, LinOpFactory >
std::unique_ptr< IdentityFactory< ValueType > >	create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< IdentityFactory< ValueType > >	create_default () const
std::unique_ptr< IdentityFactory< ValueType > >	clone (std::shared_ptr< const Executor > exec) const
std::unique_ptr< IdentityFactory< ValueType > >	clone () const
IdentityFactory< ValueType > *	copy_from (const PolymorphicObject *other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, IdentityFactory< ValueType > > *	copy_from (std::unique_ptr< Derived > &&other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, IdentityFactory< ValueType > > *	copy_from (const std::unique_ptr< Derived > &other)
IdentityFactory< ValueType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
IdentityFactory< ValueType > *	move_from (ptr_param< PolymorphicObject > other)
IdentityFactory< ValueType > *	clear ()
Public Member Functions inherited from gko::LinOpFactory
std::unique_ptr< LinOp >	generate (std::shared_ptr< const LinOp > input) const
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)

Detailed Description

template<typename ValueType = default_precision>
class gko::matrix::IdentityFactory< ValueType >

This factory is a utility which can be used to generate Identity operators.

The factory will generate the Identity matrix with the same dimension as the passed in operator. It will throw an exception if the operator is not square.

Template Parameters

ValueType

precision of matrix elements

Member Function Documentation

create()

template<typename ValueType = default_precision>

static std::unique_ptr<IdentityFactory> gko::matrix::IdentityFactory< ValueType >::create ( std::shared_ptr< const Executor >  exec )

inlinestatic

Creates a new Identity factory.

Parameters

exec	the executor where the Identity operator will be stored

Returns

a unique pointer to the newly created factory

---

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

• ginkgo/core/matrix/identity.hpp