Struct D3

pub struct D3;

Three dimensions.

Trait Implementations

impl Card<D3> for RectangularCardD3

fn is_rectangular(&self) -> bool

Returns true if the cardinality is bounded and rectangular; i.e,

fn cardinality_of(&self, idx: impl Into<<D3 as Dim>::CardIdx>) -> usize

Returns the cardinality of the child of the vector at the given idx.

fn child_card(&self, i: usize) -> impl Card<<D3 as Dim>::PrevDim>

Returns the cardinality of the child of this vector at the given left_most_idx.

fn child_fun<T, F>( &self, i: usize, fun: F, ) -> impl Fn(<<D3 as Dim>::PrevDim as Dim>::Idx) -> T

where F: Fn(<D3 as Dim>::Idx) -> T,

Creates a function, say new_fun, which applies the first of the indices to left_most_index such that:

fn vec_all<'a, T, N>(&'a self, vec: &'a N) -> impl Iterator<Item = T>

where N: NVec<D3, T> + 'a,

Returns an iterator over all elements of the vec provided that this is its cardinality.

fn vec_enumerate_all<'a, T, N>( &'a self, vec: &'a N, ) -> impl Iterator<Item = (<D3 as Dim>::Idx, T)>

where N: NVec<D3, T> + 'a,

Returns an iterator over all elements of the vec together with their corresponding indices provided that this is its cardinality.

impl<V: V2<usize>> Card<D3> for VariableCardD3<V>

fn is_rectangular(&self) -> bool

Returns true if the cardinality is bounded and rectangular; i.e,

fn cardinality_of(&self, idx: impl Into<<D3 as Dim>::CardIdx>) -> usize

Returns the cardinality of the child of the vector at the given idx.

fn child_card(&self, i: usize) -> impl Card<<D3 as Dim>::PrevDim>

Returns the cardinality of the child of this vector at the given left_most_idx.

fn child_fun<T, F>( &self, i: usize, fun: F, ) -> impl Fn(<<D3 as Dim>::PrevDim as Dim>::Idx) -> T

where F: Fn(<D3 as Dim>::Idx) -> T,

Creates a function, say new_fun, which applies the first of the indices to left_most_index such that:

fn vec_all<'a, T, N>(&'a self, vec: &'a N) -> impl Iterator<Item = T>

where N: NVec<D3, T> + 'a,

Returns an iterator over all elements of the vec provided that this is its cardinality.

fn vec_enumerate_all<'a, T, N>( &'a self, vec: &'a N, ) -> impl Iterator<Item = (<D3 as Dim>::Idx, T)>

where N: NVec<D3, T> + 'a,

Returns an iterator over all elements of the vec together with their corresponding indices provided that this is its cardinality.

impl CardIdx<D3> for IdxLeqD2

fn is_d0(&self) -> bool

Returns whether or not the index is of dimension 0; i.e., has type [usize; 0].

fn card<T>(self, vec: &impl NVecCore<D3, T>) -> usize

Returns the cardinality of the given vec at this index.

fn card_equality<T>( a: &impl NVecCore<D3, T>, b: &impl NVecCore<D3, T>, ) -> CardEquality<D3>

Returns the cardinality equality of the given vectors a and b at this index.

fn equality<T: PartialEq>( a: &impl NVec<D3, T>, b: &impl NVec<D3, T>, ) -> Equality<D3>

Returns the equality of the given vectors a and b at this index.

impl Clone for D3

fn clone(&self) -> D3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for D3

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

Formats the value using the given formatter.

impl Dim for D3

type Idx = [usize; 3]

Index for this dimensionality.

type ChildIdx = usize

Index to reach a child of a structure with this dimension, while the child belongs to the previous dimension.

type PrevDim = D2

One level smaller dimension.

type CardIdx = IdxLeqD2

Union of indices that can be used to query cardinality of the vector’s any lower dimension children.

type LeqIdx = IdxLeqD3

Union of indices that are less than or equal to this dimension.

fn dimension() -> usize

Name of the dimension.

fn left_join_from_lower_dim( left_most_idx: usize, lower_idx: <Self::PrevDim as Dim>::Idx, ) -> Self::Idx

Left joins the left_most_idx to lover_idx of dimension say N to get the index of dimension N+1.

