org.oscim.utils

Class RTree<T>

java.lang.Object

org.oscim.utils.RTree<T>

All Implemented Interfaces:

java.lang.Iterable<T>, SpatialIndex<T>

public class RTree<T>
extends java.lang.Object
implements SpatialIndex<T>, java.lang.Iterable<T>

Implementation of RTree, a multidimensional bounding rectangle tree.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RTree.Iterator<T>

Nested classes/interfaces inherited from interface org.oscim.utils.SpatialIndex

SpatialIndex.SearchCb<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.oscim.utils.RTree.Node	mRoot Root of tree
int	nodesAlloc
int	nodesFree

Constructor Summary

Constructors

Constructor and Description
RTree()

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all entries from tree.
void	insert(Box box, T item)
void	insert(double[] min, double[] max, T item) Insert item.
boolean	insertRect(org.oscim.utils.RTree.Rect rect, T item, int level) Insert a data rectangle into an index structure.
java.util.Iterator<T>	iterator()
void	printStats()
boolean	remove(Box box, T item)
boolean	remove(double[] min, double[] max, T item) Remove item.
boolean	removeRect(org.oscim.utils.RTree.Rect rect, T item) Delete a data rectangle from an index structure.
java.util.List<T>	search(Box bbox, java.util.List<T> results)
boolean	search(Box bbox, SpatialIndex.SearchCb<T> cb, java.lang.Object context)
boolean	search(double[] min, double[] max, SpatialIndex.SearchCb<T> cb, java.lang.Object context) Find all items within search rectangle.
boolean	searchStack(org.oscim.utils.RTree.Rect rect, java.util.List<T> results)
void	searchStack(org.oscim.utils.RTree.Rect rect, SpatialIndex.SearchCb<T> cb, java.lang.Object context)
int	size() Count the data elements in this container.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

mRoot

protected org.oscim.utils.RTree.Node mRoot

Root of tree

nodesAlloc

public int nodesAlloc

nodesFree

public int nodesFree

Constructor Detail

RTree

public RTree()

Method Detail

insert

public void insert(double[] min,
                   double[] max,
                   T item)

Insert item.

Parameters:

min - Min of bounding rect

max - Max of bounding rect

item - data.

insert

public void insert(Box box,
                   T item)

Specified by:

insert in interface SpatialIndex<T>

remove

public boolean remove(double[] min,
                      double[] max,
                      T item)

Remove item.

Parameters:

min - Min of bounding rect

max - Max of bounding rect

item - data.

remove

public boolean remove(Box box,
                      T item)

Specified by:

remove in interface SpatialIndex<T>

search

public boolean search(double[] min,
                      double[] max,
                      SpatialIndex.SearchCb<T> cb,
                      java.lang.Object context)

Find all items within search rectangle.

Parameters:

a_min - Min of search bounding rect

a_max - Max of search bounding rect

a_searchResult - Search result array. Caller should set grow size. Function will reset, not append to array.

a_resultCallback - Callback function to return result. Callback should return 'true' to continue searching

a_context - User context to pass as parameter to a_resultCallback

Returns:

Returns the number of entries found

search

public boolean search(Box bbox,
                      SpatialIndex.SearchCb<T> cb,
                      java.lang.Object context)

Specified by:

search in interface SpatialIndex<T>

search

public java.util.List<T> search(Box bbox,
                                java.util.List<T> results)

Specified by:

search in interface SpatialIndex<T>

size

public int size()

Count the data elements in this container. This is slow as no internal counter is maintained.

Specified by:

size in interface SpatialIndex<T>

clear

public void clear()

Remove all entries from tree.

Specified by:

clear in interface SpatialIndex<T>

printStats

public void printStats()

insertRect

public boolean insertRect(org.oscim.utils.RTree.Rect rect,
                          T item,
                          int level)

Insert a data rectangle into an index structure. InsertRect provides for splitting the root; returns 1 if root was split, 0 if it was not. The level argument specifies the number of steps up from the leaf level to insert; e.g. a data rectangle goes in at level = 0. InsertRect2 does the recursion.

removeRect

public boolean removeRect(org.oscim.utils.RTree.Rect rect,
                          T item)

Delete a data rectangle from an index structure. Pass in a pointer to a Rect, the tid of the record, ptr to ptr to root node.

Returns:

false if record not found, true if success. RemoveRect provides for eliminating the root.

searchStack

public void searchStack(org.oscim.utils.RTree.Rect rect,
                        SpatialIndex.SearchCb<T> cb,
                        java.lang.Object context)

searchStack

public boolean searchStack(org.oscim.utils.RTree.Rect rect,
                           java.util.List<T> results)

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>