Struct dinotree::DinoTreeRefMut

pub struct DinoTreeRefMut<'a, A: AxisTrait, T: HasAabb> { /* fields omitted */ }

Mutable referance to a dinotree container.

Methods

impl<'a, A: AxisTrait, T: HasAabb> DinoTreeRefMut<'a, A, T>

pub fn as_ref_mut(&mut self) -> DinoTreeRefMut<A, T>

pub fn vistr_mut(&mut self) -> VistrMut<T>

pub fn into_vistr_mut(self) -> VistrMut<'a, T>

Important traits for IterMut<'a, T>

impl<'a, T> Iterator for IterMut<'a, T> type Item = &'a mut T;

pub fn iter_mut(&mut self) -> IterMut<T>

Iterate over all the bots in the tree. The order in which they are iterated over is dfs pre order as they have been binned and sorted into the dinotree.

Important traits for IterMut<'a, T>

impl<'a, T> Iterator for IterMut<'a, T> type Item = &'a mut T;

pub fn into_iter_mut(self) -> IterMut<'a, T>

Iterate over all bots.

Methods from Deref<Target = DinoTreeRef<'a, A, T>>

pub fn as_ref(&self) -> DinoTreeRef<A, T>

pub fn axis(&self) -> A

pub fn vistr(&self) -> Vistr<T>

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;

pub fn iter(&self) -> Iter<T>

Iterate over all the bots in the tree. The order in which they are iterated over is dfs pre order as they have been binned and sorted into the dinotree.

pub fn height(&self) -> usize

Return the height of the dinotree.

pub fn num_nodes(&self) -> usize

Return the number of nodes of the dinotree.

pub fn num_bots(&self) -> usize

Return the number of bots in the tree.

#[must_use] pub fn are_invariants_met(&self) -> bool

Returns Ok, then this tree's invariants are being met. Should always return true, unless the user corrupts the trees memory or if the contract of the HasAabb trait are not upheld.

Trait Implementations

impl<'a, A: AxisTrait, T: HasAabb> Deref for DinoTreeRefMut<'a, A, T>

type Target = DinoTreeRef<'a, A, T>

The resulting type after dereferencing.

fn deref(&self) -> &DinoTreeRef<'a, A, T>

Dereferences the value.