ItemDistance

A function method which computes the distance between two {link ItemBoundable}s in an {link STRtree}. Used for Nearest Neighbour searches.

To make a distance function suitable for querying a single index tree via {link STRtree#nearestNeighbour(ItemDistance)} , the function should have a non-zero <i>reflexive distance</i>. 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 <b>distinct</b> items be returned, the distance function must be <i>anti-reflexive</i>, and must return {link Double#MAX_VALUE} for identical arguments.

class Object
trait Matchable
class Any

Value members

Abstract methods

def distance(item1: ItemBoundable, item2: ItemBoundable): Double

Computes the distance between two items.

Computes the distance between two items.

Value Params
item2

return the distance between the items throws IllegalArgumentException if the metric is not applicable to the arguments