VariableBase Class Reference

#include <Variable.h>

Inheritance diagram for VariableBase:

Public Member Functions
	VariableBase (const VariableName &name_in)
virtual	~VariableBase ()=default
virtual void	cache (TorchShapeRef batch_shape)
	Cache the variable's batch shape.
void	setup_views (const LabeledVector *value, const LabeledMatrix *deriv=nullptr, const LabeledTensor3D *secderiv=nullptr)
	Setup the variable's views into blocks of the storage.
void	setup_views (const VariableBase *other)
	Setup the variable's views into blocks of the storage.
virtual void	reinit_views (bool out, bool dout_din, bool d2out_din2)
	Reinitialize variable views.
virtual void	requires_grad_ (bool req=true)=0
	Set requires_grad for the underlying storage.
const std::vector< VariableName > &	args () const
	Arguments.
void	add_arg (const VariableBase &arg)
	Add an argument.
void	clear_args ()
	Clear arguments.
Derivative	d (const VariableBase &x)
	Create a wrapper representing the derivative dy/dx.
Derivative	d (const VariableBase &x1, const VariableBase &x2)
	Create a wrapper representing the second derivative d2y/dx2.
const BatchTensor &	raw_value () const
	Raw flattened variable value.
virtual const BatchTensor	tensor () const =0
	Variable value of the logical shape.
const VariableName &	name () const
	Name of this variable.
TorchShapeRef	batch_sizes () const
	Batch shape.
virtual TorchShapeRef	base_sizes () const =0
	Base shape.
TorchSize	batch_dim () const
	Batch dimension.
TorchSize	base_dim () const
	Base dimension.
TorchSize	base_storage () const
	Base storage.
virtual TorchShapeRef	sizes () const =0
	Total shape.
const LabeledVector &	value_storage () const
	Accessors for storage.
const LabeledMatrix &	derivative_storage () const
const LabeledTensor3D &	second_derivative_storage () const

Protected Attributes
const VariableName	_name
	Name of the variable.
TorchShape	_batch_sizes
	Batch shape of this variable.
std::vector< VariableName >	_args
	Names of the variables that this variable depends on.
BatchTensor	_raw_value
	The raw (flattened) variable value.
std::map< VariableName, BatchTensor >	_dvalue_d
	The derivative of this variable w.r.t. arguments.
std::map< VariableName, std::map< VariableName, BatchTensor > >	_d2value_d
	The second derivative of this variable w.r.t. arguments.
const LabeledVector *	_value_storage
	The value storage that this variable is viewing into.
const LabeledMatrix *	_derivative_storage
	The derivative storage that this variable is viewing into.
const LabeledTensor3D *	_second_derivative_storage
	The second derivative storage that this variable is viewing into.

Constructor & Destructor Documentation

VariableBase()

VariableBase ( const VariableName & name_in )

inline

~VariableBase()

virtual ~VariableBase ( )

virtualdefault

Member Function Documentation

add_arg()

void add_arg ( const VariableBase & arg )

inline

Add an argument.

args()

const std::vector< VariableName > & args ( ) const

inline

Arguments.

base_dim()

TorchSize base_dim ( ) const

inline

Base dimension.

base_sizes()

virtual TorchShapeRef base_sizes ( ) const

pure virtual

Base shape.

Implemented in Variable< T >, Variable< neml2::BatchTensor >, Variable< neml2::R2 >, Variable< neml2::Rot >, Variable< neml2::Scalar >, Variable< neml2::SR2 >, Variable< neml2::Vec >, Variable< neml2::WR2 >, and Variable< Scalar >.

base_storage()

TorchSize base_storage ( ) const

inline

Base storage.

batch_dim()

TorchSize batch_dim ( ) const

inline

Batch dimension.

batch_sizes()

TorchShapeRef batch_sizes ( ) const

inline

Batch shape.

cache()

void cache ( TorchShapeRef batch_shape )

virtual

Cache the variable's batch shape.

