Struct Layout 

pub struct Layout { /* private fields */ }

An array’s shape, with optional keys and a name for each axis. A layout with no keys or names holds no Meta.

Implementations

impl Layout

pub const EMPTY: Self

The layout of a rank-0 array.

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

pub fn count(&self) -> usize

The number of items in an array of this layout (count).

pub fn names(&self) -> &[Option<Arc<str>>]

The name of each axis, with None for an axis without one. Empty when no axis has a name (has_names).

pub fn name(&self, axis: usize) -> Option<&Arc<str>>

pub fn axis_named(&self, name: &str) -> Option<usize>

The axis named name, if there is one.

pub fn with_names(self, names: Vec<Option<Arc<str>>>) -> Result<Self, Error>

The layout with names on its axes. A Rank error when the count differs from the rank, and a Domain error when a name repeats.

pub fn inherit_names(self, names: Vec<Option<Arc<str>>>) -> Self

The layout with names, which the caller has checked: one for each axis, or none.

pub fn unique_names(self) -> Self

The layout without any name that appears on more than one axis.

pub fn has_keys(&self) -> bool

pub fn has_names(&self) -> bool

Whether any axis has a name.

pub fn plain(&self) -> bool

Whether the layout has no keys or names.

pub fn keys(&self, axis: usize) -> Option<&Arc<Keys>>

pub fn all_keys(&self) -> Vec<Option<Arc<Keys>>>

The keys of every axis, with None for an axis without them.

pub fn matches(&self, other: &Self) -> bool

Whether shapes, assigned axis names and assigned keys match. An unlabelled axis matches either label set.

pub fn without_keys(self, axis: usize) -> Self

The layout without keys on axis.

pub fn with_keys(self, keys: Vec<Option<Arc<Keys>>>) -> Result<Self, Error>

The layout with keys on its axes. A Rank error when the count differs from the rank, and a Length error when an axis’s keys differ from its length.

pub fn axes(&self, axes: impl Iterator<Item = usize> + Clone) -> Self

The layout of axes, in that order.

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

This layout’s axes, then other’s.

pub fn contracted(&self, right: &Self) -> Self

The layout of a product such as +.×, which contracts the last axis of a left argument of this layout with the first axis of a right argument of right.

pub fn merged(&self, axes: Range<usize>, len: usize) -> Self

The layout with the axes in axes merged into one axis of len positions, which has no keys or name. An empty range adds that axis.

pub fn select( &self, axis: usize, positions: impl ExactSizeIterator<Item = Option<usize>>, ) -> Result<Self, Error>

The layout with axis holding the positions it reads at positions, keeping their keys. None reads no position and has no key. A repeated key leaves the axis without keys.

pub fn append( &mut self, len: usize, names: Option<&[Option<Arc<str>>]>, ) -> Result<(), Error>

Grows the first axis by len positions. names gives their keys. A Domain error, with the layout unchanged, when one of them is already on that axis or appears twice.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Layout

impl<S: Into<Shape>> From<S> for Layout

fn from(shape: S) -> Self

Converts to this type from the input type.

impl PartialEq for Layout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Layout