Struct dmc::octree::HashedOctree

pub struct HashedOctree<T: Copy> { /* fields omitted */ }

A hashed (linear) octree implementation which uses MortonKey for indexing. This type supports concurrent access and uses a fast hashing algorithm for best performance.

Example

use dmc::octree::*;

let mut octree = HashedOctree::new(0usize);

let mut i = 0;
octree.subdivide(MortonKey::root()).for_each(|child| {
    *octree.value_mut(child).unwrap() = i; i += 1;
});
dbg!(octree);

Implementations

impl<T: Copy> HashedOctree<T>

pub fn new(root_value: T) -> Self

Creates a new hashed octree, with a value for the root node.

pub fn value(
    &self,
    key: MortonKey
) -> Option<Ref<'_, MortonKey, T, RandomState>>

Returns a reference to a node if it exists.

Concurrent Behaviour

May deadlock if called when holding a mutable reference into the octree.

pub fn value_mut(
    &mut self,
    key: MortonKey
) -> Option<RefMut<'_, MortonKey, T, RandomState>>

Returns a mutable reference to a node if it exists.

Concurrent Behaviour

May deadlock if called when holding any sort of reference into the octree.

pub fn subdivide(&mut self, key: MortonKey) -> impl Iterator<Item = MortonKey>

Subdivides a node and returns an iterator over its newly created children. The value of the children will be copied from the parent.

Panics

Panics if the node passed is already subdivided.

pub fn children(
    &self,
    key: MortonKey
) -> Option<impl Iterator<Item = MortonKey>>

Returns an iterator over the children of a node, or None if the children (or parent) don’t exist.

pub fn node_exists(&self, key: MortonKey) -> bool

Returns true if a node exists.

pub fn is_subdivided(&self, key: MortonKey) -> bool

Returns true if the children of a node exists.

Panics

Panics if the level of the key given is equal to the maximum level possible.

pub fn leaves(&self, parent: MortonKey) -> Vec<MortonKey>

Finds all the leaf nodes belonging to parent and returns a vector with a key for each of them.

pub fn node_count(&self) -> usize

Returns the total node count, including leaf and branch nodes.

Trait Implementations

impl<T: Clone + Copy> Clone for HashedOctree<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Copy> Debug for HashedOctree<T>

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

Formats the value using the given formatter.