Struct Shape 

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

The extents of a tensor, one entry per dimension, outermost first (row-major convention throughout the project).

A rank-0 shape ([]) is a scalar and is valid. A dimension of size 0 is valid and makes the element count 0.

Implementations

impl Shape

pub fn new(dims: Vec<usize>) -> Self

Wrap dimension extents as a shape.

pub fn dims(&self) -> &[usize]

The dimension extents, outermost first.

pub fn ndim(&self) -> usize

The rank (number of dimensions).

pub fn numel(&self) -> usize

The total number of elements.

A scalar has 1 element; any zero-sized dimension makes this 0.

pub fn checked_numel(&self) -> Option<usize>

Total number of elements, or None when the product of the dimensions does not fit in usize.

Every constructor that accepts a caller-supplied shape validates with this before allocating: a wrapped product would let a shape claim 2^64 elements over an empty buffer and pass the data.len() == numel check (a reported class of bug); with the check, such a shape is a typed error instead.

Trait Implementations

impl Clone for Shape

fn clone(&self) -> Shape

Returns a duplicate 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 Eq for Shape

impl From<&[usize]> for Shape

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

Converts to this type from the input type.

impl From<Vec<usize>> for Shape

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Hash for Shape

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

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Shape