Struct Shape 

pub struct Shape { /* private fields */ }

Shape of an n-dimensional array.

Represented as a vector of dimensions. An empty vector represents a scalar.

Implementations

impl Shape

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

Create a new shape from dimensions.

Examples

let shape = Shape::new(vec![2, 3, 4]);
assert_eq!(shape.ndim(), 3);
assert_eq!(shape.size(), 24);

pub fn scalar() -> Self

Create a scalar shape (empty dimensions).

pub fn ndim(&self) -> usize

Returns the number of dimensions.

pub fn size(&self) -> usize

Returns the total number of elements.

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

Returns a slice of the dimensions.

pub fn is_scalar(&self) -> bool

Returns true if this is a scalar shape.

pub fn get(&self, index: usize) -> Option<usize>

Get a specific dimension, or None if out of bounds.

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

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

Examples

let shape = Shape::new(vec![2, 3, 4]);
let strides = shape.default_strides();
assert_eq!(strides, vec![12, 4, 1]);

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

Check if two shapes are broadcast-compatible and return the result shape.

Following NumPy broadcasting rules: dimensions are compatible if they are equal or one of them is 1.

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