NEML2 2.0.0
Loading...
Searching...
No Matches
R3 Class Reference

Third order tensor without symmetry. More...

Detailed Description

Third order tensor without symmetry.

The storage space is (3, 3, 3).

#include <R3.h>

Inheritance diagram for R3:

Public Member Functions

Scalar operator() (Size i, Size j, Size k) const
 Accessor.
 
R2 contract_k (const Vec &v) const
 R3,Vector->R2 product ijk,k->ij.
 
- Public Member Functions inherited from PrimitiveTensor< R3, 3, 3, 3 >
 PrimitiveTensor ()=default
 Special member functions.
 
 PrimitiveTensor (const ATensor &tensor, Size batch_dim)
 Construct from another ATensor given batch dimension.
 
 PrimitiveTensor (const ATensor &tensor, const TraceableTensorShape &batch_shape)
 Construct from another ATensor given batch shape.
 
 PrimitiveTensor (const Tensor &tensor)
 Copy constructor.
 
 PrimitiveTensor (const ATensor &tensor)
 Construct from another ATensor and infer batch dimension.
 
 operator Tensor () const
 Implicit conversion to a Tensor and loses information on the fixed base shape.
 
- Public Member Functions inherited from TensorBase< R3 >
 TensorBase ()=default
 Special member functions.
 
 TensorBase (const ATensor &tensor, Size batch_dim)
 Construct from another ATensor with given batch dimension.
 
 TensorBase (const ATensor &tensor, const TraceableTensorShape &batch_shape)
 Construct from another ATensor with given batch shape.
 
 TensorBase (const neml2::Tensor &tensor)
 Copy constructor.
 
 TensorBase (double)=delete
 
 TensorBase (float)=delete
 
 TensorBase (int)=delete
 
R3 variable_data () const
 
R3 clone () const
 
R3 detach () const
 Discard function graph.
 
R3 to (const TensorOptions &options) const
 Change tensor options.
 
R3 operator- () const
 Negation.
 
bool batched () const
 Whether the tensor is batched.
 
Size batch_dim () const
 Return the number of batch dimensions.
 
Size base_dim () const
 Return the number of base dimensions.
 
const TraceableTensorShapebatch_sizes () const
 Return the batch size.
 
TraceableSize batch_size (Size index) const
 Return the size of a batch axis.
 
TensorShapeRef base_sizes () const
 Return the base size.
 
Size base_size (Size index) const
 Return the size of a base axis.
 
Size base_storage () const
 Return the flattened storage needed just for the base indices.
 
R3 batch_index (indexing::TensorIndicesRef indices) const
 Get a tensor by slicing on the batch dimensions.
 
neml2::Tensor base_index (indexing::TensorIndicesRef indices) const
 Get a tensor by slicing on the base dimensions.
 
R3 batch_slice (Size dim, const indexing::Slice &index) const
 Get a tensor by slicing along a batch dimension.
 
neml2::Tensor base_slice (Size dim, const indexing::Slice &index) const
 Get a tensor by slicing along a base dimension.
 
void batch_index_put_ (indexing::TensorIndicesRef indices, const ATensor &other)
 
void batch_index_put_ (indexing::TensorIndicesRef indices, const CScalar &v)
 
void base_index_put_ (indexing::TensorIndicesRef indices, const ATensor &other)
 
void base_index_put_ (indexing::TensorIndicesRef indices, const CScalar &v)
 
R3 batch_expand (const TraceableTensorShape &batch_shape) const
 
R3 batch_expand (const TraceableSize &batch_size, Size dim) const
 Return a new view of the tensor with values broadcast along a given batch dimension.
 
neml2::Tensor base_expand (TensorShapeRef base_shape) const
 Return a new view of the tensor with values broadcast along the base dimensions.
 
neml2::Tensor base_expand (Size base_size, Size dim) const
 Return a new view of the tensor with values broadcast along a given base dimension.
 
R3 batch_expand_as (const neml2::Tensor &other) const
 Expand the batch to have the same shape as another tensor.
 
