Struct Shape 

pub struct Shape { /* private fields */ }

Dimension extents for a tensor (e.g. [batch, rows, cols]).

Stored inline (stack-allocated) for rank ≤ 8, heap-allocated otherwise.

This struct is Send and Sync because all its components (usize and smallvec::SmallVec) are Send and Sync.

Implementations

impl Shape

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

Constructs a Shape from a slice of dimension extents.

pub fn rank(&self) -> usize

Returns the number of dimensions (rank).

pub fn numel(&self) -> usize

Returns the total number of elements (product of all dimensions).

Returns 1 for a scalar (rank-0) shape.

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

Returns a slice of dimension extents.

pub fn row_major_strides(&self) -> Strides

Computes row-major (C-order) strides for this shape.

For a shape [d0, d1, d2, …, dn] the strides are [d1*d2*…*dn, d2*…*dn, …, dn, 1].

Broadcasting dimensions (size == 1) receive stride 0 so that their element is reused without copying.

pub fn broadcast_compatible(&self, other: &Self) -> bool

Returns true if the two shapes are broadcast-compatible.

Shapes are broadcast-compatible if, after right-aligning them, every pair of dimensions is either equal or one of them is 1.

pub fn broadcast_output(&self, other: &Self) -> Option<Self>

Returns the output shape after broadcasting two shapes together.

Errors

Returns None if the shapes are not broadcast-compatible.

pub fn scalar() -> Self

Returns a scalar (rank-0) shape.

pub fn vector(n: usize) -> Self

Returns a 1-D shape with n elements.

pub fn matrix(rows: usize, cols: usize) -> Self

Returns a 2-D matrix shape.

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

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

Formats the value using the given formatter.

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

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

impl StructuralPartialEq for Shape