Struct building_blocks::prelude::ArrayN

pub struct ArrayN<N, T> { /* fields omitted */ }

A map from lattice location PointN<N> to data T, stored as a flat array on the heap.

Implementations

impl<N, T> ArrayN<N, T>

pub fn reset_values(&mut self, value: T) where
    T: Clone, 

Set all points to the same value.

pub fn values_slice(&self) -> &[T]

Returns the entire slice of values.

pub fn into_parts(self) -> (ExtentN<N>, Vec<T>)

Moves the raw extent and values Vec out of self.

pub fn extent(&self) -> &ExtentN<N>

impl<N, T> ArrayN<N, T> where
    ExtentN<N>: IntegerExtent<N>, 

pub fn new(extent: ExtentN<N>, values: Vec<T>) -> ArrayN<N, T>

Create a new ArrayN directly from the extent and values. This asserts that the number of points in the extent matches the length of the values Vec.

pub unsafe fn maybe_uninit(extent: ExtentN<N>) -> ArrayN<N, MaybeUninit<T>>

Creates an uninitialized map, mainly for performance.

Safety

Call assume_init after manually initializing all of the values.

pub fn fill(extent: ExtentN<N>, value: T) -> ArrayN<N, T> where
    T: Clone, 

Creates a map that fills the entire extent with the same value.

pub fn set_minimum(&mut self, p: PointN<N>)

Sets the extent minimum to p.

impl<N, T> ArrayN<N, T> where
    PointN<N>: Point, 

pub fn contains(&self, p: &PointN<N>) -> bool

Returns true iff this map contains point p.

impl<N, T> ArrayN<N, T> where
    PointN<N>: Point,
    ExtentN<N>: IntegerExtent<N>, 

pub fn fill_with(
    extent: ExtentN<N>,
    filler: impl FnMut(&PointN<N>) -> T
) -> ArrayN<N, T> where
    ArrayN<N, MaybeUninit<T>>: for<'r> GetMut<&'r PointN<N>>,
    <ArrayN<N, MaybeUninit<T>> as GetMut<&'r PointN<N>>>::Data == MaybeUninit<T>, 

Create a new array for extent where each point's value is determined by the filler function.

pub fn translate(&mut self, p: PointN<N>)

Adds p to the extent minimum.

impl<N, T> ArrayN<N, T> where
    ArrayN<N, T>: ForEachMut<N, Stride>,
    ExtentN<N>: IntegerExtent<N>,
    ExtentN<N>: PartialEq<ExtentN<N>>,
    <ArrayN<N, T> as ForEachMut<N, Stride>>::Data == T, 

pub fn fill_extent(&mut self, extent: &ExtentN<N>, value: T) where
    T: Clone, 

Fill the entire extent with the same value.

impl<N, T> ArrayN<N, MaybeUninit<T>> where
    PointN<N>: Point,
    ExtentN<N>: IntegerExtent<N>, 

pub unsafe fn assume_init(self) -> ArrayN<N, T>

Transmutes the map values from MaybeUninit<T> to T after manual initialization. The implementation just reconstructs the internal Vec after transmuting the data pointer, so the overhead is minimal.

Safety

All elements of the map must be initialized.

Trait Implementations

impl<N, T> Array<N> for ArrayN<N, T> where
    N: ArrayIndexer<N>, 

type Indexer = N

pub fn extent(&self) -> &ExtentN<N>

fn for_each_point_and_stride(
    &self,
    extent: &ExtentN<N>,
    f: impl FnMut(PointN<N>, Stride)
)

fn stride_from_local_point(&self, p: &Local<N>) -> Stride

fn strides_from_local_points(&self, points: &[Local<N>], strides: &mut [Stride])

impl<N, T> Clone for ArrayN<N, T> where
    N: Clone,
    T: Clone, 

pub fn clone(&self) -> ArrayN<N, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, T> Compressible<FastLz4> for ArrayN<N, T> where
    T: Copy,
    ExtentN<N>: IntegerExtent<N>, 

type Compressed = FastLz4CompressedArrayN<N, T>

