Interface ItemDistance
- All Known Implementing Classes:
GeometryItemDistance
public interface ItemDistance
A function method which computes the distance
between two
ItemBoundable
s in an STRtree
.
Used for Nearest Neighbour searches.
To make a distance function suitable for
querying a single index tree
via STRtree.nearestNeighbour(ItemDistance)
,
the function should have a non-zero reflexive distance.
That is, if the two arguments are the same object,
the distance returned should be non-zero.
If it is required that only pairs of distinct items be returned,
the distance function must be anti-reflexive,
and must return Double.MAX_VALUE
for identical arguments.
- Author:
- Martin Davis
-
Method Summary
Modifier and TypeMethodDescriptiondouble
distance
(ItemBoundable item1, ItemBoundable item2) Computes the distance between two items.
-
Method Details
-
distance
Computes the distance between two items.- Parameters:
item1
-item2
-- Returns:
- the distance between the items
- Throws:
IllegalArgumentException
- if the metric is not applicable to the arguments
-