Struct Shape

pub struct Shape { /* private fields */ }

A shape is a Slice with labeled dimensions and a selection API.

Implementations

impl Shape

pub fn new(labels: Vec<String>, slice: Slice) -> Result<Shape, ShapeError>

Creates a new shape with the provided labels, which describe the provided Slice.

Shapes can also be constructed by way of the [shape] macro, which creates a by-construction correct slice in row-major order given a set of sized dimensions.

pub fn at(&self, label: &str, index: usize) -> Result<Shape, ShapeError>

Select a single index along a named dimension, removing that dimension entirely. This reduces the dimensionality by 1. In effect it results in a cross section of the shape at the given index in the given dimension.

pub fn select<R>(&self, label: &str, range: R) -> Result<Shape, ShapeError>

where R: Into<Range>,

Restrict this shape along a named dimension using a Range. The provided range must be nonempty.

select is composable, it can be applied repeatedly, even on the same dimension, to refine the view incrementally.

pub fn select_iter(&self, dims: usize) -> Result<SelectIterator<'_>, ShapeError>

Produces an iterator over subshapes by fixing the first dims dimensions.

For a shape of rank n, this yields ∏ sizes[0..dims] subshapes, each with the first dims dimensions restricted to size 1. The remaining dimensions are left unconstrained.

This is useful for structured traversal of slices within a multidimensional shape. See SelectIterator for details and examples.

Errors

Returns an error if dims == 0 or dims >= self.rank().

pub fn index(&self, indices: Vec<(String, usize)>) -> Result<Shape, ShapeError>

Sub-set this shape by select a particular row of the given indices The resulting shape will no longer have dimensions for the given indices Example shape.index(vec![(“gpu”, 3), (“host”, 0)])

pub fn labels(&self) -> &[String]

The per-dimension labels of this shape.

pub fn slice(&self) -> &Slice

The slice describing the shape.

pub fn coordinates( &self, rank: usize, ) -> Result<Vec<(String, usize)>, ShapeError>

Return a set of labeled coordinates for the given rank.

pub fn dim(&self, label: &str) -> Result<usize, ShapeError>

pub fn unity() -> Shape

Return the 0-dimensional single element shape

pub fn extent(&self) -> Extent

The extent corresponding to this 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<'de> Deserialize<'de> for Shape

fn deserialize<__D>( __deserializer: __D, ) -> Result<Shape, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Shape

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

Formats the value using the given formatter.

impl Hash for Shape

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

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

fn reshape(&self, limit: Limit) -> ReshapedShape

Produces a reshaped version of the shape with expanded dimensions under the given size limit.

impl Serialize for Shape

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Shape