Loading...
Searching...
No Matches
MillerIndex Class Reference
Represention of a crystal direction or plane a Miller Index. More...
Detailed Description
Represention of a crystal direction or plane a Miller Index.
#include <MillerIndex.h>
Inheritance diagram for MillerIndex:
Public Member Functions | |
| MillerIndex | reduce () const |
| Reduce to the greatest common demoninator. | |
| Vec | to_vec (const torch::TensorOptions &options=default_tensor_options()) const |
| Convert back to a (real) Vec. | |
| Vec | to_normalized_vec (const torch::TensorOptions &options=default_tensor_options()) const |
| Convert back to a normalized real Vec. | |
 Public Member Functions inherited from PrimitiveTensor< MillerIndex, 3 > | |
| PrimitiveTensor ()=default | |
| Default constructor. | |
| PrimitiveTensor (const torch::Tensor &tensor, Size batch_dim) | |
| Construct from another torch::Tensor given batch dimension. | |
| PrimitiveTensor (const torch::Tensor &tensor) | |
| Construct from another torch::Tensor 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< Derived > | |
| TensorBase ()=default | |
| Default constructor. | |
| TensorBase (const torch::Tensor &tensor, Size batch_dim) | |
| Construct from another torch::Tensor. | |
| TensorBase (const Derived &tensor) | |
| Copy constructor. | |
| TensorBase (Real)=delete | |
| Derived | clone (torch::MemoryFormat memory_format=torch::MemoryFormat::Contiguous) const |
| Derived | detach () const |
| Discard function graph. | |
| Derived | to (const torch::TensorOptions &options) const |
| Change tensor options. | |
| Derived | 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. | |
| TensorShapeRef | batch_sizes () const |
| Return the batch size. | |
| Size | 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. | |
| Derived | 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. | |
| void | batch_index_put_ (indexing::TensorIndicesRef indices, const torch::Tensor &other) |
| Set values by slicing on the batch dimensions. | |
| void | base_index_put_ (indexing::TensorIndicesRef indices, const torch::Tensor &other) |
| Set values by slicing on the base dimensions. | |
| Derived | batch_expand (TensorShapeRef batch_size) const |
| neml2::Tensor | base_expand (TensorShapeRef 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 (TensorShapeRef batch_size) const |
| Return a new tensor with values broadcast along the batch dimensions. | |
| neml2::Tensor | base_expand_copy (TensorShapeRef base_size) const |
| Return a new tensor with values broadcast along the base dimensions. | |
| Derived | batch_reshape (TensorShapeRef batch_shape) const |
| Reshape batch dimensions. | |
| neml2::Tensor | base_reshape (TensorShapeRef base_shape) const |
| Reshape base dimensions. | |
| Derived | batch_unsqueeze (Size d) const |
| Unsqueeze a batch dimension. | |
| neml2::Tensor | base_unsqueeze (Size d) const |
| Unsqueeze a base dimension. | |
| Derived | batch_transpose (Size d1, Size d2) const |
| Transpose two batch dimensions. | |
| neml2::Tensor | base_transpose (Size d1, Size d2) const |
| Transpose two base dimensions. | |
Static Public Member Functions | |
| static MillerIndex | fill (Integer a, Integer b, Integer c, const torch::TensorOptions &options=default_integer_tensor_options()) |
| Most likely construction method – make from three ints. | |
| Static Public Member Functions inherited from PrimitiveTensor< MillerIndex, 3 > | |
| static MillerIndex | empty (const torch::TensorOptions &options=default_tensor_options()) |
| Unbatched empty tensor. | |
| static MillerIndex | empty (TensorShapeRef batch_shape, const torch::TensorOptions &options=default_tensor_options()) |
| Empty tensor given batch shape. | |
| static MillerIndex | zeros (const torch::TensorOptions &options=default_tensor_options()) |
| Unbatched zero tensor. | |
| static MillerIndex | zeros (TensorShapeRef batch_shape, const torch::TensorOptions &options=default_tensor_options()) |
| Zero tensor given batch shape. | |
| static MillerIndex | ones (const torch::TensorOptions &options=default_tensor_options()) |
| Unbatched unit tensor. | |
| static MillerIndex | ones (TensorShapeRef batch_shape, const torch::TensorOptions &options=default_tensor_options()) |
| Unit tensor given batch shape. | |
| static MillerIndex | full (Real init, const torch::TensorOptions &options=default_tensor_options()) |
| Unbatched tensor filled with a given value given base shape. | |
| static MillerIndex | full (TensorShapeRef batch_shape, Real init, const torch::TensorOptions &options=default_tensor_options()) |
| Full tensor given batch shape. | |
| static Tensor | identity_map (const torch::TensorOptions &) |
| Derived tensor classes should define identity_map where appropriate. | |
| Static Public Member Functions inherited from TensorBase< 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, Size nstep, Size dim=0, Size 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, Size nstep, Size dim=0, Size batch_dim=-1, Real base=10) |
| log-space equivalent of the linspace named constructor | |
Additional Inherited Members | |
| Static Public Attributes inherited from PrimitiveTensor< MillerIndex, 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. | |
Member Function Documentation
◆ fill()
|
static |
Most likely construction method – make from three ints.
◆ reduce()
| MillerIndex reduce | ( | ) | const |
Reduce to the greatest common demoninator.
◆ to_normalized_vec()
| Vec to_normalized_vec | ( | const torch::TensorOptions & | options = default_tensor_options() | ) | const |
Convert back to a normalized real Vec.
◆ to_vec()
| Vec to_vec | ( | const torch::TensorOptions & | options = default_tensor_options() | ) | const |
Convert back to a (real) Vec.
