goldman.collection.tagged.spatial
Interface TaggedSpatialCollection<T,E>

All Superinterfaces:
Iterable<TaggedElement<T,E>>, TaggedCollection<T,E>
All Known Implementing Classes:
TaggedKDTree, TaggedQuadTree, TaggedSpatialCollectionWrapper

public interface TaggedSpatialCollection<T,E>
extends TaggedCollection<T,E>

In this section we present the TaggedSpatialCollection ADT, which is a tagged variation of the SpatialCollection ADT.


Method Summary
 TaggedElement<T,E> max(int dimension)
          Returns a tagged element for the greatest tag in the collection (according to the comparator) in the given dimension.
 TaggedElement<T,E> min(int dimension)
          Returns a tagged element for the least tag in the collection (according to the comparator) along the given dimension.
 Collection<TaggedElement<T,E>> withinBounds(T minCorner, T maxCorner)
          Returns a collection of the tagged elements for which the tag fall within (or on) the boundary of the multidimensional box defined by the two given corners, minCorner and maxCorner.
 
Methods inherited from interface goldman.collection.tagged.TaggedCollection
accept, clear, contains, elements, ensureCapacity, get, getCapacity, getLocator, getSize, isEmpty, iterator, put, putAll, remove, tags, toString, trimToSize, values
 

Method Detail

min

TaggedElement<T,E> min(int dimension)
Returns a tagged element for the least tag in the collection (according to the comparator) along the given dimension. It throws a NoSuchElementException when the collection is empty.


max

TaggedElement<T,E> max(int dimension)
Returns a tagged element for the greatest tag in the collection (according to the comparator) in the given dimension. It throws a NoSuchElementException when the collection is empty.


withinBounds

Collection<TaggedElement<T,E>> withinBounds(T minCorner,
                                            T maxCorner)
Returns a collection of the tagged elements for which the tag fall within (or on) the boundary of the multidimensional box defined by the two given corners, minCorner and maxCorner. The method requires that the coordinates of minCorner are less than or equal to those of maxCorner along every dimension of the spatial collection.