Struct Metadata 

pub struct Metadata {
    pub shape: Shape,
    pub strides: Strides,
    pub tiling: Tiling,
}

Fields

shape: Shape

strides: Strides

tiling: Tiling

How many fragments each logical dim is stored as; untiled by default. The shape and strides stay physical. See Tiling.

Implementations

impl Metadata

pub fn new(shape: impl Into<Shape>, strides: impl Into<Strides>) -> Metadata

pub fn with_tiling(self, tiling: Tiling) -> Result<Metadata, MetadataError>

This metadata with tiling labelling its physical dims.

Errors

When tiling does not describe this rank: see Tiling::new.

pub fn is_tiled(&self) -> bool

Whether any logical dim is stored as more than one fragment.

pub fn logical_rank(&self) -> Result<usize, MetadataError>

How many dims this buffer stands for: its rank, less the extra fragments the tiling splits dims into.

Errors

When the tiling does not fit this rank: see Tiling::logical_rank.

pub fn logical_shape(&self) -> Result<Shape, MetadataError>

The extents this buffer stands for: each logical dim’s fragments multiplied back together, in logical order. An untiled metadata gives its shape unchanged.

Errors

When the tiling does not fit this rank: see Tiling::logical_rank.

pub fn shape(&self) -> &Shape

pub fn shape_mut(&mut self) -> &mut Shape

The shape, to rewrite in place. A storage-tiled tensor’s dims are its tiling’s fragments, which a rewrite would leave stale, so it refuses like the dim-changing ops do.

pub fn strides(&self) -> &Strides

pub fn strides_mut(&mut self) -> &mut Strides

The strides, to rewrite in place. Refuses on a storage-tiled tensor, as shape_mut does: its strides step its tiles, and a rewrite would keep the tiling over strides that no longer do.

pub fn rank(&self) -> usize

pub fn num_dims(&self) -> usize

pub fn num_elements(&self) -> usize

Returns the total number of elements of a tensor having this shape

pub fn swapped(self, dim0: usize, dim1: usize) -> Metadata

pub fn swap(&mut self, dim0: usize, dim1: usize)

pub fn permute(&mut self, axes: &[usize]) -> Result<(), MetadataError>

Reorder the shape dimensions according to the permutation of axes.

pub fn permuted(self, axes: &[usize]) -> Result<Metadata, MetadataError>

pub fn insert(&mut self, index: usize, shape: usize, stride: usize)

Insert a dimension of shape with stride at position index.

pub fn remove(&mut self, index: usize) -> (usize, usize)

Remove and return the dimension at position index from the metadata.

pub fn push(&mut self, shape: usize, stride: usize)

Appends a dimension of shape with stride to the back of the metadata.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Metadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

fn deserialize<__D>( __deserializer: __D, ) -> Result<Metadata, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Metadata

impl Hash for Metadata

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Metadata

fn cmp(&self, other: &Metadata) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Metadata

fn eq(&self, other: &Metadata) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Metadata

fn partial_cmp(&self, other: &Metadata) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Metadata

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Metadata