Struct FlatJagged

pub struct FlatJagged<V, I, T>
where
    V: NVec<D1, T>,
    I: NVec<D1, usize>,
{ /* private fields */ }

A variable cardinality, jagged, D2 vector represented by a tuple of a flat D1 storage and row end indices.

Flattening jagged vectors might be useful in improving cache locality.

Examples

use orx_v::*;

let row_end_indices = [1, 3, 3, 6];
let storage = [0, 1, 2, 3, 4, 5];

let jagged = storage.as_jagged(&row_end_indices);
assert_eq!(jagged.card([]), 4);
assert_eq!(jagged.card([0]), 1);
assert_eq!(jagged.card([1]), 2);
assert_eq!(jagged.card([2]), 0);
assert_eq!(jagged.card([3]), 3);
assert_eq!(
    jagged.equality(&vec![vec![0], vec![1, 2], vec![], vec![3, 4, 5]]),
    Equality::Equal,
);

Note that row end indices can be any V1<usize>. Alternatively, it might be created internally from row lengths.

use orx_v::*;

let row_lengths = [1, 2, 0, 3];
let storage = [0, 1, 2, 3, 4, 5];

let jagged = storage.as_jagged_from_row_lengths(&row_lengths);
assert_eq!(jagged.card([]), 4);
assert_eq!(jagged.card([0]), 1);
assert_eq!(jagged.card([1]), 2);
assert_eq!(jagged.card([2]), 0);
assert_eq!(jagged.card([3]), 3);
assert_eq!(
    jagged.equality(&vec![vec![0], vec![1, 2], vec![], vec![3, 4, 5]]),
    Equality::Equal,
);

Implementations

impl<V, I, T> FlatJagged<V, I, T>

where V: NVec<D1, T>, I: NVec<D1, usize>,

pub fn into_inner(self) -> (V, I)

Transforms the flat-jagged vec into two of its underlying V1s:

• flat_vec which is the flattened storage of the jagged vec, and
• row_end_indices which is the scan of row lengths.

Examples

use orx_v::*;

let row_lengths = [0, 3, 2, 1];
let storage = [0, 1, 2, 3, 4, 5];

let jagged = storage.as_jagged_from_row_lengths(&row_lengths);
assert_eq!(jagged.card([]), 4);
assert_eq!(jagged.card([0]), 0);
assert_eq!(jagged.card([1]), 3);
assert_eq!(jagged.card([2]), 2);
assert_eq!(jagged.card([3]), 1);
assert_eq!(
    jagged.equality(&vec![vec![], vec![0, 1, 2], vec![3, 4], vec![5]]),
    Equality::Equal,
);

let (v1, end_indices) = jagged.into_inner();
assert_eq!(
    v1.equality(&[0, 1, 2, 3, 4, 5]),
    Equality::Equal
);
assert_eq!(
    end_indices.equality(&[0, 3, 5, 6]),
    Equality::Equal
);

Trait Implementations

impl<V, I, T> Debug for FlatJagged<V, I, T>

where T: Debug, V: NVec<D1, T>, I: NVec<D1, usize>,

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

Formats the value using the given formatter.

impl<V, I, T> NVec<D2, T> for FlatJagged<V, I, T>

where V: NVec<D1, T>, I: NVec<D1, usize>,

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

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

fn child(&self, i: <D2 as Dim>::ChildIdx) -> impl NVec<<D2 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<V, I, T> NVecMut<D2, T> for FlatJagged<V, I, T>

where V: NVec<D1, T> + NVecMut<D1, T>, I: NVec<D1, usize>,

fn at_mut<Idx: IntoIdx<D2>>(&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<D2>>(&mut self, idx: Idx, value: T)

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

fn child_mut( &mut self, i: <D2 as Dim>::ChildIdx, ) -> impl NVecMut<<D2 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.