The (logical) full second order tensor. More...

Detailed Description

template<class Derived>
class neml2::R2Base< Derived >

The (logical) full second order tensor.

The logical storage space is (3, 3).

#include <R2Base.h>

Inheritance diagram for R2Base< Derived >:

[legend]

Public Member Functions
	operator SR2 () const
	Conversion operator to symmetric second order tensor.

Derived	rotate (const Rot &r) const
	Rotate using a Rodrigues vector.

Derived	rotate (const R2 &R) const
	Rotate using a rotation matrix.

R3	drotate (const Rot &r) const
	Derivative of the rotated tensor w.r.t. the Rodrigues vector.

R4	drotate (const R2 &R) const
	Derivative of the rotated tensor w.r.t. the rotation matrix.

Scalar	operator() (TorchSize i, TorchSize j) const
	Accessor.

Derived	inverse () const
	Inversion.

Derived	transpose () const
	transpose

Public Member Functions inherited from FixedDimTensor< Derived, 3, 3 >
	FixedDimTensor ()=default
	Default constructor.

	FixedDimTensor (const torch::Tensor &tensor, TorchSize batch_dim)
	Construct from another torch::Tensor given batch dimension.

	FixedDimTensor (const torch::Tensor &tensor)
	Construct from another torch::Tensor and infer batch dimension.

	operator BatchTensor () const
	Implicit conversion to a BatchTensor and loses information on the fixed base shape.

Public Member Functions inherited from BatchTensorBase< Derived >
	BatchTensorBase ()=default
	Default constructor.

	BatchTensorBase (const torch::Tensor &tensor, TorchSize batch_dim)
	Construct from another torch::Tensor.

	BatchTensorBase (const Derived &tensor)
	Copy constructor.

	BatchTensorBase (Real)=delete

bool	batched () const
	Whether the tensor is batched.

TorchSize	batch_dim () const
	Return the number of batch dimensions.

TorchSize &	batch_dim ()
	Return a writable reference to the batch dimension.

TorchSize	base_dim () const
	Return the number of base dimensions.

TorchShapeRef	batch_sizes () const
	Return the batch size.

TorchSize	batch_size (TorchSize index) const
	Return the length of some batch axis.

TorchShapeRef	base_sizes () const
	Return the base size.

TorchSize	base_size (TorchSize index) const
	Return the length of some base axis.

TorchSize	base_storage () const
	Return the flattened storage needed just for the base indices.

Derived	batch_index (TorchSlice indices) const
	Get a batch.

BatchTensor	base_index (const TorchSlice &indices) const
	Return an index sliced on the base dimensions.

void	batch_index_put (TorchSlice indices, const torch::Tensor &other)
	Set a index sliced on the batch dimensions to a value.

void	base_index_put (const TorchSlice &indices, const torch::Tensor &other)
	Set a index sliced on the base dimensions to a value.

Derived	batch_expand (TorchShapeRef batch_size) const
	Return a new view of the tensor with values broadcast along the batch dimensions.

BatchTensor	base_expand (TorchShapeRef base_size) const
	Return a new view of the tensor with values broadcast along the base dimensions.

template<class Derived2 >
Derived	batch_expand_as (const Derived2 &other) const
	Expand the batch to have the same shape as another tensor.

template<class Derived2 >
Derived2	base_expand_as (const Derived2 &other) const
	Expand the base to have the same shape as another tensor.

Derived	batch_expand_copy (TorchShapeRef batch_size) const
	Return a new tensor with values broadcast along the batch dimensions.

BatchTensor	base_expand_copy (TorchShapeRef base_size) const
	Return a new tensor with values broadcast along the base dimensions.

Derived	batch_reshape (TorchShapeRef batch_shape) const
	Reshape batch dimensions.

BatchTensor	base_reshape (TorchShapeRef base_shape) const
	Reshape base dimensions.

Derived	batch_unsqueeze (TorchSize d) const
	Unsqueeze a batch dimension.

Derived	list_unsqueeze () const
	Unsqueeze on the special list batch dimension.

BatchTensor	base_unsqueeze (TorchSize d) const
	Unsqueeze a base dimension.

Derived	batch_transpose (TorchSize d1, TorchSize d2) const
	Transpose two batch dimensions.

