Struct Array 

pub struct Array<D, const RANK: usize> { /* private fields */ }

🗃️ 🫗 A logical array over backing storage.

---

^{📍 data/layout/array::Array}

^{📦 size_of::<Array<[u8; 6], 1>>() == 20 bytes / 160 bits #️⃣ #[cfg(target_pointer_width = “32”)] ⚗️Option<T> ❗🟰 T}

^{📦 size_of::<Array<[u8; 6], 2>>() == 28 bytes / 224 bits #️⃣ #[cfg(target_pointer_width = “32”)] ⚗️Option<T> ❗🟰 T}

^{📦 size_of::<Array<[u8; 6], 3>>() == 36 bytes / 288 bits #️⃣ #[cfg(target_pointer_width = “32”)] ⚗️Option<T> ❗🟰 T}

^{📦 size_of::<Array<[u8; 6], 1>>() == 32 bytes / 256 bits #️⃣ #[cfg(target_pointer_width = “64”)] ⚗️Option<T> ❗🟰 T}

^{📦 size_of::<Array<[u8; 6], 2>>() == 48 bytes / 384 bits #️⃣ #[cfg(target_pointer_width = “64”)] ⚗️Option<T> ❗🟰 T}

^{📦 size_of::<Array<[u8; 6], 3>>() == 64 bytes / 512 bits #️⃣ #[cfg(target_pointer_width = “64”)] ⚗️Option<T> ❗🟰 T}

---

An array joins:

• backing data of type D;
• an ArrayLayout mapping logical coordinates into that data.

D determines whether the array borrows or owns its storage, whether access is shared or exclusive, and whether the storage length is fixed or dynamically determined.

Invariant

Every physical storage position addressed by layout must be accessible through data.

The provided constructors preserve this relationship.

Examples

º

use devela::{ArrayLayout, ArrayShape, Array};

let storage = [0, 1, 2, 3, 4, 5];
let shape = ArrayShape::new([2, 3]);
let layout = ArrayLayout::dense_last(shape)?;
let view = Array::try_from_slice_ref(&storage, layout)?;

assert_eq!(view.get([1, 2]).copied(), Some(5));

Implementations

impl<D, const RANK: usize> Array<D, RANK>

pub const fn data(&self) -> &D

Returns a shared reference to the backing data.

pub const fn layout(&self) -> ArrayLayout<RANK>

Returns the array layout.

pub fn into_data(self) -> D

Consumes the array and returns its backing data.

pub fn into_parts(self) -> (D, ArrayLayout<RANK>)

Decomposes the array into its backing data and layout.

pub const fn shape(&self) -> ArrayShape<RANK>

Returns the logical shape.

pub const fn rank(&self) -> usize

Returns the number of logical axes.

pub const fn element_count(&self) -> usize

Returns the number of logical elements.

pub const fn is_empty(&self) -> bool

Returns whether the logical array has no elements.

pub const fn coords(&self) -> ArrayCoordIter<RANK>

Returns an iterator over every logical coordinate of this array.

Coordinates are independent of physical offset, strides, backing-storage order, and ownership.

impl<T, const LEN: usize, const RANK: usize> Array<[T; LEN], RANK>

Methods over a fixed native array.

pub fn try_from_array( storage: [T; LEN], layout: ArrayLayout<RANK>, ) -> Result<Self, MismatchedCapacity>

Creates an owning array over the fixed native storage.

Extra backing elements are permitted.

Errors

Returns MismatchedCapacity if storage does not cover every physical position addressed by layout.

pub const fn try_from_array_copy( storage: [T; LEN], layout: ArrayLayout<RANK>, ) -> Result<Self, MismatchedCapacity>

where T: Copy,

Creates an owning array over a fixed native backing array in const contexts.

This is the T: Copy counterpart of try_from_array. Extra backing elements are permitted.

Errors

Returns MismatchedCapacity if storage does not cover every physical position addressed by layout.

pub const fn storage(&self) -> &[T]

Returns the complete physical backing slice.

This is not necessarily the array’s logical ravel order.

pub const fn storage_mut(&mut self) -> &mut [T]

Returns the complete exclusive physical backing slice.

pub const fn data_mut(&mut self) -> &mut [T; LEN]

Returns exclusive access to the fixed native backing array.

Unlike dynamically sized backing storage, exposing this value cannot change the physical storage length.

pub const fn storage_len(&self) -> usize

Returns the backing-storage length.

pub const fn get(&self, coord: [usize; RANK]) -> Option<&T>

Returns a shared reference to the element at coord.

Returns None if the coordinate is outside the logical shape.

pub const fn get_mut(&mut self, coord: [usize; RANK]) -> Option<&mut T>

Returns an exclusive reference to the element at coord.

Returns None if the coordinate is outside the logical shape.

pub const fn reborrow(&self) -> Array<&[T], RANK>

Returns a shared slice-backed array reborrowed from this array.

pub const fn reborrow_mut(&mut self) -> Array<&mut [T], RANK>

Returns an exclusive slice-backed array reborrowed from this array.

impl<'a, T, const RANK: usize> Array<&'a [T], RANK>

Methods over a shared slice.

pub const fn try_from_slice( storage: &'a [T], layout: ArrayLayout<RANK>, ) -> Result<Self, MismatchedCapacity>

Creates a shared view over storage.

Extra backing elements are permitted and remain visible through storage.

Errors

Returns MismatchedCapacity if the storage is too short to contain every position addressed by layout.

pub const fn try_from_slice_ref( storage: &'a [T], layout: ArrayLayout<RANK>, ) -> Result<Self, MismatchedCapacity>

Creates a shared slice-backed view.

This inference-friendly constructor is equivalent to try_from_slice, but allows the backing data and rank to be inferred from storage and layout.

pub const fn storage(&self) -> &'a [T]

Returns the complete physical backing slice.

This is not necessarily the array’s logical ravel order.

pub const fn storage_len(&self) -> usize

Returns the backing-storage length.

pub const fn get(&self, coord: [usize; RANK]) -> Option<&'a T>

Returns the element at coord, or None if it is out of bounds.

pub const fn reborrow(&self) -> Array<&[T], RANK>

Returns a shared view reborrowed for the lifetime of self.

impl<'a, T, const RANK: usize> Array<&'a mut [T], RANK>

Methods over an exclusive slice.

pub const fn try_from_slice( storage: &'a mut [T], layout: ArrayLayout<RANK>, ) -> Result<Self, MismatchedCapacity>

Creates an exclusive view over storage.

Extra backing elements are permitted and remain accessible through storage_mut.

Errors

Returns MismatchedCapacity if the storage is too short to contain every position addressed by layout.

pub const fn try_from_slice_mut( storage: &'a mut [T], layout: ArrayLayout<RANK>, ) -> Result<Self, MismatchedCapacity>

Creates an exclusive slice-backed view.

This inference-friendly constructor is equivalent to try_from_slice, but allows the backing data and rank to be inferred from storage and layout.

pub const fn storage(&self) -> &[T]

Returns the complete physical backing slice.

pub const fn storage_mut(&mut self) -> &mut [T]

Returns the complete exclusive physical backing slice.

pub const fn storage_len(&self) -> usize

Returns the backing-storage length.

pub const fn get(&self, coord: [usize; RANK]) -> Option<&T>

Returns a shared reference to the element at coord.

pub const fn get_mut(&mut self, coord: [usize; RANK]) -> Option<&mut T>

Returns an exclusive reference to the element at coord.

pub const fn reborrow(&self) -> Array<&[T], RANK>

Returns a shared view reborrowed for the lifetime of self.

pub const fn reborrow_mut(&mut self) -> Array<&mut [T], RANK>

Returns an exclusive view reborrowed for the lifetime of self.

pub const fn into_shared(self) -> Array<&'a [T], RANK>

Consumes the exclusive view and returns a shared view.

impl<T, const RANK: usize> Array<Box<[T]>, RANK>

Methods over a boxed slice.

pub fn try_from_boxed_slice( storage: Box<[T]>, layout: ArrayLayout<RANK>, ) -> Result<Self, MismatchedCapacity>

Available on crate feature alloc only.

Creates an owning array over the boxed slice storage.

Extra initialized backing elements are permitted.

Errors

Returns MismatchedCapacity if storage does not cover every physical position addressed by layout.

pub fn storage(&self) -> &[T]

Available on crate feature alloc only.

Returns the complete physical backing slice.

This is not necessarily the array’s logical ravel order.

pub fn storage_mut(&mut self) -> &mut [T]

Available on crate feature alloc only.

Returns the complete exclusive physical backing slice.

pub fn storage_len(&self) -> usize

Available on crate feature alloc only.

Returns the backing-storage length.

pub fn get(&self, coord: [usize; RANK]) -> Option<&T>

Available on crate feature alloc only.

Returns a shared reference to the element at coord.

pub fn get_mut(&mut self, coord: [usize; RANK]) -> Option<&mut T>

Available on crate feature alloc only.

Returns an exclusive reference to the element at coord.

pub fn reborrow(&self) -> Array<&[T], RANK>

Available on crate feature alloc only.

Returns a shared slice-backed array reborrowed from this array.

pub fn reborrow_mut(&mut self) -> Array<&mut [T], RANK>

Available on crate feature alloc only.

Returns an exclusive slice-backed array reborrowed from this array.

pub fn into_vec(self) -> Array<Vec<T>, RANK>

Available on crate feature alloc only.

Converts this boxed-slice-backed array into a vector-backed array.

The logical layout is preserved.

impl<T, const RANK: usize> Array<Vec<T>, RANK>

Methods over a vector.

pub fn try_from_vec( storage: Vec<T>, layout: ArrayLayout<RANK>, ) -> Result<Self, MismatchedCapacity>

Available on crate feature alloc only.

Creates an owning array over the vector storage.

Extra initialized backing elements are permitted.

The vector’s capacity is not considered accessible storage; only its initialized length must cover layout.

Errors

Returns MismatchedCapacity if storage does not cover every physical position addressed by layout.

pub fn storage(&self) -> &[T]

Available on crate feature alloc only.

Returns the complete physical backing slice.

This is not necessarily the array’s logical ravel order.

pub fn storage_mut(&mut self) -> &mut [T]

Available on crate feature alloc only.

Returns the complete exclusive physical backing slice.

This permits mutation of initialized elements without permitting changes to the vector’s length.

pub fn storage_len(&self) -> usize

Available on crate feature alloc only.

Returns the backing-storage length.

pub fn get(&self, coord: [usize; RANK]) -> Option<&T>

Available on crate feature alloc only.

Returns a shared reference to the element at coord.

Returns None if the coordinate is outside the logical shape.

pub fn get_mut(&mut self, coord: [usize; RANK]) -> Option<&mut T>

Available on crate feature alloc only.

Returns an exclusive reference to the element at coord.

Returns None if the coordinate is outside the logical shape.

pub fn reborrow(&self) -> Array<&[T], RANK>

Available on crate feature alloc only.

Returns a shared slice-backed array reborrowed from this array.

pub fn reborrow_mut(&mut self) -> Array<&mut [T], RANK>

Available on crate feature alloc only.

Returns an exclusive slice-backed array reborrowed from this array.

pub fn into_boxed(self) -> Array<Box<[T]>, RANK>

Available on crate feature alloc only.

Converts this vector-backed array into a boxed-slice-backed array.

The logical layout is preserved.

Trait Implementations

impl<D: Clone, const RANK: usize> Clone for Array<D, RANK>

fn clone(&self) -> Array<D, RANK>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Copy, const RANK: usize> Copy for Array<D, RANK>

impl<D: Debug, const RANK: usize> Debug for Array<D, RANK>

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

Formats the value using the given formatter.

impl<D> From<Array<D, 2>> for Table<D>

fn from(array: Array<D, 2>) -> Self

Converts to this type from the input type.

impl<D> From<Table<D>> for Array<D, 2>

fn from(table: Table<D>) -> Self

Converts to this type from the input type.