pub fn compress(&self, params: FastLz4) -> FastLz4CompressedArrayN<N, T>

impl<N, T> Debug for ArrayN<N, T> where
    N: Debug,
    T: Debug, 

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

Formats the value using the given formatter.

impl<'de, N, T> Deserialize<'de> for ArrayN<N, T> where
    N: Deserialize<'de>,
    T: Deserialize<'de>, 

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<ArrayN<N, T>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<N, T> Eq for ArrayN<N, T> where
    N: Eq,
    T: Eq, 

impl<N, T> ForEach<N, (PointN<N>, Stride)> for ArrayN<N, T> where
    ArrayN<N, T>: Sized,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: Get<Stride>,
    ArrayN<N, T>: GetUnchecked<Stride>,
    <ArrayN<N, T> as Get<Stride>>::Data == T,
    <ArrayN<N, T> as GetUnchecked<Stride>>::Data == T, 

type Data = T

pub fn for_each(
    &self,
    extent: &ExtentN<N>,
    f: impl FnMut((PointN<N>, Stride), T)
)

impl<N, T> ForEach<N, PointN<N>> for ArrayN<N, T> where
    ArrayN<N, T>: Sized,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: Get<Stride>,
    ArrayN<N, T>: GetUnchecked<Stride>,
    <ArrayN<N, T> as Get<Stride>>::Data == T,
    <ArrayN<N, T> as GetUnchecked<Stride>>::Data == T, 

type Data = T

pub fn for_each(&self, extent: &ExtentN<N>, f: impl FnMut(PointN<N>, T))

impl<N, T> ForEach<N, Stride> for ArrayN<N, T> where
    ArrayN<N, T>: Sized,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: Get<Stride>,
    ArrayN<N, T>: GetUnchecked<Stride>,
    <ArrayN<N, T> as Get<Stride>>::Data == T,
    <ArrayN<N, T> as GetUnchecked<Stride>>::Data == T, 

type Data = T

pub fn for_each(&self, extent: &ExtentN<N>, f: impl FnMut(Stride, T))

impl<N, T> ForEachMut<N, (PointN<N>, Stride)> for ArrayN<N, T> where
    ArrayN<N, T>: Sized,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: GetMut<Stride>,
    ArrayN<N, T>: GetUncheckedMut<Stride>,
    ExtentN<N>: Copy,
    <ArrayN<N, T> as GetMut<Stride>>::Data == T,
    <ArrayN<N, T> as GetUncheckedMut<Stride>>::Data == T, 

type Data = T

pub fn for_each_mut(
    &mut self,
    extent: &ExtentN<N>,
    f: impl FnMut((PointN<N>, Stride), &mut T)
)

impl<N, T> ForEachMut<N, PointN<N>> for ArrayN<N, T> where
    ArrayN<N, T>: Sized,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: GetMut<Stride>,
    ArrayN<N, T>: GetUncheckedMut<Stride>,
    ExtentN<N>: Copy,
    <ArrayN<N, T> as GetMut<Stride>>::Data == T,
    <ArrayN<N, T> as GetUncheckedMut<Stride>>::Data == T, 

type Data = T

pub fn for_each_mut(
    &mut self,
    extent: &ExtentN<N>,
    f: impl FnMut(PointN<N>, &mut T)
)

impl<N, T> ForEachMut<N, Stride> for ArrayN<N, T> where
    ArrayN<N, T>: Sized,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: GetMut<Stride>,
    ArrayN<N, T>: GetUncheckedMut<Stride>,
    ExtentN<N>: Copy,
    <ArrayN<N, T> as GetMut<Stride>>::Data == T,
    <ArrayN<N, T> as GetUncheckedMut<Stride>>::Data == T, 

type Data = T

pub fn for_each_mut(
    &mut self,
    extent: &ExtentN<N>,
    f: impl FnMut(Stride, &mut T)
)

impl<'_, N, T> Get<&'_ Local<N>> for ArrayN<N, T> where
    T: Clone,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: Get<Stride>,
    <ArrayN<N, T> as Get<Stride>>::Data == T, 

type Data = T

