Struct Dimensions 

pub struct Dimensions { /* private fields */ }

An ordered list of named axes, C-order. Cheap to clone.

Rank 0 (no axes) describes a scalar: one logical element.

Implementations

impl Dimensions

pub fn try_new( dims: impl IntoIterator<Item = impl Into<Dimension>>, ) -> Result<Self>

Create dimensions, validating that axis names are non-empty and unique.

pub fn scalar() -> Self

Rank-0 dimensions describing a scalar.

pub fn rank(&self) -> usize

The number of axes.

pub fn is_scalar(&self) -> bool

True for rank 0.

pub fn iter(&self) -> Iter<'_, Dimension>

The axes, outermost first.

pub fn as_slice(&self) -> &[Dimension]

The axes as a slice.

pub fn get(&self, axis: usize) -> Option<&Dimension>

The dimension at axis, if present.

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

The size of each axis.

pub fn names(&self) -> Vec<&str>

The name of each axis.

pub fn num_elements(&self) -> usize

Total number of logical elements (1 for a scalar, 0 if any axis is empty).

pub fn checked_num_elements(&self) -> Option<usize>

Like Self::num_elements, but None on usize overflow.

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

The axis of name, if present.

pub fn contains(&self, name: &str) -> bool

True when dimension name exists.

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

The axis of name, or an error that names the dimensions.

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

The size of dimension name, if present.

pub fn broadcast(all: &[&Dimensions]) -> Result<Dimensions>

The broadcast result of several dimension sets, xarray style.

Axes align by name. The order follows the first appearance of each name. Sizes must be equal, or one of them must be 1.

pub fn check_broadcast_to(&self, target: &Dimensions) -> Result<()>

Fails when an array of these dimensions cannot broadcast onto target: each axis must be in target, with the same size or with size 1.

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

C-order (row-major) strides, in elements.

Trait Implementations

impl Clone for Dimensions

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 Dimensions

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

Formats the value using the given formatter.

impl Default for Dimensions

fn default() -> Self

Returns the “default value” for a type.

impl Display for Dimensions

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

Formats the value using the given formatter.

impl Eq for Dimensions

impl Hash for Dimensions

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<'a> IntoIterator for &'a Dimensions

type Item = &'a Dimension

The type of the elements being iterated over.

type IntoIter = Iter<'a, Dimension>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Dimensions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Dimensions