Struct MultiVec

pub struct MultiVec<T, const D: usize> { /* private fields */ }

A multi-dimensional vector. This is faster and simpler than using Vec<Vec<…>>

Implementations

impl<T: Copy, const D: usize> MultiVec<T, D>

pub fn fill(axes: [usize; D], value: T) -> Self

Constructs a MultiVec with the specified axes and fills it with the specified value.

impl<T, const D: usize> MultiVec<T, D>

pub fn new(axes: [usize; D]) -> Self

Constructs a MultiVec with the specified axes.

pub fn fill_fn(axes: [usize; D], f: impl Fn(usize) -> T) -> Self

Constructs a MultiVec with the specified axes and fills it with the result of the function.

pub fn iso(&mut self, new_axes: [usize; D])

Performs an isomorphism on the axes. The new axes must have the same number of elements.

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

Returns an iterator over references to the elements.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T>

Returns an iterator over mutable references to the elements.

pub fn len(&self) -> usize

Returns the number of elements.

pub fn is_empty(&self) -> bool

Returns true if the MultiVec is empty.

impl<T> MultiVec<T, 2>

pub fn to_vec(self) -> Vec<T>

Converts the MultiVec to a Vec.

Trait Implementations

impl<T, const D: usize> AsMut<[T]> for MultiVec<T, D>

fn as_mut(&mut self) -> &mut [T]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, const D: usize> AsRef<[T]> for MultiVec<T, D>

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone, const D: usize> Clone for MultiVec<T, D>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const D: usize> Debug for MultiVec<T, D>

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

Formats the value using the given formatter.

impl<T, const D: usize> Default for MultiVec<T, D>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Hash, const D: usize> Hash for MultiVec<T, D>

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<T> Index<(usize, Range<usize>)> for MultiVec<T, 2>

type Output = [T]

The returned type after indexing.

fn index(&self, (i, j): (usize, Range<usize>)) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<(usize, RangeFrom<usize>)> for MultiVec<T, 2>

type Output = [T]

The returned type after indexing.

fn index(&self, (i, j): (usize, RangeFrom<usize>)) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<(usize, RangeFull)> for MultiVec<T, 2>

type Output = [T]

The returned type after indexing.

fn index(&self, (i, _): (usize, RangeFull)) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<(usize, RangeInclusive<usize>)> for MultiVec<T, 2>

type Output = [T]

The returned type after indexing.

fn index(&self, (i, j): (usize, RangeInclusive<usize>)) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<(usize, RangeTo<usize>)> for MultiVec<T, 2>

type Output = [T]

The returned type after indexing.

fn index(&self, (i, j): (usize, RangeTo<usize>)) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<(usize, RangeToInclusive<usize>)> for MultiVec<T, 2>

type Output = [T]

The returned type after indexing.

fn index(&self, (i, j): (usize, RangeToInclusive<usize>)) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<(usize, usize)> for MultiVec<T, 2>

type Output = T

The returned type after indexing.

fn index(&self, (i, j): (usize, usize)) -> &T

Performs the indexing (container[index]) operation.

impl<T> Index<usize> for MultiVec<T, 2>

type Output = [T]

The returned type after indexing.

fn index(&self, i: usize) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> IndexMut<(usize, Range<usize>)> for MultiVec<T, 2>

fn index_mut(&mut self, (i, j): (usize, Range<usize>)) -> &mut [T]

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

impl<T> IndexMut<(usize, RangeFrom<usize>)> for MultiVec<T, 2>

fn index_mut(&mut self, (i, j): (usize, RangeFrom<usize>)) -> &mut [T]

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

impl<T> IndexMut<(usize, RangeFull)> for MultiVec<T, 2>

fn index_mut(&mut self, (i, _): (usize, RangeFull)) -> &mut [T]

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

impl<T> IndexMut<(usize, RangeInclusive<usize>)> for MultiVec<T, 2>

fn index_mut(&mut self, (i, j): (usize, RangeInclusive<usize>)) -> &mut [T]

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

impl<T> IndexMut<(usize, RangeTo<usize>)> for MultiVec<T, 2>

fn index_mut(&mut self, (i, j): (usize, RangeTo<usize>)) -> &mut [T]

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

impl<T> IndexMut<(usize, RangeToInclusive<usize>)> for MultiVec<T, 2>

fn index_mut(&mut self, (i, j): (usize, RangeToInclusive<usize>)) -> &mut [T]

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

impl<T> IndexMut<(usize, usize)> for MultiVec<T, 2>

fn index_mut(&mut self, (i, j): (usize, usize)) -> &mut T

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

impl<T> IndexMut<usize> for MultiVec<T, 2>

fn index_mut(&mut self, i: usize) -> &mut [T]

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

impl<T: Ord, const D: usize> Ord for MultiVec<T, D>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, const D: usize> PartialEq for MultiVec<T, D>

fn eq(&self, other: &Self) -> 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<T: PartialOrd, const D: usize> PartialOrd for MultiVec<T, D>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Zeroize, const D: usize> Zeroize for MultiVec<T, D>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<T: Eq, const D: usize> Eq for MultiVec<T, D>