pub fn get(&self, p: &Local<N>) -> <ArrayN<N, T> as Get<&'_ Local<N>>>::Data

Get an owned value at location.

impl<'_, N, T> Get<&'_ PointN<N>> for ArrayN<N, T> where
    T: Clone,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: for<'r> Get<&'r Local<N>>,
    PointN<N>: Point,
    <ArrayN<N, T> as Get<&'r Local<N>>>::Data == T, 

type Data = T

pub fn get(&self, p: &PointN<N>) -> <ArrayN<N, T> as Get<&'_ PointN<N>>>::Data

Get an owned value at location.

impl<N, T> Get<Stride> for ArrayN<N, T> where
    T: Clone, 

type Data = T

pub fn get(&self, stride: Stride) -> <ArrayN<N, T> as Get<Stride>>::Data

Get an owned value at location.

impl<'_, N, T> GetMut<&'_ Local<N>> for ArrayN<N, T> where
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: GetMut<Stride>,
    <ArrayN<N, T> as GetMut<Stride>>::Data == T, 

type Data = T

pub fn get_mut(
    &mut self,
    p: &Local<N>
) -> &mut <ArrayN<N, T> as GetMut<&'_ Local<N>>>::Data

Get a mutable reference to the value at location.

impl<'_, N, T> GetMut<&'_ PointN<N>> for ArrayN<N, T> where
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: for<'r> GetMut<&'r Local<N>>,
    PointN<N>: Point,
    <ArrayN<N, T> as GetMut<&'r Local<N>>>::Data == T, 

type Data = T

pub fn get_mut(
    &mut self,
    p: &PointN<N>
) -> &mut <ArrayN<N, T> as GetMut<&'_ PointN<N>>>::Data

Get a mutable reference to the value at location.

impl<N, T> GetMut<Stride> for ArrayN<N, T>

type Data = T

pub fn get_mut(
    &mut self,
    stride: Stride
) -> &mut <ArrayN<N, T> as GetMut<Stride>>::Data

Get a mutable reference to the value at location.

impl<'_, N, T> GetUnchecked<&'_ Local<N>> for ArrayN<N, T> where
    T: Clone,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: GetUnchecked<Stride>,
    <ArrayN<N, T> as GetUnchecked<Stride>>::Data == T, 

type Data = T

pub unsafe fn get_unchecked(
    &self,
    p: &Local<N>
) -> <ArrayN<N, T> as GetUnchecked<&'_ Local<N>>>::Data

Get the value at location without doing bounds checking.

impl<'_, N, T> GetUnchecked<&'_ PointN<N>> for ArrayN<N, T> where
    T: Clone,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: for<'r> GetUnchecked<&'r Local<N>>,
    PointN<N>: Point,
    <ArrayN<N, T> as GetUnchecked<&'r Local<N>>>::Data == T, 

type Data = T

pub unsafe fn get_unchecked(
    &self,
    p: &PointN<N>
) -> <ArrayN<N, T> as GetUnchecked<&'_ PointN<N>>>::Data

Get the value at location without doing bounds checking.

impl<N, T> GetUnchecked<Stride> for ArrayN<N, T> where
    T: Clone, 

type Data = T

pub unsafe fn get_unchecked(
    &self,
    stride: Stride
) -> <ArrayN<N, T> as GetUnchecked<Stride>>::Data

Get the value at location without doing bounds checking.

impl<'_, N, T> GetUncheckedMut<&'_ Local<N>> for ArrayN<N, T> where
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: GetUncheckedMut<Stride>,
    <ArrayN<N, T> as GetUncheckedMut<Stride>>::Data == T, 

type Data = T

pub unsafe fn get_unchecked_mut(
    &mut self,
    p: &Local<N>
) -> &mut <ArrayN<N, T> as GetUncheckedMut<&'_ Local<N>>>::Data

Get a mutable reference to the value at location without doing bounds checking.

impl<'_, N, T> GetUncheckedMut<&'_ PointN<N>> for ArrayN<N, T> where
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: for<'r> GetUncheckedMut<&'r Local<N>>,
    PointN<N>: Point,
    <ArrayN<N, T> as GetUncheckedMut<&'r Local<N>>>::Data == T, 

