Struct MultiArray

pub struct MultiArray<T, A>
where
    A: LayoutHelper,
{ /* private fields */ }

Type for multi-dimensional arrays that are organized linearly in memory much like a C array but with dynamically determined sizes.

Example

use multiarray::*;

let mut matrix = Array2D::new([3, 2], 0);
matrix[[0,0]] = 1; matrix[[0,1]] = 2;
matrix[[1,0]] = 3; matrix[[1,1]] = 4;
matrix[[2,0]] = 5; matrix[[2,1]] = 6;

Implementations

impl<T, A> MultiArray<T, A>

where T: Clone, A: LayoutHelper,

pub fn new<X>(extents: X, fill: T) -> Self

where X: Into<A::U>,

Create new multi-dimensiopnal array with the given extents (one per dimension)

impl<T, A> MultiArray<T, A>

where A: LayoutHelper,

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

get the array’s extents (one item per dimension)

pub fn borrow(&self) -> MultiArrayRef<'_, T, A>

create a shared view that allows further manipulations of the view

pub fn borrow_mut(&mut self) -> MultiArrayRefMut<'_, T, A>

create a mutable view that allows further manipulations of the view

pub fn reversed_dim(&self, dim: usize) -> MultiArrayRef<'_, T, A>

Create a shared view where one given dimension is reversed

pub fn reversed_dim_mut(&mut self, dim: usize) -> MultiArrayRefMut<'_, T, A>

Create a mutable view where one given dimension is reversed

pub fn subsampled_dim( &self, dim: usize, factor: usize, ) -> MultiArrayRef<'_, T, A>

Create a shared view where one given dimension is subsampled by a given factor

pub fn subsampled_dim_mut( &mut self, dim: usize, factor: usize, ) -> MultiArrayRefMut<'_, T, A>

Create a shared view where one given dimension is subsampled by a given factor

pub fn sliced_dim<R>(&self, dim: usize, range: R) -> MultiArrayRef<'_, T, A>

where R: AnyRange<usize>,

Create a shared view where one given dimension is sliced

pub fn sliced_dim_mut<R>( &mut self, dim: usize, range: R, ) -> MultiArrayRefMut<'_, T, A>

where R: AnyRange<usize>,

Create a mutable view where one given dimension is sliced

pub fn swapped_dims(&self, d1: usize, d2: usize) -> MultiArrayRef<'_, T, A>

Create a shared view where the order of two dimensions are swapped

pub fn swapped_dims_mut( &mut self, d1: usize, d2: usize, ) -> MultiArrayRefMut<'_, T, A>

Create a mutable view where the order of two dimensions are swapped

impl<T, A> MultiArray<T, A>

where A: LayoutHelperExt,

pub fn eliminated_dim( &self, dim: usize, coord: usize, ) -> MultiArrayRef<'_, T, A::OneLess>

Create a lower-dimensional shared view where one dimension is fixed at the given coordinate.

pub fn eliminated_dim_mut( &mut self, dim: usize, coord: usize, ) -> MultiArrayRefMut<'_, T, A::OneLess>

Create a lower-dimensional mutable view where one dimension is fixed at the given coordinate.

Trait Implementations

impl<'a, T, A: LayoutHelper> From<&'a MultiArray<T, A>> for MultiArrayRef<'a, T, A>

fn from(ma: &'a MultiArray<T, A>) -> Self

Converts to this type from the input type.

impl<'a, T, A: LayoutHelper> From<&'a mut MultiArray<T, A>> for MultiArrayRef<'a, T, A>

fn from(ma: &'a mut MultiArray<T, A>) -> Self

Converts to this type from the input type.

impl<'a, T, A: LayoutHelper> From<&'a mut MultiArray<T, A>> for MultiArrayRefMut<'a, T, A>

fn from(ma: &'a mut MultiArray<T, A>) -> Self

Converts to this type from the input type.

impl<T, A, I> Index<I> for MultiArray<T, A>

where A: LayoutHelper, I: Into<A::U>,

type Output = T

The returned type after indexing.

fn index(&self, index: I) -> &T

Performs the indexing (container[index]) operation.

impl<T, A, I> IndexMut<I> for MultiArray<T, A>

where A: LayoutHelper, I: Into<A::U>,

fn index_mut(&mut self, index: I) -> &mut T

Performs the mutable indexing (container[index]) operation.