1 /*!
2 \mainpage N-Dimensional Binary Trees
3 
4 This documentation describes how to use the n-dimensional binary tree C++ classes.
5 The classes are all templated and behave similarly to the STL.
6 Even though the class names all contain octree, they provide a generalization to any integer dimension.
7 
8 The octree class stores the root node of the tree plus information about the geometric embedding of the tree (if any).
9 The octree_node class represents nodes in the tree and stores a pointer to the parent and child nodes plus a templated
10 class instance of your choosing.
11 Finally, octree_cursor and octree_iterator are subclasses of octree_path and provide a way to traverse
12 the tree in either free-form or a depth-first fashion, respectively.
13 
14 */
15