Struct Extent

pub struct Extent { /* private fields */ }

Extent defines the logical shape of a multidimensional space by assigning a size to each named dimension. It abstracts away memory layout and focuses solely on structure — what dimensions exist and how many elements each contains.

Conceptually, it corresponds to a coordinate space in the mathematical sense.

Implementations

impl Extent

pub fn new(labels: Vec<String>, sizes: Vec<usize>) -> Result<Self, ExtentError>

Creates a new Extent from the given labels and sizes.

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

Returns the ordered list of dimension labels in this extent.

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

Returns the dimension sizes, ordered to match the labels.

pub fn size(&self, label: &str) -> Option<usize>

Returns the size of the dimension with the given label, if it exists.

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

Returns the position of the dimension with the given label, if it exists exists.

pub fn point(&self, coords: Vec<usize>) -> Result<Point, PointError>

Creates a Point in this extent with the given coordinates.

Returns an error if the coordinate dimensionality does not match.

pub fn point_of_rank(&self, rank: usize) -> Result<Point, PointError>

Returns the point corresponding to the provided rank in this extent.

pub fn len(&self) -> usize

The number of dimensions in the extent.

pub fn is_empty(&self) -> bool

Whether the extent has zero dimensionbs.

pub fn num_ranks(&self) -> usize

The number of ranks in the extent.

pub fn into_inner(self) -> (Vec<String>, Vec<usize>)

Convert this extent into its labels and sizes.

pub fn to_slice(&self) -> Slice

Creates a slice representing the full extent.

pub fn iter(&self) -> impl Iterator<Item = (String, usize)> + use<'_>

Iterate over this extens labels and sizes.

pub fn points(&self) -> ExtentPointsIterator<'_>

Iterate points in this extent.

Trait Implementations

impl Clone for Extent

fn clone(&self) -> Extent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Extent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Extent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Extent

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

Formats the value using the given formatter.

impl From<Extent> for View

fn from(extent: Extent) -> Self

Converts to this type from the input type.

impl Hash for Extent

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 PartialEq for Extent

fn eq(&self, other: &Extent) -> 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 Serialize for Extent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Viewable for Extent

fn labels(&self) -> Vec<String>

The labels of the dimensions in this view.

fn slice(&self) -> Slice

The slice representing this view. Note: this representation may change.

impl Eq for Extent

impl StructuralPartialEq for Extent