fn left_join_from_lower_card_idx( left_most_idx: usize, lower_idx: <Self::PrevDim as Dim>::CardIdx, ) -> Self::CardIdx

Left joins the left_most_idx to lover_idx of dimension say N to get the index of dimension N+1.

fn in_bounds<T>(idx: impl IntoIdx<Self>, vec: &impl NVecCore<Self, T>) -> bool

Returns whether or not the idx is in bounds for the given vec.

impl IntoIdx<D3> for (usize, usize, usize)

fn into_idx(self) -> <D3 as Dim>::Idx

Converts self into the standard index of dimension D.

impl LeqIdx<D3> for IdxLeqD3

fn in_leq_bounds<T>(self, vec: &impl NVecCore<D3, T>) -> bool

Checks whether or not this index is in bounds for the given vec.

impl<'a, C, T> NVec<D3, T> for &'a [C]

where C: NVec<<D3 as Dim>::PrevDim, T>,

fn at(&self, idx: impl IntoIdx<D3>) -> T

Returns the element at the idx-th position of the vector.

fn child(&self, i: usize) -> impl NVec<<D3 as Dim>::PrevDim, T>

Returns the i-th child of the vector.

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

Returns a flattened iterator over all scalar (D0) elements of the vector.

fn num_children(&self) -> usize

Returns the number of children of the vector; i.e., number of elements of the one lower dimension.

fn card(&self, idx: impl Into<D::CardIdx>) -> usize

Returns the cardinality of the vec in any of the lower dimensions.

fn is_bounded(&self) -> bool

Returns whether or not the vector is bounded.

fn is_rectangular(&self) -> bool

Returns whether or not the cardinalities of the vector are rectangular. A rectangular vector of dimension D has the same number of children at a given lower dimension for all indices.

fn is_unbounded(&self) -> bool

Returns whether or not the vector is unbounded.

fn in_bounds(&self, idx: impl Into<D::LeqIdx>) -> bool

Returns whether or not the given idx is in bounds.

fn card_equality(&self, other: &impl NVec<D, T>) -> CardEquality<D>

Returns the cardinality equality of this vec with the other:

fn try_at(&self, idx: impl IntoIdx<D>) -> Option<T>

Returns the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

fn equality(&self, other: &impl NVec<D, T>) -> Equality<D>

where T: PartialEq,

Returns the equality of this vec with the other:

fn children(&self) -> impl Iterator<Item = impl NVec<D::PrevDim, T>>

Returns an iterator of all children of the vector.

fn all_in( &self, indices: impl Iterator<Item = impl IntoIdx<D>>, ) -> impl Iterator<Item = T>

Returns an iterator of elements for the given indices.

impl<'a, C, T> NVec<D3, T> for &'a mut [C]

where C: NVec<<D3 as Dim>::PrevDim, T>,

fn at(&self, idx: impl IntoIdx<D3>) -> T

Returns the element at the idx-th position of the vector.

fn child(&self, i: usize) -> impl NVec<<D3 as Dim>::PrevDim, T>

Returns the i-th child of the vector.

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

Returns a flattened iterator over all scalar (D0) elements of the vector.

fn num_children(&self) -> usize

Returns the number of children of the vector; i.e., number of elements of the one lower dimension.

fn card(&self, idx: impl Into<D::CardIdx>) -> usize

Returns the cardinality of the vec in any of the lower dimensions.

fn is_bounded(&self) -> bool

Returns whether or not the vector is bounded.

fn is_rectangular(&self) -> bool

Returns whether or not the cardinalities of the vector are rectangular. A rectangular vector of dimension D has the same number of children at a given lower dimension for all indices.

fn is_unbounded(&self) -> bool

Returns whether or not the vector is unbounded.

fn in_bounds(&self, idx: impl Into<D::LeqIdx>) -> bool

Returns whether or not the given idx is in bounds.

fn card_equality(&self, other: &impl NVec<D, T>) -> CardEquality<D>

Returns the cardinality equality of this vec with the other:

fn try_at(&self, idx: impl IntoIdx<D>) -> Option<T>

Returns the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

fn equality(&self, other: &impl NVec<D, T>) -> Equality<D>

where T: PartialEq,

