Data Class Reference

#include <Data.h>

Inheritance diagram for Data:

Public Member Functions
	Data (const OptionSet &options)
	Construct a new Data object.
const std::vector< Data * > &	registered_data () const
	All the registered data objects.
Public Member Functions inherited from NEML2Object
	NEML2Object (const OptionSet &options)
	Construct a new NEML2Object object.
virtual	~NEML2Object ()=default
const OptionSet &	input_options () const
virtual void	setup ()
	Setup this object.
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.
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.
Public Member Functions inherited from BufferStore
	BufferStore (const OptionSet &options, NEML2Object *object)
const Storage< std::string, TensorValueBase > &	named_buffers () const
Storage< std::string, TensorValueBase > &	named_buffers ()
template<typename T , typename = typename std::enable_if_t<std::is_base_of_v<TensorBase<T>, T>>>
TensorValue< T > &	get_buffer (const std::string &name)
	}@

Static Public Member Functions
static OptionSet	expected_options ()
Static Public Member Functions inherited from NEML2Object
static OptionSet	expected_options ()

Protected Member Functions
template<typename T , typename = typename std::enable_if_t<std::is_base_of_v<Data, T>>>
T &	register_data (const std::string &name)
Protected Member Functions inherited from BufferStore
virtual void	send_buffers_to (const torch::TensorOptions &options)
	Send all buffers to options.
template<typename T , typename = typename std::enable_if_t<std::is_base_of_v<TensorBase<T>, T>>>
const T &	declare_buffer (const std::string &name, const T &rawval)
	Declare a buffer.
template<typename T , typename = typename std::enable_if_t<std::is_base_of_v<TensorBase<T>, T>>>
const T &	declare_buffer (const std::string &name, const std::string &input_option_name)
	Declare a buffer.

Protected Attributes
std::vector< Data * >	_registered_data
	Registered Data objects.

Constructor & Destructor Documentation

Data()

Data

(

const OptionSet &

options

)

Construct a new Data object.

Parameters

options

The set of options extracted from the input file

Member Function Documentation

expected_options()

OptionSet expected_options ( )

static

register_data()

template<typename T , typename = typename std::enable_if_t<std::is_base_of_v<Data, T>>>

T & register_data ( const std::string & name )

inlineprotected

Register a data object and return its reference

registered_data()

const std::vector< Data * > & registered_data ( ) const

inline

All the registered data objects.

Member Data Documentation

_registered_data

std::vector<Data *> _registered_data

protected

Registered Data objects.