Crate broccoli::tree

This is a supporting crate to the broccoli crate. This crate only provides the broccoli tree and tree building code, but no querying code.

Modules

aabb_pin

Provides a mutable pointer type that is more restrictive that &mut T, in order to protect tree invariants. AabbPin is short for protected mutable reference.

build

Tree building blocks

node

num_level

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.

splitter

Tree building functions that allow arbitrary code to be run every time the problem is split into two and built back together. Useful for debuging/measuring performance.

util

Utility functions

Structs

TreeInner

The main tree struct

TreeOwned

Owned version of Tree

Traits

Container

Abstract over containers that produce &mut [T]

Sorter

Expose a common Sorter trait so that we may have two version of the tree where one implementation actually does sort the tree, while the other one does nothing when sort() is called.

TreeBuild

Specify options for constructing the tree.

Functions

bbox

Shorthand constructor of BBox

bbox_mut

Shorthand constructor of BBoxMut

default_axis

Returns the default axis type.

new

Create a Tree.

new_owned

Create a TreeOwned

rect

Convenience function to create a Rect.

Type Definitions

DefaultA

The default starting axis of a Tree. It is set to be the X axis. This means that the first divider is a ‘vertical’ line since it is partitioning space based off of the aabb’s X value.

Tree

TreeInner type with default node and sorter.