BatchTensor	base_transpose (TorchSize d1, TorchSize d2) const
	Transpose two base dimensions.

BatchTensor	base_movedim (TorchSize d1, TorchSize d2) const
	Move two base dimensions.

Derived	clone (torch::MemoryFormat memory_format=torch::MemoryFormat::Contiguous) const
	Clone (take ownership)

Derived	detach () const
	Discard function graph.

Derived	to (const torch::TensorOptions &options) const
	Send to options.

Derived	operator- () const
	Negation.

Derived	batch_sum (TorchSize d) const
	Sum on a batch index.

Derived	list_sum () const
	Sum on the list index (TODO: replace with class)

Static Public Member Functions
static Derived	fill (const Real &a, const torch::TensorOptions &options=default_tensor_options())
	Fill the diagonals with a11 = a22 = a33 = a.

static Derived	fill (const Scalar &a)

static Derived	fill (const Real &a11, const Real &a22, const Real &a33, const torch::TensorOptions &options=default_tensor_options())
	Fill the diagonals with a11, a22, a33.

static Derived	fill (const Scalar &a11, const Scalar &a22, const Scalar &a33)

static Derived	fill (const Real &a11, const Real &a22, const Real &a33, const Real &a23, const Real &a13, const Real &a12, const torch::TensorOptions &options=default_tensor_options())
	Fill symmetric entries.

static Derived	fill (const Scalar &a11, const Scalar &a22, const Scalar &a33, const Scalar &a23, const Scalar &a13, const Scalar &a12)

static Derived	fill (const Real &a11, const Real &a12, const Real &a13, const Real &a21, const Real &a22, const Real &a23, const Real &a31, const Real &a32, const Real &a33, const torch::TensorOptions &options=default_tensor_options())
	Fill all entries.

static Derived	fill (const Scalar &a11, const Scalar &a12, const Scalar &a13, const Scalar &a21, const Scalar &a22, const Scalar &a23, const Scalar &a31, const Scalar &a32, const Scalar &a33)

static Derived	skew (const Vec &v)
	Skew matrix from Vec.

static Derived	identity (const torch::TensorOptions &options=default_tensor_options())
	Identity.

Static Public Member Functions inherited from FixedDimTensor< Derived, 3, 3 >
static Derived	empty (const torch::TensorOptions &options=default_tensor_options())
	Unbatched empty tensor.

static Derived	empty (TorchShapeRef batch_shape, const torch::TensorOptions &options=default_tensor_options())
	Empty tensor given batch shape.

static Derived	zeros (const torch::TensorOptions &options=default_tensor_options())
	Unbatched zero tensor.

static Derived	zeros (TorchShapeRef batch_shape, const torch::TensorOptions &options=default_tensor_options())
	Zero tensor given batch shape.

static Derived	ones (const torch::TensorOptions &options=default_tensor_options())
	Unbatched unit tensor.

static Derived	ones (TorchShapeRef batch_shape, const torch::TensorOptions &options=default_tensor_options())
	Unit tensor given batch shape.

static Derived	full (Real init, const torch::TensorOptions &options=default_tensor_options())
	Unbatched tensor filled with a given value given base shape.

static Derived	full (TorchShapeRef batch_shape, Real init, const torch::TensorOptions &options=default_tensor_options())
	Full tensor given batch shape.

static BatchTensor	identity_map (const torch::TensorOptions &)
	Derived tensor classes should define identity_map where appropriate.

Static Public Member Functions inherited from BatchTensorBase< Derived >
static Derived	empty_like (const Derived &other)
	Empty tensor like another, i.e. same batch and base shapes, same tensor options, etc.

static Derived	zeros_like (const Derived &other)
	Zero tensor like another, i.e. same batch and base shapes, same tensor options, etc.

static Derived	ones_like (const Derived &other)
	Unit tensor like another, i.e. same batch and base shapes, same tensor options, etc.

static Derived	full_like (const Derived &other, Real init)

static Derived	linspace (const Derived &start, const Derived &end, TorchSize nstep, TorchSize dim=0, TorchSize batch_dim=-1)
	Create a new tensor by adding a new batch dimension with linear spacing between `start` and `end`.

