Struct OctantMap 

pub struct OctantMap<T>(/* private fields */);

Collection of 8 values keyed by Octants.

If the values are bool, use OctantMask instead for a more efficient representation.

Implementations

impl<T> OctantMap<T>

pub fn from_fn(function: impl FnMut(Octant) -> T) -> Self

Constructs an OctantMap by using the provided function to compute a value for each octant.

pub fn repeat(value: T) -> Self

where T: Clone,

Constructs an OctantMap by cloning the provided value.

pub fn to_mask(&self, predicate: impl FnMut(&T) -> bool) -> OctantMask

Returns an OctantMask constructed by applying the given predicate to each octant of the data in self.

pub fn iter(&self) -> impl Iterator<Item = (Octant, &T)> + '_

Returns an iterator over all elements by reference, and their octants.

The order of iteration is not currently guarateed.

pub fn values(&self) -> impl Iterator<Item = &T> + '_

Returns an iterator over all elements by reference.

The order of iteration is not currently guarateed.

pub fn iter_mut(&mut self) -> impl Iterator<Item = (Octant, &mut T)> + '_

Returns an iterator over all elements by mutable reference.

The order of iteration is not currently guarateed.

Trait Implementations

impl<T: Clone> Clone for OctantMap<T>

fn clone(&self) -> OctantMap<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for OctantMap<T>

impl<T: Debug> Debug for OctantMap<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for OctantMap<T>

fn default() -> OctantMap<T>

Returns the “default value” for a type.

impl<T: Eq> Eq for OctantMap<T>

impl<T> Exhaust for OctantMap<T>

where T: Exhaust,

type Iter = ExhaustOctantMapIter<T>

Iterator type returned by Self::exhaust_factories(). See the trait documentation for what properties this iterator should have.

type Factory = ExhaustOctantMapFactory<T>

Data which can be used to construct Self.

fn exhaust_factories() -> Self::Iter

Returns an iterator over factories for all values of this type.

fn from_factory(factory: Self::Factory) -> Self

Construct a concrete value of this type from a Self::Factory value produced by its Self::Iter.

fn exhaust() -> Iter<Self>

Returns an iterator over all values of this type.

impl<T: Hash> Hash for OctantMap<T>

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<Octant> for OctantMap<T>

type Output = T

The returned type after indexing.

fn index(&self, octant: Octant) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Octant> for OctantMap<T>

fn index_mut(&mut self, octant: Octant) -> &mut Self::Output

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

impl<T: PartialEq> PartialEq for OctantMap<T>

fn eq(&self, other: &OctantMap<T>) -> 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> StructuralPartialEq for OctantMap<T>