NEML2 2.0.0
Loading...
Searching...
No Matches
RandomTensorImpl< T > Class Template Reference

Create a random tensor of type T from the input file. More...

Detailed Description

template<typename T>
class neml2::RandomTensorImpl< T >

Create a random tensor of type T from the input file.

Template Parameters
TThe concrete tensor derived from TensorBase

#include <RandomTensor.h>

Inheritance diagram for RandomTensorImpl< T >:

Public Member Functions

 RandomTensorImpl (const OptionSet &options)
 
- Public Member Functions inherited from FactoryMethodBase< T >
 FactoryMethodBase (const OptionSet &options)
 
- Public Member Functions inherited from UserTensorBase< T >
 UserTensorBase (const OptionSet &options)
 
void setup () override
 Setup this object.
 
- Public Member Functions inherited from NEML2Object
 NEML2Object ()=delete
 
 NEML2Object (NEML2Object &&)=delete
 
 NEML2Object (const NEML2Object &)=delete
 
NEML2Objectoperator= (NEML2Object &&)=delete
 
NEML2Objectoperator= (const NEML2Object &)=delete
 
virtual ~NEML2Object ()=default
 
 NEML2Object (const OptionSet &options)
 Construct a new NEML2Object object.
 
const OptionSetinput_options () const
 
const std::string & name () const
 A readonly reference to the object's name.
 
const std::string & type () const
 A readonly reference to the object's type.
 
const std::string & path () const
 A readonly reference to the object's path.
 
const std::string & doc () const
 A readonly reference to the object's docstring.
 
Factoryfactory () const
 Get the factory that created this object.
 
const Settingssettings () const
 Settings.
 
template<typename T = NEML2Object>
const T * host () const
 Get a readonly pointer to the host.
 
template<typename T = NEML2Object>
T * host ()
 Get a writable pointer to the host.
 
template<typename T >
const T & resolve_tensor (const std::string &name)
 Resolve a TensorName to a Tensor.
 
template<class T >
std::shared_ptr< T > get_object (const std::string &section, const std::string &name)
 
template<class T = Solver>
std::shared_ptr< T > get_solver (const std::string &name)
 Get a solver from the factory.
 
template<class T = Data>
std::shared_ptr< T > get_data (const std::string &name)
 Get a data from the factory.
 
template<class T = Model>
std::shared_ptr< T > get_model (const std::string &name)
 Get a model from the factory.
 
template<class T = Driver>
std::shared_ptr< T > get_driver (const std::string &name)
 Get a driver from the factory.
 
template<class T = WorkScheduler>
std::shared_ptr< T > get_scheduler (const std::string &name)
 Get a scheduler from the factory.
 

Static Public Member Functions

static OptionSet expected_options ()
 
- Static Public Member Functions inherited from FactoryMethodBase< T >
static OptionSet expected_options ()
 
- Static Public Member Functions inherited from UserTensorBase< T >
static OptionSet expected_options ()
 
- Static Public Member Functions inherited from NEML2Object
static OptionSet expected_options ()
 

Protected Member Functions

make () const override
 Create the tensor given input options.
 
Tensor make () const
 Create the tensor given input options.
 
Rot make () const
 Create the tensor given input options.
 
- Protected Member Functions inherited from UserTensorBase< T >

Additional Inherited Members

- Static Protected Member Functions inherited from UserTensorBase< T >
static std::string tensor_type ()
 A human-readable description of the tensor type.
 
- Protected Attributes inherited from FactoryMethodBase< T >
const TensorShape _batch_sizes
 Batch shape.
 
const TensorShape _base_sizes
 Base shape.
 
const unsigned int _intmd_dim
 Intermediate dimension.
 

Constructor & Destructor Documentation

◆ RandomTensorImpl()

template<class T >
RandomTensorImpl ( const OptionSet & options)

Member Function Documentation

◆ expected_options()

template<class T >
OptionSet expected_options ( )
static

◆ make() [1/3]

Tensor make ( ) const
protectedvirtual

Create the tensor given input options.

Implements UserTensorBase< T >.

◆ make() [2/3]

Rot make ( ) const
protectedvirtual

Create the tensor given input options.

Implements UserTensorBase< T >.

◆ make() [3/3]

template<class T >
T make ( ) const
overrideprotectedvirtual

Create the tensor given input options.

Implements UserTensorBase< T >.