Struct Shape 

pub struct Shape { /* private fields */ }

A shape represents the dimensions of a tensor.

Internally backed by a SmallVec that stores up to 6 dimensions on the stack without heap allocation. A scalar has rank 0 (no dimensions), a vector has rank 1, a matrix has rank 2, and so on.

Shape can be created from tuples, slices, Vec<usize>, or the Shape::from_dims constructor. dims holds the per-axis bounds (a Scalar’s value, or a Range’s max/capacity); dynamic sparsely marks which axes are bounded-symbolic. dims() borrows dims unchanged; the symbolic view is extent(). The common all-concrete shape has dynamic: None. Equality includes dynamic (a symbolic shape is distinct from a concrete one with the same bounds), so DynAxis entries are kept sorted by axis.

Implementations

impl Shape

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

Creates a shape from a slice of dimension sizes.

pub fn rank(&self) -> usize

The rank is the number of dimensions, 0 for a scalar value, 1 for a vector, etc.

pub fn into_dims(self) -> Vec<usize>

Consumes the shape and returns its dimensions as a Vec<usize>.

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

The dimensions as a slice of usize — the per-axis bounds (a scalar’s value, or a dynamic axis’s capacity/max). Unchanged contract: this is what sizing, striding, and iteration want. The live value of a dynamic axis is obtained separately via Shape::extent + Extent::resolve (or Shape::resolve); it is never folded in here.

pub fn extent(&self, axis: usize) -> Extent

The Extent of axis: a Range if the axis is dynamic (carrying its min, the dims() bound as max, and its sym), else a Scalar of the bound. The symbolic view over dims(). Phase D step 1b.

pub fn extents(&self) -> impl Iterator<Item = Extent>

The Extent of every axis, in order.

pub fn has_dynamic(&self) -> bool

Whether any axis is a bounded-symbolic Range.

pub fn with_dynamic_axis(self, axis: usize, min: usize, sym: SymId) -> Shape

Mark axis as a bounded-symbolic Range [min, dims[axis]] resolved via sym. dims()[axis] stays the capacity bound; extent(axis) now reports the Range. Replaces any prior dynamic mark on axis. The KV-cache length axis uses this; K-length and V-length pass the same sym to unify.

pub fn resolve(&self, env: &SymEnv) -> Result<Shape, Error>

Resolve every dynamic axis through env, returning a fully-concrete Shape (all Scalar). Reads env at call time, so it always reflects the current bindings; never caches. Errors if a dynamic axis’s symbol is unbound. A shape with no dynamic axes resolves to a clone.

pub fn dim<D>(&self, dim: D) -> Result<usize, Error>

where D: Dim,

The dimension size for a specified dimension index.

Supports both forward indexing (usize) and backward indexing via D.

pub fn elem_count(&self) -> usize

The total number of elements, this is the product of all dimension sizes.

For a scalar (rank 0), the element count is 1.

pub fn stride_contiguous(&self) -> SmallVec<[isize; 6]>

The strides given in number of elements for a contiguous n-dimensional array using this shape. Returns signed strides (crate::StrideVec) — a contiguous layout’s strides are always non-negative, but the type is signed so callers can uniformly handle negative-stride view ops (Flip, etc.).

pub fn is_contiguous(&self, stride: &[isize]) -> bool

Returns true if the strides are C contiguous (aka row major).

pub fn is_fortran_contiguous(&self, stride: &[isize]) -> bool

Returns true if the strides are Fortran contiguous (aka column major).

pub fn extend(self, additional_dims: &[usize]) -> Shape

Modifies the shape by adding a list of additional dimensions at the end of the existing dimensions.

pub fn broadcast_shape_binary_op( &self, rhs: &Shape, op: &'static str, ) -> Result<Shape, Error>

Check whether the two shapes are compatible for broadcast, and if it is the case return the broadcasted shape. This is to be used for binary pointwise ops.

pub fn broadcast_shape_matmul( &self, rhs: &Shape, ) -> Result<(Shape, Shape), Error>

Returns the broadcasted shapes for matrix multiplication.

impl Shape

pub fn dims0(&self) -> Result<(), Error>

Extracts dimensions from a scalar (rank-0) shape.

impl Shape

pub fn dims1(&self) -> Result<usize, Error>

Extracts the single dimension from a rank-1 shape.

impl Shape

pub fn dims2(&self) -> Result<(usize, usize), Error>

Extracts the two dimensions from a rank-2 shape.

impl Shape

pub fn dims3(&self) -> Result<(usize, usize, usize), Error>

Extracts the three dimensions from a rank-3 shape.

impl Shape

pub fn dims4(&self) -> Result<(usize, usize, usize, usize), Error>

Extracts the four dimensions from a rank-4 shape.

impl Shape

pub fn dims5(&self) -> Result<(usize, usize, usize, usize, usize), Error>

Extracts the five dimensions from a rank-5 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<(), Error>

Formats the value using the given formatter.

impl Eq for Shape

impl From<&Shape> for Shape

fn from(shape: &Shape) -> Shape

Converts to this type from the input type.

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

fn from(dims: &[usize; C]) -> Shape

Converts to this type from the input type.

impl From<&[usize]> for Shape

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

Converts to this type from the input type.

impl From<()> for Shape

fn from(_: ()) -> Shape

Converts to this type from the input type.

impl From<(usize, usize)> for Shape

fn from(d: (usize, usize)) -> Shape

Converts to this type from the input type.

impl From<(usize, usize, usize)> for Shape

fn from(d: (usize, usize, usize)) -> Shape

Converts to this type from the input type.

impl From<(usize, usize, usize, usize)> for Shape

fn from(d: (usize, usize, usize, usize)) -> Shape

Converts to this type from the input type.

impl From<(usize, usize, usize, usize, usize)> for Shape

fn from(d: (usize, usize, usize, usize, usize)) -> Shape

Converts to this type from the input type.

impl From<(usize, usize, usize, usize, usize, usize)> for Shape

fn from(d: (usize, usize, usize, usize, usize, usize)) -> Shape

Converts to this type from the input type.

impl From<(usize,)> for Shape

fn from(d: (usize,)) -> Shape

Converts to this type from the input type.

impl From<SmallVec<[usize; 6]>> for Shape

fn from(dims: SmallVec<[usize; 6]>) -> Shape

Converts to this type from the input type.

impl From<Vec<usize>> for Shape

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

Converts to this type from the input type.

impl From<usize> for Shape

fn from(d1: usize) -> Shape

Converts to this type from the input type.

impl PartialEq for Shape

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Shape

impl TryInto<()> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<(), <Shape as TryInto<()>>::Error>

Performs the conversion.

impl TryInto<(usize, usize)> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<(usize, usize), <Shape as TryInto<(usize, usize)>>::Error>

Performs the conversion.

impl TryInto<(usize, usize, usize)> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<(usize, usize, usize), <Shape as TryInto<(usize, usize, usize)>>::Error>

Performs the conversion.

impl TryInto<(usize, usize, usize, usize)> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<(usize, usize, usize, usize), <Shape as TryInto<(usize, usize, usize, usize)>>::Error>

Performs the conversion.

impl TryInto<(usize, usize, usize, usize, usize)> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<(usize, usize, usize, usize, usize), <Shape as TryInto<(usize, usize, usize, usize, usize)>>::Error>

Performs the conversion.

impl TryInto<usize> for Shape

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<usize, <Shape as TryInto<usize>>::Error>

Performs the conversion.