org.danilopianini.lang

Interface SpatialIndex<E>

Type Parameters:

E - content of the index

All Superinterfaces:

Serializable

All Known Implementing Classes:

FlexibleQuadTree

public interface SpatialIndex<E>
extends Serializable

Method Summary

Modifier and Type	Method and Description
int	getDimensions()
void	insert(E element, double... position) Inserts an element in the SpatialIndex.
boolean	move(E element, double[] start, double[] end) If an element is moved, updates the SpatialIndex accordingly.
List<E>	query(double[]... parallelotope) Queries the SpatialIndex, searching for elements in a parallelotope.
boolean	remove(E element, double... position) Deletes an element from the SpatialIndex.

Method Detail

insert

void insert(E element,
            double... position)

Inserts an element in the SpatialIndex.

Parameters:

element - The element to add

position - the coordinates where the element should be added

remove

boolean remove(E element,
               double... position)

Deletes an element from the SpatialIndex.

Parameters:

element - The element to add

position - the coordinates where the element should be added

Returns:

true if the element is found and removed

move

boolean move(E element,
             double[] start,
             double[] end)

If an element is moved, updates the SpatialIndex accordingly.

Parameters:

element - The element to add

start - the coordinates where the element is currently located

end - the coordinates where the element is should be moved

Returns:

true if the element is found and moved

query

List<E> query(double[]... parallelotope)

Queries the SpatialIndex, searching for elements in a parallelotope. "Parallelotope" is a fancy word for "N-dimensional rectangle". A 2-parallelotope is in fact a rectangle, a 3-parallelotope is a parallelepiped, and so on.

Parameters:

parallelotope - the space where to search for elements

Returns:

the list of elements in this area of the SpatialIndex.

getDimensions

int getDimensions()

Returns:

the number of dimension of space for this SpatialIndex.