Struct Shape 

pub struct Shape(pub Vec<usize>);

Newtype around a dimension vector that carries shape utilities.

Tuple Fields

0: Vec<usize>

Implementations

impl Shape

pub fn new(dims: impl IntoIterator<Item = usize>) -> Self

Construct from any iterator of usize.

pub fn ndim(&self) -> usize

Number of dimensions (rank).

pub fn numel(&self) -> usize

Total number of elements (product of all dims).

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

Dimension slice.

pub fn strides(&self) -> Vec<usize>

Row-major (C-contiguous) strides.

pub fn scalar() -> Self

Scalar (0-dimensional) shape.

pub fn is_scalar(&self) -> bool

Whether this is a scalar.

pub fn reshape( &self, new_dims: impl IntoIterator<Item = usize>, ) -> Result<Shape>

Reshape — ensures the total numel is unchanged.

pub fn broadcast_with(&self, other: &Shape) -> Result<Shape>

Compute the broadcast output shape of self and other (NumPy rules).

pub fn expand_dims(&self, axis: usize) -> Result<Shape>

Insert a new axis of size 1 at axis (like np.expand_dims).

pub fn squeeze(&self) -> Shape

Remove all dimensions of size 1 (like np.squeeze).

pub fn validate(&self) -> Result<()>

Validate that every dim is > 0.

pub fn flat_index(&self, idx: &[usize]) -> Result<usize>

Contiguous byte offset for a multi-index into row-major storage.

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

fn default() -> Shape

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Shape

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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(s: &[usize]) -> Self

Converts to this type from the input type.

impl From<Vec<usize>> for Shape

fn from(v: Vec<usize>) -> 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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Shape

impl StructuralPartialEq for Shape