Skip to main content

ShapeTuple

Enum ShapeTuple 

Source
pub enum ShapeTuple {
    Leaf(usize),
    Nested(Vec<ShapeTuple>),
}
Expand description

Hierarchical shape tuple (plan #38). Borrowed from MAX’s layout/int_tuple.mojo: shapes nest, so a ((B, S), (H, D)) expression captures the “outer batch+seq, inner heads+head_dim” structure of a tiled layout. Useful for kernels that want to reason about block-tiled sweeps without re-deriving the implied stride math each time.

Stays alongside the existing flat crate::Shape (which is what every op carries today). New code that benefits from hierarchy uses ShapeTuple; we don’t migrate Shape because the entire codebase is built around it and the win is concentrated in advanced layout / fusion code.

Variants§

§

Leaf(usize)

Single concrete dimension.

§

Nested(Vec<ShapeTuple>)

Ordered list of sub-tuples. Nesting is unbounded.

Implementations§

Source§

impl ShapeTuple

Source

pub fn leaf(n: usize) -> Self

One-dim leaf. ShapeTuple::leaf(8).

Source

pub fn nested(parts: Vec<ShapeTuple>) -> Self

Wrapping constructor for nested layouts.

Source

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

Convenience: build a flat tuple from &[usize]. Each element becomes a Leaf. flat(&[2, 3, 4]) is equivalent to Nested(vec![Leaf(2), Leaf(3), Leaf(4)]).

Source

pub fn is_leaf(&self) -> bool

Source

pub fn rank(&self) -> usize

Top-level rank. Leaves are rank 1; nested tuples are the length of the outer list.

Source

pub fn product(&self) -> usize

Total element count, traversing the entire hierarchy.

Source

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

Flatten into a row-major sequence of leaves. Useful when converting to the existing Shape type.

Source

pub fn get(&self, path: &[usize]) -> Option<&ShapeTuple>

Walk a path of indices through the hierarchy. Returns the sub-tuple at path or None if the path goes out of bounds at any level.

[] returns Some(self); [0] returns the first child.

Trait Implementations§

Source§

impl Clone for ShapeTuple

Source§

fn clone(&self) -> ShapeTuple

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ShapeTuple

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ShapeTuple

Source§

impl PartialEq for ShapeTuple

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ShapeTuple

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.