Reimplemented in Variable< T >, Variable< neml2::BatchTensor >, Variable< neml2::R2 >, Variable< neml2::Rot >, Variable< neml2::Scalar >, Variable< neml2::SR2 >, Variable< neml2::Vec >, Variable< neml2::WR2 >, and Variable< Scalar >.

clear_args()

void clear_args ( )

inline

Clear arguments.

d() [1/2]

Derivative d

(

const VariableBase &

x

)

Create a wrapper representing the derivative dy/dx.

d() [2/2]

Derivative d	(	const VariableBase &	x1,
		const VariableBase &	x2 )

Create a wrapper representing the second derivative d2y/dx2.

derivative_storage()

const LabeledMatrix & derivative_storage

(

)

const

name()

const VariableName & name ( ) const

inline

Name of this variable.

raw_value()

const BatchTensor & raw_value ( ) const

inline

Raw flattened variable value.

reinit_views()

void reinit_views ( bool out, bool dout_din, bool d2out_din2 )

virtual

Reinitialize variable views.

Reimplemented in Variable< T >, Variable< neml2::BatchTensor >, Variable< neml2::R2 >, Variable< neml2::Rot >, Variable< neml2::Scalar >, Variable< neml2::SR2 >, Variable< neml2::Vec >, Variable< neml2::WR2 >, and Variable< Scalar >.

requires_grad_()

virtual void requires_grad_ ( bool req = true )

pure virtual

Set requires_grad for the underlying storage.

Implemented in Variable< T >, Variable< neml2::BatchTensor >, Variable< neml2::R2 >, Variable< neml2::Rot >, Variable< neml2::Scalar >, Variable< neml2::SR2 >, Variable< neml2::Vec >, Variable< neml2::WR2 >, and Variable< Scalar >.

second_derivative_storage()

const LabeledTensor3D & second_derivative_storage

(

)

const

setup_views() [1/2]

void setup_views	(	const LabeledVector *	value,
		const LabeledMatrix *	deriv = nullptr,
		const LabeledTensor3D *	secderiv = nullptr )

Setup the variable's views into blocks of the storage.

setup_views() [2/2]

void setup_views

(

const VariableBase *

other

)

Setup the variable's views into blocks of the storage.

sizes()

virtual TorchShapeRef sizes ( ) const

pure virtual

Total shape.

Implemented in Variable< T >, Variable< neml2::BatchTensor >, Variable< neml2::R2 >, Variable< neml2::Rot >, Variable< neml2::Scalar >, Variable< neml2::SR2 >, Variable< neml2::Vec >, Variable< neml2::WR2 >, and Variable< Scalar >.

tensor()

virtual const BatchTensor tensor ( ) const

pure virtual

Variable value of the logical shape.

Implemented in Variable< T >, Variable< neml2::BatchTensor >, Variable< neml2::R2 >, Variable< neml2::Rot >, Variable< neml2::Scalar >, Variable< neml2::SR2 >, Variable< neml2::Vec >, Variable< neml2::WR2 >, and Variable< Scalar >.

value_storage()

const LabeledVector & value_storage

(

)

const

Accessors for storage.

Member Data Documentation

_args

std::vector<VariableName> _args

protected

Names of the variables that this variable depends on.

_batch_sizes

TorchShape _batch_sizes

protected

Batch shape of this variable.

_d2value_d

std::map<VariableName, std::map<VariableName, BatchTensor> > _d2value_d

protected

The second derivative of this variable w.r.t. arguments.

_derivative_storage

const LabeledMatrix* _derivative_storage

protected

The derivative storage that this variable is viewing into.

_dvalue_d

std::map<VariableName, BatchTensor> _dvalue_d

protected

The derivative of this variable w.r.t. arguments.

_name

const VariableName _name

protected

Name of the variable.

_raw_value

BatchTensor _raw_value

protected

The raw (flattened) variable value.

_second_derivative_storage

const LabeledTensor3D* _second_derivative_storage

protected

The second derivative storage that this variable is viewing into.

_value_storage

const LabeledVector* _value_storage

protected

The value storage that this variable is viewing into.