org.tinspin.index.rtree

Interface DistanceFunction

All Known Implementing Classes:

DistanceFunction.FarthestNeighbor, DistanceFunction.RectangleDist

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface DistanceFunction

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DistanceFunction.FarthestNeighbor Special wrapper class which takes the inverse or the given function.
static class	DistanceFunction.RectangleDist This class calculates the distance to a rectangular shaped object.

Field Summary

Fields

Modifier and Type	Field and Description
static DistanceFunction	CENTER
static DistanceFunction	EDGE

Method Summary

Modifier and Type	Method and Description
static double	centerDistance(double[] center, double[] min, double[] max)
double	dist(double[] center, double[] min, double[] max)
default double	dist(double[] center, RectangleEntry<?> entry) Some algorithm use this method on the entries containing user supplied values.
static double	edgeDistance(double[] center, double[] min, double[] max)

Field Detail

CENTER

static final DistanceFunction CENTER

EDGE

static final DistanceFunction EDGE

Method Detail

dist

double dist(double[] center,
            double[] min,
            double[] max)

dist

default double dist(double[] center,
                    RectangleEntry<?> entry)

Some algorithm use this method on the entries containing user supplied values. This can be overridden if the min/max coordinates only represent the bounding-box of the object. If your entry is actually a sphere, a car, an human or a cat, you may need this.

centerDistance

static double centerDistance(double[] center,
                             double[] min,
                             double[] max)

edgeDistance

static double edgeDistance(double[] center,
                           double[] min,
                           double[] max)