Struct Shape

pub struct Shape(/* private fields */);

Shape of tensor

Implementations

impl Shape

pub const fn rank(&self) -> usize

Get shape’s rank

pub fn numel(&self) -> usize

Get number of elements in tensor with this shape (a product of it’s dimensions).

pub fn iter( &self, ) -> impl DoubleEndedIterator<Item = &usize> + ExactSizeIterator

Iter

pub fn iter_mut( &mut self, ) -> impl DoubleEndedIterator<Item = &mut usize> + ExactSizeIterator

Iter mut

pub fn strides(&self) -> Shape

Get shape’s strides

pub fn permute(&self, axes: &Axes) -> Self

Permute shape’s dimensions with axes

Panics

Panics if axes is incorrect.

pub fn expand_axes(&self, shape: &Shape) -> Axes

Get axes along which self was expanded to shape

pub fn reduce(self, axes: &Axes) -> Shape

Reduce self along axes

pub fn pad(self, padding: &[(i64, i64)]) -> Shape

Pad self with padding

pub fn vi64(&self) -> Vec<i64>

Get self as vector i64

Trait Implementations

impl AsRef<[usize]> for Shape

fn as_ref(&self) -> &[usize]

Converts this type into a shared reference of the (usually inferred) input type.

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 Display for Shape

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

Formats the value using the given formatter.

impl From<&[usize]> for Shape

fn from(value: &[usize]) -> Self

Converts to this type from the input type.

impl From<&Shape> for Shape

fn from(sh: &Shape) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[usize; N]> for Shape

fn from(value: [usize; N]) -> Self

Converts to this type from the input type.

impl From<Box<[usize]>> for Shape

fn from(value: Box<[usize]>) -> Self

Converts to this type from the input type.

impl From<Shape> for Vec<usize>

fn from(val: Shape) -> Self

Converts to this type from the input type.

impl From<Vec<usize>> for Shape

fn from(value: Vec<usize>) -> Self

Converts to this type from the input type.

impl From<usize> for Shape

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Index<Range<i64>> for Shape

type Output = [usize]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<i32> for Shape

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<i64> for Shape

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Shape

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Shape

type Item = &'a usize

The type of the elements being iterated over.

type IntoIter = <&'a [usize] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Shape

type Item = &'a mut usize

The type of the elements being iterated over.

type IntoIter = <&'a mut [usize] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Shape

fn cmp(&self, other: &Shape) -> 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.

impl PartialEq<[usize]> for Shape

fn eq(&self, other: &[usize]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const RANK: usize> PartialEq<[usize; RANK]> for Shape

fn eq(&self, other: &[usize; RANK]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Shape

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd 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

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 Eq for Shape

impl StructuralPartialEq for Shape