josephswanson-wf / r_tree

RTree

A recursive RTree library written in Dart.

"R-trees are tree data structures used for spatial access methods, i.e., for indexing multi-dimensional information such as geographical coordinates, rectangles or polygons." - http://en.wikipedia.org/wiki/R-tree

API

• RTree ( [ Number branch_factor ] )

Parameters:

• branch_factor : optional : The maximum width of a node before a split is performed¹.

Returns:

• An empty RTree object.

RTree.insert

• insert ( RTreeDatum² item )

Parameters:

• item : required : An item to insert into the tree.

RTree.remove

• remove ( RTreeDatum² item )

Parameters:

• item : required : An item to remove from the RTree.

RTree.search

• search ( Rectangle area )

Parameters:

• area : required : An area to search within.

Returns:

• An Iterable<RTreeDatum<E>> of objects that overlap area.
• Note: Rectangles that simply share a border are not considered to overlap.

Notes

¹ Default max node width is currently 16.

² RTreeDatum is simply a way to bind a Rectangle to an Object.