Returns the equality of this vec with the other:

fn children(&self) -> impl Iterator<Item = impl NVec<D::PrevDim, T>>

Returns an iterator of all children of the vector.

fn all_in( &self, indices: impl Iterator<Item = impl IntoIdx<D>>, ) -> impl Iterator<Item = T>

Returns an iterator of elements for the given indices.

impl<const N: usize, C, T> NVec<D3, T> for [C; N]

where C: NVec<<D3 as Dim>::PrevDim, T>,

fn at(&self, idx: impl IntoIdx<D3>) -> T

Returns the element at the idx-th position of the vector.

fn child(&self, i: usize) -> impl NVec<<D3 as Dim>::PrevDim, T>

Returns the i-th child of the vector.

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

Returns a flattened iterator over all scalar (D0) elements of the vector.

fn num_children(&self) -> usize

Returns the number of children of the vector; i.e., number of elements of the one lower dimension.

fn card(&self, idx: impl Into<D::CardIdx>) -> usize

Returns the cardinality of the vec in any of the lower dimensions.

fn is_bounded(&self) -> bool

Returns whether or not the vector is bounded.

fn is_rectangular(&self) -> bool

Returns whether or not the cardinalities of the vector are rectangular. A rectangular vector of dimension D has the same number of children at a given lower dimension for all indices.

fn is_unbounded(&self) -> bool

Returns whether or not the vector is unbounded.

fn in_bounds(&self, idx: impl Into<D::LeqIdx>) -> bool

Returns whether or not the given idx is in bounds.

fn card_equality(&self, other: &impl NVec<D, T>) -> CardEquality<D>

Returns the cardinality equality of this vec with the other:

fn try_at(&self, idx: impl IntoIdx<D>) -> Option<T>

Returns the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

fn equality(&self, other: &impl NVec<D, T>) -> Equality<D>

where T: PartialEq,

Returns the equality of this vec with the other:

fn children(&self) -> impl Iterator<Item = impl NVec<D::PrevDim, T>>

Returns an iterator of all children of the vector.

fn all_in( &self, indices: impl Iterator<Item = impl IntoIdx<D>>, ) -> impl Iterator<Item = T>

Returns an iterator of elements for the given indices.

impl<T, V, C> NVec<D3, T> for CachedVec<D3, T, V, C>

where V: NVec<D3, T>, C: Cache<<D3 as Dim>::Idx, T>, T: Copy,

fn at(&self, idx: impl IntoIdx<D3>) -> T

Returns the element at the idx-th position of the vector.

fn child(&self, i: <D3 as Dim>::ChildIdx) -> impl NVec<<D3 as Dim>::PrevDim, T>

Returns the i-th child of the vector.

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

Returns a flattened iterator over all scalar (D0) elements of the vector.

fn num_children(&self) -> usize

Returns the number of children of the vector; i.e., number of elements of the one lower dimension.

fn card(&self, idx: impl Into<D::CardIdx>) -> usize

Returns the cardinality of the vec in any of the lower dimensions.

fn is_bounded(&self) -> bool

Returns whether or not the vector is bounded.

fn is_rectangular(&self) -> bool

Returns whether or not the cardinalities of the vector are rectangular. A rectangular vector of dimension D has the same number of children at a given lower dimension for all indices.

fn is_unbounded(&self) -> bool

Returns whether or not the vector is unbounded.

fn in_bounds(&self, idx: impl Into<D::LeqIdx>) -> bool

Returns whether or not the given idx is in bounds.

fn card_equality(&self, other: &impl NVec<D, T>) -> CardEquality<D>

Returns the cardinality equality of this vec with the other:

fn try_at(&self, idx: impl IntoIdx<D>) -> Option<T>

Returns the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

fn equality(&self, other: &impl NVec<D, T>) -> Equality<D>

where T: PartialEq,

Returns the equality of this vec with the other:

fn children(&self) -> impl Iterator<Item = impl NVec<D::PrevDim, T>>

Returns an iterator of all children of the vector.

fn all_in( &self, indices: impl Iterator<Item = impl IntoIdx<D>>, ) -> impl Iterator<Item = T>

Returns an iterator of elements for the given indices.

impl<T, L, C> NVec<D3, T> for SparseVec<D3, T, C, L>

