Ginkgo  Generated from pipelines/164546034 branch based on develop. Ginkgo version 1.2.0
A numerical linear algebra library targeting many-core architectures
Public Types | Static Public Member Functions | Friends | List of all members
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>

Collaboration diagram for gko::matrix::IdentityFactory< ValueType >:
[legend]

Public Types

using value_type = ValueType
 

Static Public Member Functions

static std::unique_ptr< IdentityFactorycreate (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)
 
IdentityFactory< ValueType > * copy_from (std::unique_ptr< PolymorphicObject > other)
 
IdentityFactory< ValueType > * clear ()
 
- Public Member Functions inherited from gko::LinOpFactory
std::unique_ptr< LinOpgenerate (std::shared_ptr< const LinOp > input) const
 
- 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. More...
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object. More...
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object. More...
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object. More...
 
PolymorphicObjectcopy_from (std::unique_ptr< PolymorphicObject > other)
 Moves another object into this object. More...
 
PolymorphicObjectclear ()
 Transforms the object into its default state. More...
 
std::shared_ptr< const Executorget_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
 Adds a new logger to the list of subscribed loggers. More...
 
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers. More...
 

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
ValueTypeprecision 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
execthe 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: