Loading...
Searching...
No Matches
Scalar Class Reference
Detailed Description
The storage space is (), i.e., scalar.
#include <Scalar.h>
Inheritance diagram for Scalar:
Public Member Functions | |
| Scalar (const CScalar &init, const TensorOptions &options) | |
| neml2::Tensor | base_unsqueeze_to (Size n) const |
| Expand base dimension to a given size. | |
 Public Member Functions inherited from PrimitiveTensor< Scalar > | |
| 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< Scalar > | |
| 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 | |
| Scalar | variable_data () const |
| Scalar | clone () const |
| Scalar | detach () const |
| Discard function graph. | |
| Scalar | to (const TensorOptions &options) const |
| Change tensor options. | |
| Scalar | 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 TraceableTensorShape & | batch_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. | |
| Scalar | 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. | |
| Scalar | 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) |
| Scalar | batch_expand (const TraceableTensorShape &batch_shape) const |
| Scalar | 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. | |
| Scalar | 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. | |
| Scalar | 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. | |
| Scalar | batch_reshape (const TraceableTensorShape &batch_shape) const |
| Reshape batch dimensions. | |
| neml2::Tensor | base_reshape (TensorShapeRef base_shape) const |
| Reshape base dimensions. | |
| Scalar | batch_unsqueeze (Size d) const |
| Unsqueeze a batch dimension. | |
| neml2::Tensor | base_unsqueeze (Size d) const |
| Unsqueeze a base dimension. | |
| Scalar | 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 Scalar | identity_map (const TensorOptions &options=default_tensor_options()) |
| The derivative of a Scalar with respect to itself. | |
| Static Public Member Functions inherited from PrimitiveTensor< Scalar > | |
| static Scalar | create (const TensorDataContainer &data, const TensorOptions &options=default_tensor_options()) |
| Arbitrary tensor from a nested container with inferred batch dimension. | |
| static Scalar | empty (const TensorOptions &options=default_tensor_options()) |
| Unbatched empty tensor. | |
| static Scalar | empty (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options()) |
| Empty tensor given batch shape. | |
| static Scalar | zeros (const TensorOptions &options=default_tensor_options()) |
| Unbatched zero tensor. | |
| static Scalar | zeros (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options()) |
| Zero tensor given batch shape. | |
| static Scalar | ones (const TensorOptions &options=default_tensor_options()) |
| Unbatched unit tensor. | |
| static Scalar | ones (const TraceableTensorShape &batch_shape, const TensorOptions &options=default_tensor_options()) |
| Unit tensor given batch shape. | |
| static Scalar | full (const CScalar &init, const TensorOptions &options=default_tensor_options()) |
| Unbatched tensor filled with a given value given base shape. | |
| static Scalar | 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< Scalar > | |
| static Scalar | empty_like (const Scalar &other) |
| static Scalar | zeros_like (const Scalar &other) |
| Zero tensor like another, i.e. same batch and base shapes, same tensor options, etc. | |
| static Scalar | ones_like (const Scalar &other) |
| Unit tensor like another, i.e. same batch and base shapes, same tensor options, etc. | |
| static Scalar | full_like (const Scalar &other, const CScalar &init) |
| static Scalar | linspace (const Scalar &start, const Scalar &end, Size nstep, Size dim=0) |
Create a new tensor by adding a new batch dimension with linear spacing between start and end. | |
| static Scalar | logspace (const Scalar &start, const Scalar &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< Scalar > | |
| 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< Scalar > | |
| TraceableTensorShape | _batch_sizes |
| Traceable batch sizes. | |
Constructor & Destructor Documentation
◆ Scalar()
| Scalar | ( | const CScalar & | init, |
| const TensorOptions & | options ) |
Member Function Documentation
◆ base_unsqueeze_to()
| neml2::Tensor base_unsqueeze_to | ( | Size | n | ) | const |
Expand base dimension to a given size.
◆ identity_map()
|
staticnodiscard |
The derivative of a Scalar with respect to itself.