where T: Copy, L: Lookup<<D3 as Dim>::Idx, T>, C: Card<D3>,

fn at(&self, idx: impl IntoIdx<D3>) -> T

Returns the element at the idx-th position of the vector.

fn in_bounds(&self, idx: impl Into<<D3 as Dim>::LeqIdx>) -> bool

Returns whether or not the given idx is in bounds.

fn child(&self, i: <D3 as Dim>::ChildIdx) -> impl NVec<<D3 as Dim>::PrevDim, T>

Returns the i-th child of the vector.

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

Returns a flattened iterator over all scalar (D0) elements of the vector.

fn num_children(&self) -> usize

Returns the number of children of the vector; i.e., number of elements of the one lower dimension.

fn card(&self, idx: impl Into<D::CardIdx>) -> usize

Returns the cardinality of the vec in any of the lower dimensions.

fn is_bounded(&self) -> bool

Returns whether or not the vector is bounded.

fn is_rectangular(&self) -> bool

Returns whether or not the cardinalities of the vector are rectangular. A rectangular vector of dimension D has the same number of children at a given lower dimension for all indices.

fn is_unbounded(&self) -> bool

Returns whether or not the vector is unbounded.

fn card_equality(&self, other: &impl NVec<D, T>) -> CardEquality<D>

Returns the cardinality equality of this vec with the other:

fn try_at(&self, idx: impl IntoIdx<D>) -> Option<T>

Returns the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

fn equality(&self, other: &impl NVec<D, T>) -> Equality<D>

where T: PartialEq,

Returns the equality of this vec with the other:

fn children(&self) -> impl Iterator<Item = impl NVec<D::PrevDim, T>>

Returns an iterator of all children of the vector.

fn all_in( &self, indices: impl Iterator<Item = impl IntoIdx<D>>, ) -> impl Iterator<Item = T>

Returns an iterator of elements for the given indices.

impl<T, C> NVec<D3, T> for Vec<C>

where C: NVec<<D3 as Dim>::PrevDim, T>,

fn at(&self, idx: impl IntoIdx<D3>) -> T

Returns the element at the idx-th position of the vector.

fn child(&self, i: usize) -> impl NVec<<D3 as Dim>::PrevDim, T>

Returns the i-th child of the vector.

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

Returns a flattened iterator over all scalar (D0) elements of the vector.

fn num_children(&self) -> usize

Returns the number of children of the vector; i.e., number of elements of the one lower dimension.

fn card(&self, idx: impl Into<D::CardIdx>) -> usize

Returns the cardinality of the vec in any of the lower dimensions.

fn is_bounded(&self) -> bool

Returns whether or not the vector is bounded.

fn is_rectangular(&self) -> bool

Returns whether or not the cardinalities of the vector are rectangular. A rectangular vector of dimension D has the same number of children at a given lower dimension for all indices.

fn is_unbounded(&self) -> bool

Returns whether or not the vector is unbounded.

fn in_bounds(&self, idx: impl Into<D::LeqIdx>) -> bool

Returns whether or not the given idx is in bounds.

fn card_equality(&self, other: &impl NVec<D, T>) -> CardEquality<D>

Returns the cardinality equality of this vec with the other:

fn try_at(&self, idx: impl IntoIdx<D>) -> Option<T>

Returns the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

fn equality(&self, other: &impl NVec<D, T>) -> Equality<D>

where T: PartialEq,

Returns the equality of this vec with the other:

fn children(&self) -> impl Iterator<Item = impl NVec<D::PrevDim, T>>

Returns an iterator of all children of the vector.

fn all_in( &self, indices: impl Iterator<Item = impl IntoIdx<D>>, ) -> impl Iterator<Item = T>

Returns an iterator of elements for the given indices.

impl<'a, C, T> NVecMut<D3, T> for &'a mut [C]

where C: NVecMut<<D3 as Dim>::PrevDim, T>,

fn at_mut<Idx: IntoIdx<D3>>(&mut self, idx: Idx) -> &mut T

Returns a mutable reference to the element at the idx-th position of the vector.

fn set<Idx: IntoIdx<D3>>(&mut self, idx: Idx, value: T)

Sets valueof the element at the idx-th position of the vector.

