Struct broccoli::analyze::TreePreBuilder

pub struct TreePreBuilder { /* fields omitted */ }

Using this struct the user can determine the height of a tree or the number of nodes that would exist if the tree were constructed with the specified number of elements.

Implementations

impl TreePreBuilder

pub const fn new(num_elements: usize) -> TreePreBuilder

Create the builder object with default values.

pub const fn with_num_elem_in_leaf(
    num_elements: usize,
    num_elem_leaf: usize
) -> TreePreBuilder

Specify a custom default nuber of elements per leaf.

pub fn with_height_seq(&mut self, height: usize)

Specify at which level to switch from parallel to sequential when parallel functions are used.

pub const fn with_height(height: usize) -> TreePreBuilder

Specify a custom height of the tree, ignoring the number of elements per node variable.

pub fn into_builder<'a, T: Aabb>(
    &self,
    bots: &'a mut [T]
) -> TreeBuilder<'a, DefaultA, T>

Create a TreeBuilder

pub fn into_builder_with_axis<'a, A: Axis, T: Aabb>(
    &self,
    bots: &'a mut [T],
    axis: A
) -> TreeBuilder<'a, A, T>

Create a TreeBuilder with a use specified axis.

pub const fn get_height_seq(&self) -> usize

Return the level at which parallel algorithms will switch to sequential.

pub const fn num_nodes(&self) -> usize

Compute the number of nodes in the tree based off of the height.

pub const fn get_height(&self) -> usize

Get the currently configured height.

Trait Implementations

impl Clone for TreePreBuilder

pub fn clone(&self) -> TreePreBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TreePreBuilder