static Derived	logspace (const Derived &start, const Derived &end, TorchSize nstep, TorchSize dim=0, TorchSize batch_dim=-1, Real base=10)
	log-space equivalent of the linspace named constructor

Additional Inherited Members
Static Public Attributes inherited from FixedDimTensor< Derived, 3, 3 >
static const TorchShape	const_base_sizes
	The base shape.

static constexpr TorchSize	const_base_dim
	The base dim.

static const TorchSize	const_base_storage
	The base storage.

Member Function Documentation

◆ drotate() [1/2]

template<class Derived >

R4 drotate ( const R2 & R ) const

Derivative of the rotated tensor w.r.t. the rotation matrix.

◆ drotate() [2/2]

template<class Derived >

R3 drotate ( const Rot & r ) const

Derivative of the rotated tensor w.r.t. the Rodrigues vector.

◆ fill() [1/8]

template<class Derived >

Derived fill	(	const Real &	a,
		const torch::TensorOptions &	options = default_tensor_options() )

static

Fill the diagonals with a11 = a22 = a33 = a.

◆ fill() [2/8]

template<class Derived >

Derived fill	(	const Real &	a11,
		const Real &	a12,
		const Real &	a13,
		const Real &	a21,
		const Real &	a22,
		const Real &	a23,
		const Real &	a31,
		const Real &	a32,
		const Real &	a33,
		const torch::TensorOptions &	options = default_tensor_options() )

static

Fill all entries.

◆ fill() [3/8]

template<class Derived >

Derived fill	(	const Real &	a11,
		const Real &	a22,
		const Real &	a33,
		const Real &	a23,
		const Real &	a13,
		const Real &	a12,
		const torch::TensorOptions &	options = default_tensor_options() )

static

Fill symmetric entries.

◆ fill() [4/8]

template<class Derived >

Derived fill	(	const Real &	a11,
		const Real &	a22,
		const Real &	a33,
		const torch::TensorOptions &	options = default_tensor_options() )

static

Fill the diagonals with a11, a22, a33.

◆ fill() [5/8]

template<class Derived >

Derived fill ( const Scalar & a )

static

◆ fill() [6/8]

template<class Derived >

Derived fill	(	const Scalar &	a11,
		const Scalar &	a12,
		const Scalar &	a13,
		const Scalar &	a21,
		const Scalar &	a22,
		const Scalar &	a23,
		const Scalar &	a31,
		const Scalar &	a32,
		const Scalar &	a33 )

static

◆ fill() [7/8]

template<class Derived >

Derived fill	(	const Scalar &	a11,
		const Scalar &	a22,
		const Scalar &	a33 )

static

◆ fill() [8/8]

template<class Derived >

Derived fill	(	const Scalar &	a11,
		const Scalar &	a22,
		const Scalar &	a33,
		const Scalar &	a23,
		const Scalar &	a13,
		const Scalar &	a12 )

static

◆ identity()

template<class Derived >

Derived identity ( const torch::TensorOptions & options = default_tensor_options() )

static

Identity.

◆ inverse()

template<class Derived >

Derived inverse ( ) const

Inversion.

◆ operator SR2()

template<class Derived >

operator SR2 ( ) const

explicit

Conversion operator to symmetric second order tensor.

◆ operator()()

template<class Derived >

Scalar operator()	(	TorchSize	i,
		TorchSize	j ) const

Accessor.

◆ rotate() [1/2]

template<class Derived >

Derived rotate ( const R2 & R ) const

Rotate using a rotation matrix.

◆ rotate() [2/2]

template<class Derived >

Derived rotate ( const Rot & r ) const

Rotate using a Rodrigues vector.

◆ skew()

template<class Derived >

Derived skew ( const Vec & v )

static

Skew matrix from Vec.

◆ transpose()

template<class Derived >

Derived transpose ( ) const

transpose

Detailed Description

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ drotate() [1/2]

◆ drotate() [2/2]

◆ fill() [1/8]

◆ fill() [2/8]

◆ fill() [3/8]

◆ fill() [4/8]

◆ fill() [5/8]

◆ fill() [6/8]

◆ fill() [7/8]

◆ fill() [8/8]

◆ identity()

◆ inverse()

◆ operator SR2()

◆ operator()()

◆ rotate() [1/2]

◆ rotate() [2/2]

◆ skew()

◆ transpose()