Struct Shape

pub struct Shape {
    pub dims: Vec<Size>,
}

A shape with each dimension corresponding to Size.

Use one of the constructor Shape::new, one of the utilities Shape::single, Shape::fixed, Shape::ones or the the shape! macro to conveniently construct one:

// these are all equivalent
shape![Size::BATCH, 16, 8, 8];
Shape::new(vec![Size::BATCH, 16.into(), 8.into(), 8.into()]);
Shape::new(vec![Size::BATCH, Size::fixed(16), Size::fixed(8), Size::fixed(8)]);

Fields

dims: Vec<Size>

Implementations

impl Shape

pub const SCALAR: Shape

pub fn new(dims: Vec<Size>) -> Shape

pub fn single(size: Size) -> Shape

pub fn fixed(dims: &[usize]) -> Shape

pub fn ones(rank: usize) -> Shape

pub fn zeros(rank: usize) -> Shape

pub fn rank(&self) -> usize

pub fn assert_has_axis(&self, axis: usize)

pub fn as_fixed(&self) -> Option<ConcreteShape>

pub fn unwrap_fixed(&self, what: &str) -> ConcreteShape

pub fn eval(&self, batch_size: usize) -> ConcreteShape

pub fn size(&self) -> Size

pub fn unwrap_1(&self) -> Size

pub fn unwrap_2(&self) -> [Size; 2]

pub fn unwrap_3(&self) -> [Size; 3]

pub fn unwrap_4(&self) -> [Size; 4]

pub fn concat(self, other: &Shape) -> Shape

pub fn batched(&self) -> Shape

pub fn replace(&self, axis: usize, replacement: Shape) -> Shape

Build a new shape with the shape at axis replaced by replacement, the rest are kept as-is.

pub fn replace_all(&self, axes: &[usize], replacement: Shape) -> Shape

pub fn keep(&self, axis: usize, rest: Size) -> Shape

Build a new shape with the shape at axis kept and all other axes replaced by rest.

pub fn repeat_unary(&self, axis: usize, new_size: Size) -> Shape

pub fn insert(&self, axis: usize, size: Size) -> Shape

pub fn split(&self, index: usize) -> (Shape, Shape)

Trait Implementations

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 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 Index<usize> for Shape

type Output = Size

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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