neml2::Tensor base_expand_as (const neml2::Tensor &other) const
 Expand the base to have the same shape as another tensor.
 
R3 batch_expand_copy (const TraceableTensorShape &batch_shape) const
 Return a new tensor with values broadcast along the batch dimensions.
 
neml2::Tensor base_expand_copy (TensorShapeRef base_shape) const
 Return a new tensor with values broadcast along the base dimensions.
 
R3 batch_reshape (const TraceableTensorShape &batch_shape) const
 Reshape batch dimensions.
 
neml2::Tensor base_reshape (TensorShapeRef base_shape) const
 Reshape base dimensions.
 
R3 batch_unsqueeze (Size d) const
 Unsqueeze a batch dimension.
 
neml2::Tensor base_unsqueeze (Size d) const
 Unsqueeze a base dimension.
 
R3 batch_transpose (Size d1, Size d2) const
 Transpose two batch dimensions.
 
neml2::Tensor base_transpose (Size d1, Size d2) const
 Transpose two base dimensions.
 
neml2::Tensor base_flatten () const
 Flatten base dimensions.
 

Static Public Member Functions

static R3 levi_civita (const TensorOptions &options=default_tensor_options())
 Alternating symbol.
 
- Static Public Member Functions inherited from PrimitiveTensor< R3, 3, 3, 3 >
static R3 create (const TensorDataContainer &data, const TensorOptions &options=default_tensor_options())
 Arbitrary tensor from a nested container with inferred batch dimension.
 
static R3 empty (const TensorOptions &options=default_tensor_options())
 Unbatched empty tensor.
 
static R3 empty (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
 Empty tensor given batch shape.
 
static R3 zeros (const TensorOptions &options=default_tensor_options())
 Unbatched zero tensor.
 
static R3 zeros (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
 Zero tensor given batch shape.
 
static R3 ones (const TensorOptions &options=default_tensor_options())
 Unbatched unit tensor.
 
static R3 ones (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
 Unit tensor given batch shape.
 
static R3 full (const CScalar &init, const TensorOptions &options=default_tensor_options())
 Unbatched tensor filled with a given value given base shape.
 
static R3 full (const TraceableTensorShape &batch_shape, const CScalar &init, const TensorOptions &options=default_tensor_options())
 Full tensor given batch shape.
 
static Tensor identity_map (const TensorOptions &)
 Derived tensor classes should define identity_map where appropriate.
 
- Static Public Member Functions inherited from TensorBase< R3 >
static R3 empty_like (const R3 &other)
 
static R3 zeros_like (const R3 &other)
 Zero tensor like another, i.e. same batch and base shapes, same tensor options, etc.
 
static R3 ones_like (const R3 &other)
 Unit tensor like another, i.e. same batch and base shapes, same tensor options, etc.
 
static R3 full_like (const R3 &other, const CScalar &init)
 
static R3 linspace (const R3 &start, const R3 &end, Size nstep, Size dim=0)
 Create a new tensor by adding a new batch dimension with linear spacing between start and end.
 
static R3 logspace (const R3 &start, const R3 &end, Size nstep, Size dim=0, const CScalar &base=10)
 log-space equivalent of the linspace named constructor
 

Additional Inherited Members

- Static Public Attributes inherited from PrimitiveTensor< R3, 3, 3, 3 >
static const TensorShape const_base_sizes
 The base shape.
 
static constexpr Size const_base_dim
 The base dim.
 
static const Size const_base_storage
 The base storage.
 
- Protected Attributes inherited from TensorBase< R3 >
TraceableTensorShape _batch_sizes
 Traceable batch sizes.
 

Member Function Documentation

◆ contract_k()

R2 contract_k ( const Vec & v) const

R3,Vector->R2 product ijk,k->ij.

◆ levi_civita()

R3 levi_civita ( const TensorOptions & options = default_tensor_options())
staticnodiscard

Alternating symbol.

◆ operator()()

Scalar operator() ( Size i,
Size j,
Size k ) const

Accessor.