Struct CircularArray

pub struct CircularArray<const N: usize, A, T> { /* private fields */ }

A circular array of D dimensions holding elements of type T.

Implementations

impl<const N: usize, A, T> CircularArray<N, A, T>

where A: AsRef<[T]>,

pub fn new(shape: [usize; N], array: A) -> CircularArray<N, A, T>

pub fn new_offset( shape: [usize; N], array: A, offset: [usize; N], ) -> CircularArray<N, A, T>

pub fn shape(&self) -> &[usize; N]

Get the shape array.

pub fn offset(&self) -> &[usize; N]

Get the offset array.

pub fn slice_len(&self, axis: usize) -> usize

Get the number of elements for a single slice of the array, for the given axis. Pushing n slices of elements onto an axis requires n * slice_len elements to be passed to the respective method.

pub fn next_offset(&self, axis: usize, n: isize) -> usize

Get the offset value after adding n to the given axis.

impl<const N: usize, T> CircularArray<N, Vec<T>, T>

pub fn from_iter(shape: [usize; N], iter: impl Iterator<Item = T>) -> Self

pub fn from_iter_offset( shape: [usize; N], iter: impl Iterator<Item = T>, offset: [usize; N], ) -> Self

impl<const N: usize, T> CircularArray<N, Box<[T]>, T>

pub fn from_iter(shape: [usize; N], iter: impl Iterator<Item = T>) -> Self

pub fn from_iter_offset( shape: [usize; N], iter: impl Iterator<Item = T>, offset: [usize; N], ) -> Self

Trait Implementations

impl<'a, const N: usize, A: AsRef<[T]>, T: 'a> CircularArrayIndex<'a, N, T> for CircularArray<N, A, T>

fn iter(&'a self) -> impl Iterator<Item = &'a T>

Iterate over all elements of the inner array, aligned to the offset.

fn iter_raw(&'a self) -> impl Iterator<Item = &'a T>

Iterate over all elements of the inner array.

fn iter_index( &'a self, axis: usize, index: usize, ) -> impl Iterator<Item = &'a T>

Iterate over all elements of index for the given axis aligned to the offset.

fn iter_range( &'a self, axis: usize, range: Range<usize>, ) -> impl Iterator<Item = &'a T>

Iterate over all elements of the given index range for the given axis aligned to the offset.

fn iter_range_raw( &'a self, axis: usize, range: Range<usize>, ) -> impl Iterator<Item = &'a T>

Iterate over all elements of the given index range for the given axis.

fn iter_slice(&'a self, slice: [Range<usize>; N]) -> impl Iterator<Item = &'a T>

Iterate over all elements of the given index slice.

fn iter_index_raw( &'a self, axis: usize, index: usize, ) -> impl Iterator<Item = &'a T>

Iterate over all elements of index for the given axis.

fn get(&'a self, index: [usize; N]) -> &'a T

Get a reference to the element at the given index, aligned to the offset.

fn get_raw(&'a self, index: [usize; N]) -> &'a T

Get a reference to the element at the given index.

impl<'a, const N: usize, A: AsMut<[T]>, T: 'a> CircularArrayIndexMut<'a, N, T> for CircularArray<N, A, T>

fn get_mut(&mut self, index: [usize; N]) -> &mut T

Get a mutable reference to the element at the given index, aligned to the offset.

fn get_mut_raw(&mut self, index: [usize; N]) -> &mut T

Get a mutable reference to the element at the given index.

impl<'a, const N: usize, A: AsRef<[T]> + AsMut<[T]>, T: Clone> CircularArrayMut<N, T, &'a [T]> for CircularArray<N, A, T>

fn push_front(&mut self, axis: usize, el: &'a [T])

Push elements to the front of the given axis, taking into account the offsets of all axes. Elements must be an exact multiple of the slice size for the given axis. See CircularArray::slice_len.

fn push_front_raw(&mut self, axis: usize, el: &'a [T])

Push elements to the front of the given axis, taking into account only the offset of the given axis. Elements must be an exact multiple of the slice size for the given axis. See CircularArray::slice_len.

fn push_back(&mut self, axis: usize, el: &'a [T])

Push elements to the back of the given axis, taking into account the offsets of all exes. Elements must be an exact multiple of the slice size for the given axis. See CircularArray::slice_len.

fn push_back_raw(&mut self, axis: usize, el: &'a [T])

Push elements to the back of the given axis, taking into account the offsets of all axes. Elements must be an exact multiple of the slice size for the given axis. See CircularArray::slice_len.

impl<'a, const N: usize, A: AsRef<[T]>, T: 'a> Index<[usize; N]> for CircularArray<N, A, T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, const N: usize, A: AsRef<[T]> + AsMut<[T]>, T: 'a> IndexMut<[usize; N]> for CircularArray<N, A, T>

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

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