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 unity() -> Extent

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 rank_of_coords(&self, coords: &[usize]) -> Result<usize, PointError>

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

Creates a Point in this extent from the given coordinate vector.

The coordinates are interpreted in row-major order against self.sizes(). This constructor does not store the coordinates; it computes the linear rank and returns a Point that stores { rank, extent }.

Errors

Returns:

• PointError::DimMismatch if coords.len() != self.len().
• PointError::OutOfRangeIndex if any coordinate `coords[i]

  = self.sizes()[i]`.

Examples

use ndslice::extent;

let ext = extent!(x = 2, y = 3, z = 4);
let p = ext.point(vec![1, 2, 3]).unwrap();
assert_eq!(p.rank(), 1 * (3 * 4) + 2 * 4 + 3); // row-major
assert_eq!(p.coords(), vec![1, 2, 3]);

Dimension mismatch:

use ndslice::PointError;
use ndslice::extent;

let ext = extent!(x = 2, y = 3);
let err = ext.point(vec![1]).unwrap_err();
matches!(err, PointError::DimMismatch { .. });

Coordinate out of range:

use ndslice::PointError;
use ndslice::extent;

let ext = extent!(x = 2, y = 3);
let err = ext.point(vec![1, 3]).unwrap_err(); // y size is 3, max index is 2
matches!(err, PointError::OutOfRangeIndex { .. });

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

Returns the Point corresponding to the given linearized rank within this extent, using row-major order.

Errors

Returns PointError::OutOfRangeRank if rank >= self.num_ranks(), i.e. when the requested rank lies outside the bounds of this extent.

Examples

use ndslice::extent;

let ext = extent!(x = 2, y = 3);
assert_eq!(ext.num_ranks(), 6);

let p = ext.point_of_rank(4).unwrap();
assert_eq!(p.coords(), vec![1, 1]); // row-major: x=1, y=1
assert_eq!(p.rank(), 4);

assert!(ext.point_of_rank(6).is_err()); // out of range

pub fn len(&self) -> usize

Returns the number of dimensions in this extent.

For example, an extent defined as (x=2, y=3, z=4) has dimensionality 3.

pub fn is_empty(&self) -> bool

Returns true if this extent has zero dimensions.

A 0-dimensional extent corresponds to the scalar case: a coordinate space with exactly one rank (the empty tuple []).

pub fn num_ranks(&self) -> usize

Returns the total number of ranks (points) in this extent.

This is the product of all dimension sizes, i.e. the number of distinct coordinates in row-major order.

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 extent’s labels and sizes.

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

Iterate points in this extent.

pub fn concat(&self, other: &Extent) -> Result<Self, ExtentError>

Append the dimensions of other to this extent, preserving order.

Duplicate labels are not allowed: if any label in other already appears in self, this returns ExtentError::OverlappingLabel.

This operation is not commutative: a.concat(&b) may differ from b.concat(&a).

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

Formats an Extent as a compact map‐literal:

{label: size, label: size, ...}

Grammar

Extent   := "{" [ Pair ( "," Pair )* ] "}"
Pair     := Label ": " Size
Label    := SafeIdent | Quoted
SafeIdent:= [A-Za-z0-9_]+
Quoted   := "\"" ( [^"\\] | "\\" . )* "\""
Size     := [0-9]+

Quoting rules

• Labels that are not SafeIdent are rendered using Rust string literal syntax (via format!("{:?}", label)), e.g. "dim/0" or "x y".
• “Safe” means ASCII alphanumeric or underscore ([A-Za-z0-9_]+). Everything else is quoted. This keeps common identifiers unquoted and unambiguous.

Examples

{x: 4, y: 5, z: 6}
{"dim/0": 3, "dim,1": 5}
{}

Implementation note: label rendering goes through fmt_label, which emits the label as-is for safe idents, otherwise as a Rust string literal.

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

Formats the value using the given formatter.

impl From<&Shape> for Extent

fn from(s: &Shape) -> Self

Converts to this type from the input type.

impl From<Extent> for Region

fn from(extent: Extent) -> Self

Converts to this type from the input type.

impl From<Shape> for Extent

fn from(s: Shape) -> 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 View for Extent

An Extent is also a View.

type Item = usize

The type of item is the rank itself.

type View = Region

The type of sub-view can be a Region, since Extent can only describe a complete space.

fn region(&self) -> Region

The ranks contained in this view.

fn subset(&self, region: Region) -> Result<Region, ViewError>

Subsets this view with the provided ranks. This is mainly used by combinators on Views themselves. The set of ranks passed in must be a subset of the ranks of the base view.

fn get(&self, rank: usize) -> Option<Self::Item>

Retrieve the item corresponding to the given rank in the Region of this view. An implementation MUST return a value for all ranks defined in this view.

impl Eq for Extent

impl StructuralPartialEq for Extent