com.savarese.spatial
Interface RangeSearchTree<Coord extends java.lang.Comparable<? super Coord>,P extends Point<Coord>,V>

All Superinterfaces:

java.util.Map<P,V>

All Known Implementing Classes:

KDTree

public interface RangeSearchTree<Coord extends java.lang.Comparable<? super Coord>,P extends Point<Coord>,V>
extends java.util.Map<P,V>

A RangeSearchTree is a spatial data structure that supports the retrieval of data associated with point keys as well as the searching of data that occurs within a specified range of points.

Note: RangeSearchTree does not implement SortedMap for range searching bcause the SortedMap interface is not well-suited to multi-dimensional range search trees.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

java.util.Iterator<java.util.Map.Entry<P,V>>

iterator(P lower, P upper) Returns an iterator for mappings that are contained in the rectangle defined by the given lower left-hand and upper right-hand corners.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

iterator

java.util.Iterator<java.util.Map.Entry<P,V>> iterator(P lower,
                                                      P upper)

Returns an iterator for mappings that are contained in the rectangle defined by the given lower left-hand and upper right-hand corners. The mappings returned include those occuring at points on the bounding rectangle, not just those inside.

Parameters:

lower - The lower left-hand corner of the bounding rectangle. A null value can be used to specify the region is unbounded in that direction.

upper - The upper right-hand corner of the bounding rectangle. A null value can be used to specify the region is unbounded in that direction.

Returns:

An iterator for mappings that are contained in the specified rectangle.