type Data = T

pub unsafe fn get_unchecked_mut(
    &mut self,
    p: &PointN<N>
) -> &mut <ArrayN<N, T> as GetUncheckedMut<&'_ PointN<N>>>::Data

Get a mutable reference to the value at location without doing bounds checking.

impl<N, T> GetUncheckedMut<Stride> for ArrayN<N, T>

type Data = T

pub unsafe fn get_unchecked_mut(
    &mut self,
    stride: Stride
) -> &mut <ArrayN<N, T> as GetUncheckedMut<Stride>>::Data

Get a mutable reference to the value at location without doing bounds checking.

impl<N, T> PartialEq<ArrayN<N, T>> for ArrayN<N, T> where
    N: PartialEq<N>,
    T: PartialEq<T>, 

pub fn eq(&self, other: &ArrayN<N, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &ArrayN<N, T>) -> bool

This method tests for !=.

impl<'a, N, T> ReadExtent<'a, N> for ArrayN<N, T> where
    N: 'a,
    T: 'a,
    PointN<N>: IntegerPoint, 

type Src = ArrayCopySrc<&'a ArrayN<N, T>>

type SrcIter = Once<(ExtentN<N>, <ArrayN<N, T> as ReadExtent<'a, N>>::Src)>

pub fn read_extent(
    &'a self,
    extent: &ExtentN<N>
) -> <ArrayN<N, T> as ReadExtent<'a, N>>::SrcIter

SrcIter must return extents that are subsets of extent.

impl<N, T> Serialize for ArrayN<N, T> where
    N: Serialize,
    T: Serialize, 

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<N, T> StructuralEq for ArrayN<N, T>

impl<N, T> StructuralPartialEq for ArrayN<N, T>

impl<'a, N, T> WriteExtent<N, ArrayCopySrc<&'a ArrayN<N, T>>> for ArrayN<N, T> where
    T: Clone,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: GetUncheckedRelease<Stride, T>,
    PointN<N>: IntegerPoint,
    ExtentN<N>: Copy, 

pub fn write_extent(
    &mut self,
    extent: &ExtentN<N>,
    src_array: ArrayCopySrc<&'a ArrayN<N, T>>
)

impl<'a, N, T, M, F> WriteExtent<N, ArrayCopySrc<TransformMap<'a, M, F>>> for ArrayN<N, T> where
    T: Clone,
    ArrayN<N, T>: Array<N>,
    TransformMap<'a, M, F>: Array<N>,
    TransformMap<'a, M, F>: GetUncheckedRelease<Stride, T>,
    PointN<N>: IntegerPoint,
    ExtentN<N>: Copy, 

pub fn write_extent(
    &mut self,
    extent: &ExtentN<N>,
    src_array: ArrayCopySrc<TransformMap<'a, M, F>>
)

impl<M, N, T> WriteExtent<N, Either<ArrayCopySrc<M>, AmbientExtent<N, T>>> for ArrayN<N, T> where
    T: Clone,
    ArrayN<N, T>: Array<N>,
    ArrayN<N, T>: WriteExtent<N, ArrayCopySrc<M>>,
    ExtentN<N>: Copy,
    ExtentN<N>: IntegerExtent<N>,
    ExtentN<N>: PartialEq<ExtentN<N>>, 

pub fn write_extent(
    &mut self,
    extent: &ExtentN<N>,
    src: Either<ArrayCopySrc<M>, AmbientExtent<N, T>>
)

impl<'a, N, F, T> WriteExtent<N, F> for ArrayN<N, T> where
    F: Fn(&PointN<N>) -> T,
    T: 'a + Clone,
    PointN<N>: IntegerPoint,
    ExtentN<N>: IntegerExtent<N>,
    ArrayN<N, T>: ForEachMut<N, PointN<N>>,
    <ArrayN<N, T> as ForEachMut<N, PointN<N>>>::Data == T, 

pub fn write_extent(&mut self, extent: &ExtentN<N>, src: F)