NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
WSR4 Class Reference

The symmetric fourth order tensor, with skew symmetry in the first two dimensionss and symmetry in the second two. More...

Detailed Description

The symmetric fourth order tensor, with skew symmetry in the first two dimensionss and symmetry in the second two.

Mandel notation/reduced skew is used, and so the storage space is (3, 6).

#include <WSR4.h>

Inheritance diagram for WSR4:

Public Member Functions

 WSR4 (const R4 &F)
 
- Public Member Functions inherited from PrimitiveTensor< WSR4, 3, 6 >
 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< WSR4 >
 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 (Real)=delete
 
WSR4 variable_data () const
 
WSR4 clone () const
 
WSR4 detach () const
 Discard function graph.
 
WSR4 to (const TensorOptions &options) const
 Change tensor options.
 
WSR4 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.
 
WSR4 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.
 
WSR4 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, Real v)
 
void base_index_put_ (indexing::TensorIndicesRef indices, const ATensor &other)
 
void base_index_put_ (indexing::TensorIndicesRef indices, Real v)
 
WSR4 batch_expand (const TraceableTensorShape &batch_shape) const
 
WSR4 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.
 
WSR4 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.
 
WSR4 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.
 
WSR4 batch_reshape (const TraceableTensorShape &batch_shape) const
 Reshape batch dimensions.
 
neml2::Tensor base_reshape (TensorShapeRef base_shape) const
 Reshape base dimensions.
 
WSR4 batch_unsqueeze (Size d) const
 Unsqueeze a batch dimension.
 
neml2::Tensor base_unsqueeze (Size d) const
 Unsqueeze a base dimension.
 
WSR4 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from PrimitiveTensor< WSR4, 3, 6 >
static WSR4 create (const TensorDataContainer &data, const TensorOptions &options=default_tensor_options())
 Arbitrary tensor from a nested container with inferred batch dimension.
 
static WSR4 empty (const TensorOptions &options=default_tensor_options())
 Unbatched empty tensor.
 
static WSR4 empty (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
 Empty tensor given batch shape.
 
static WSR4 zeros (const TensorOptions &options=default_tensor_options())
 Unbatched zero tensor.
 
static WSR4 zeros (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
 Zero tensor given batch shape.
 
static WSR4 ones (const TensorOptions &options=default_tensor_options())
 Unbatched unit tensor.
 
static WSR4 ones (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options())
 Unit tensor given batch shape.
 
static WSR4 full (Real init, const TensorOptions &options=default_tensor_options())
 Unbatched tensor filled with a given value given base shape.
 
static WSR4 full (const TraceableTensorShape &batch_shape, Real 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< WSR4 >
static WSR4 empty_like (const WSR4 &other)
 
static WSR4 zeros_like (const WSR4 &other)
 Zero tensor like another, i.e. same batch and base shapes, same tensor options, etc.
 
static WSR4 ones_like (const WSR4 &other)
 Unit tensor like another, i.e. same batch and base shapes, same tensor options, etc.
 
static WSR4 full_like (const WSR4 &other, Real init)
 
static WSR4 linspace (const WSR4 &start, const WSR4 &end, Size nstep, Size dim=0)
 Create a new tensor by adding a new batch dimension with linear spacing between start and end.
 
static WSR4 logspace (const WSR4 &start, const WSR4 &end, Size nstep, Size dim=0, Real base=10)
 log-space equivalent of the linspace named constructor
 
- Static Public Attributes inherited from PrimitiveTensor< WSR4, 3, 6 >
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.
 

Constructor & Destructor Documentation

◆ WSR4()

WSR4 ( const R4 & F)