Struct zyx::shape::Shape

pub struct Shape(_);

Shape

Stores size of dimensions of multidimensional data structures.

Implementations

impl Shape

pub fn strides(&self) -> Shape

Get Shape strides

pub fn argsort(&self) -> Dims

Returns the indices that sort Shape in ascending order

pub fn numel(&self) -> usize

Get Shape’s number of elements. This is just a product of all Shape’s dimensions.

pub fn ndim(&self) -> usize

Get number of Shape’s dimensions.

pub fn is_empty(&self) -> bool

Check if the Shape is empty

Trait Implementations

impl Clone for Shape

fn clone(&self) -> Shape

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Shape

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

Formats the value using the given formatter.

impl Default for Shape

fn default() -> Shape

Returns the “default value” for a type.

impl Display for Shape

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

Formats the value using the given formatter.

impl Index<Range<usize>> for Shape

type Output = [usize]

The returned type after indexing.

fn index(&self, idx: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<i32> for Shape

type Output = usize

The returned type after indexing.

fn index(&self, idx: i32) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Shape

type Output = usize

The returned type after indexing.

fn index(&self, idx: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<i32> for Shape

fn index_mut(&mut self, idx: i32) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Shape

fn index_mut(&mut self, idx: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for Shape

type Item = usize

The type of the elements being iterated over.

type IntoIter = IntoIter<<Shape as IntoIterator>::Item, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoShape for Shape

fn shape(self) -> Shape

Turn input into Shape

impl IntoVec<usize> for Shape

fn to_vec(&self) -> Vec<usize>

Returns values from tensor as a Vec with row-major order.

impl Ord for Shape

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<Other> PartialEq<Other> for Shapewhere
    Other: IntoShape + Clone,

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Shape> for Shape

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Permute for Shape

type Output = Shape

Output of the Permute operation.

fn permute(self, dims: impl IntoDims) -> Self::Output

Apply Permute operation on given input.

impl Eq for Shape

impl StructuralEq for Shape