Struct NdSlice

pub struct NdSlice<'s, T, const N: usize> { /* private fields */ }

NdSlice wraps &[T] to represent an immutable n-dimensional array

let arr = [1, 2, 3, 4, 5, 6];
let n = NdSlice::new(&arr, [2, 3], Order::RowMajor).unwrap();
assert_eq!(n[[0, 0]], 1);
assert_eq!(n[[1, 2]], 6);

let arr = [1, 2, 3, 4, 5, 6, 7, 8];
let n = NdSlice::new(&arr, [2, 2, 2], Order::RowMajor).unwrap();
assert_eq!(n[[0, 0, 0]], 1);
assert_eq!(n[[1, 1, 1]], 8);

If the slice doesn’t have enough elements to represent an array of that shape, it will return an Err(ShapeError).

let n = NdSlice::new(&[1, 2, 3, 4, 5, 6], [2, 2], Order::RowMajor).unwrap(); // more elements
let n = NdSlice::new(&[1, 2, 3, 4, 5, 6], [2, 4], Order::RowMajor).unwrap(); // less elements

Implementations

impl<'s, T, const N: usize> NdSlice<'s, T, N>

pub fn new( slice: &'s [T], shape: [usize; N], order: Order, ) -> Result<NdSlice<'s, T, N>, ShapeError<'s, T, N>>

Creates a new NdSlice with the specified ordering from a given slice and the expected shape

pub unsafe fn from_ptr( ptr: *const T, len: usize, shape: [usize; N], order: Order, ) -> Result<NdSlice<'s, T, N>, ShapeError<'s, T, N>>

Creates a new NdSlice with the specified ordering from a raw pointer, it’s length and the expected shape

pub fn new_row_ordered( slice: &'s [T], shape: [usize; N], ) -> Result<NdSlice<'s, T, N>, ShapeError<'s, T, N>>

Creates a new NdSlice with row-major ordering from a given slice and the expected shape

pub unsafe fn row_ordered_from_ptr( ptr: *const T, len: usize, shape: [usize; N], ) -> Result<NdSlice<'s, T, N>, ShapeError<'s, T, N>>

Creates a new NdSlice with row-major ordering from a raw pointer, it’s length and the expected shape

pub fn col_ordered( slice: &'s [T], shape: [usize; N], ) -> Result<NdSlice<'s, T, N>, ShapeError<'s, T, N>>

Creates a new NdSlice with column-major ordering from a given slice and the expected shape

pub unsafe fn col_ordered_from_ptr( ptr: *const T, len: usize, shape: [usize; N], ) -> Result<NdSlice<'s, T, N>, ShapeError<'s, T, N>>

Creates a new NdSlice with column-major ordering from a raw pointer, it’s length and the expected shape.

Trait Implementations

impl<'s, T: Clone, const N: usize> Clone for NdSlice<'s, T, N>

fn clone(&self) -> NdSlice<'s, T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'s, T: Debug, const N: usize> Debug for NdSlice<'s, T, N>

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

Formats the value using the given formatter.

impl<T, const N: usize> Index<[usize; N]> for NdSlice<'_, T, N>

type Output = T

The returned type after indexing.

fn index(&self, index: [usize; N]) -> &Self::Output

Performs the indexing (container[index]) operation.