Struct lz_eytzinger_tree::EytzingerTree

pub struct EytzingerTree<N> { /* fields omitted */ }

An Eytzinger tree is an N-tree stored in an array structure.

Methods

impl<N> EytzingerTree<N>

pub fn new(max_children_per_node: usize) -> Self

Creates a new Eytzinger tree with the specified maximum number of child nodes per parent.

Returns

The new Eytzinger tree.

Important traits for DepthFirstIter<'a, N>

impl<'a, N> Iterator for DepthFirstIter<'a, N> type Item = Node<'a, N>;

pub fn depth_first_iter(&self, order: DepthFirstOrder) -> DepthFirstIter<N>

Gets a depth-first iterator over all nodes.

Important traits for BreadthFirstIter<'a, N>

impl<'a, N> Iterator for BreadthFirstIter<'a, N> type Item = Node<'a, N>;

pub fn breadth_first_iter(&self) -> BreadthFirstIter<N>

Gets a breadth-first iterator over all nodes.

Important traits for DepthFirstIterator<N>

impl<N> Iterator for DepthFirstIterator<N> type Item = N;

pub fn into_depth_first_iterator(     self,     order: DepthFirstOrder ) -> DepthFirstIterator<N>

Important traits for BreadthFirstIterator<N>

impl<N> Iterator for BreadthFirstIterator<N> type Item = N;

pub fn into_breadth_first_iterator(self) -> BreadthFirstIterator<N>

pub fn is_empty(&self) -> bool

Gets whether the Eytzinger tree is empty.

pub fn len(&self) -> usize

Gets the number of nodes in the Eytzinger tree.

pub fn max_children_per_node(&self) -> usize

Gets the maximum number of children per parent node.

pub fn clear(&mut self)

Clears the Eytzinger tree, removing all nodes.

pub fn root(&self) -> Option<Node<N>>

Gets the root node, None if there was no root node.

The root node may be set with set_root_value.

pub fn root_mut(&mut self) -> Option<NodeMut<N>>

Gets the mutable root node, None if there was no root node.

The root node may be set with set_root_value.

pub fn set_root_value(&mut self, new_value: N) -> NodeMut<N>

Sets the value of the root node. All child nodes will remain as they are.

Returns

The new root node.

pub fn remove_root_value(&mut self) -> (Option<N>, VacantEntry<N>)

Removes the root value. This will also remove all children.

Returns

The old root value if there was one.

pub fn root_entry(&mut self) -> Entry<N>

Gets the entry for the root node.

Examples

use lz_eytzinger_tree::{EytzingerTree, entry::Entry};

let tree = {
    let mut tree = EytzingerTree::<u32>::new(8);
    tree.root_entry().or_insert(5);
    tree
};

let root = tree.root().unwrap();
assert_eq!(root.value(), &5);

pub fn map<U, F>(self, f: F) -> EytzingerTree<U> where     F: FnMut(N) -> U,

Builds a new EytzingerTree<N> with the values mapped using the specified selector.

Trait Implementations

impl<N: Eq> Eq for EytzingerTree<N>

impl<N: PartialEq> PartialEq<EytzingerTree<N>> for EytzingerTree<N>

fn eq(&self, other: &Self) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<N: Clone> Clone for EytzingerTree<N>

fn clone(&self) -> EytzingerTree<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for EytzingerTree<N>

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

Formats the value using the given formatter.

impl<N: Hash> Hash for EytzingerTree<N>

fn hash<H>(&self, state: &mut H) where     H: Hasher,

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].