fn child_mut( &mut self, i: <D3 as Dim>::ChildIdx, ) -> impl NVecMut<<D3 as Dim>::PrevDim, T>

Returns a mutable reference to the i-th child of the vector.

fn mut_all<F>(&mut self, f: F)

where F: FnMut(&mut T),

Applies the mutating function f over all scalar elements of the vector.

fn reset_all(&mut self, value: T)

where T: PartialEq + Copy,

Sets all elements of the vector to the given value. This method is often used at initialization stage of algorithms.

fn try_at_mut(&mut self, idx: impl IntoIdx<D>) -> Option<&mut T>

Returns a mutable reference to the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

impl<const N: usize, C, T> NVecMut<D3, T> for [C; N]

where C: NVecMut<<D3 as Dim>::PrevDim, T>,

fn at_mut<Idx: IntoIdx<D3>>(&mut self, idx: Idx) -> &mut T

Returns a mutable reference to the element at the idx-th position of the vector.

fn set<Idx: IntoIdx<D3>>(&mut self, idx: Idx, value: T)

Sets valueof the element at the idx-th position of the vector.

fn child_mut( &mut self, i: <D3 as Dim>::ChildIdx, ) -> impl NVecMut<<D3 as Dim>::PrevDim, T>

Returns a mutable reference to the i-th child of the vector.

fn mut_all<F>(&mut self, f: F)

where F: FnMut(&mut T),

Applies the mutating function f over all scalar elements of the vector.

fn reset_all(&mut self, value: T)

where T: PartialEq + Copy,

Sets all elements of the vector to the given value. This method is often used at initialization stage of algorithms.

fn try_at_mut(&mut self, idx: impl IntoIdx<D>) -> Option<&mut T>

Returns a mutable reference to the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

impl<T, L, C> NVecMut<D3, T> for SparseVec<D3, T, C, L>

where T: Copy, L: Lookup<<D3 as Dim>::Idx, T>, C: Card<D3>,

fn at_mut<Idx: IntoIdx<D3>>(&mut self, idx: Idx) -> &mut T

Returns a mutable reference to the element at the idx-th position of the vector.

fn set<Idx: IntoIdx<D3>>(&mut self, idx: Idx, value: T)

Sets valueof the element at the idx-th position of the vector.

fn child_mut( &mut self, i: <D3 as Dim>::ChildIdx, ) -> impl NVecMut<<D3 as Dim>::PrevDim, T>

Returns a mutable reference to the i-th child of the vector.

fn mut_all<F>(&mut self, f: F)

where F: FnMut(&mut T),

Applies the mutating function f over all scalar elements of the vector.

fn reset_all(&mut self, value: T)

where T: PartialEq + Copy,

Sets all elements of the vector to the given value. This method is often used at initialization stage of algorithms.

fn try_at_mut(&mut self, idx: impl IntoIdx<D>) -> Option<&mut T>

Returns a mutable reference to the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

impl<T, C> NVecMut<D3, T> for Vec<C>

where C: NVecMut<<D3 as Dim>::PrevDim, T>,

fn at_mut<Idx: IntoIdx<D3>>(&mut self, idx: Idx) -> &mut T

Returns a mutable reference to the element at the idx-th position of the vector.

fn set<Idx: IntoIdx<D3>>(&mut self, idx: Idx, value: T)

Sets valueof the element at the idx-th position of the vector.

fn child_mut( &mut self, i: <D3 as Dim>::ChildIdx, ) -> impl NVecMut<<D3 as Dim>::PrevDim, T>

Returns a mutable reference to the i-th child of the vector.

fn mut_all<F>(&mut self, f: F)

where F: FnMut(&mut T),

Applies the mutating function f over all scalar elements of the vector.

fn reset_all(&mut self, value: T)

where T: PartialEq + Copy,

Sets all elements of the vector to the given value. This method is often used at initialization stage of algorithms.

fn try_at_mut(&mut self, idx: impl IntoIdx<D>) -> Option<&mut T>

Returns a mutable reference to the element at the idx-th position of the vector if the index is in_bounds; returns None otherwise.

impl PartialEq for D3

fn eq(&self, other: &D3) -> 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 Copy for D3

impl StructuralPartialEq for D3