BoxDistance.FarthestNeighbor (tinspin-indexes 2.1.3 API)

java.lang.Object
- org.tinspin.index.BoxDistance.FarthestNeighbor

All Implemented Interfaces:

BoxDistance

Enclosing interface:

BoxDistance
```
public static class BoxDistance.FarthestNeighbor
extends Object
implements BoxDistance
```
Special wrapper class which takes the inverse or the given function. Can be used to get the farthest neighbors using the nearest neighbor algorithm.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.tinspin.index.BoxDistance
  BoxDistance.EdgeDistance, BoxDistance.FarthestNeighbor, BoxDistance.RectangleDist

Field Summary
- Fields inherited from interface org.tinspin.index.BoxDistance
  CENTER, EDGE

Constructor Summary

Constructors
Constructor Description

FarthestNeighbor(BoxDistance dist)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`dist(double[] center, double[] min, double[] max)`
`double`	`dist(double[] center, Index.BoxEntry<?> entry)`	Some algorithm use this method on the entries containing user supplied values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FarthestNeighbor
```
public FarthestNeighbor(BoxDistance dist)
```
- Method Detail
  - dist
```
public double dist(double[] center,
                   double[] min,
                   double[] max)
```
    Specified by:
    
    dist in interface BoxDistance
    
    Parameters:
    
    center - A point
    
    min - Minimum corner of axis aligned box
    
    max - Maximum corner of axis aligned box
    
    Returns:
    
    Distance between point and box
  - dist
```
public double dist(double[] center,
                   Index.BoxEntry<?> entry)
```
    Description copied from interface: BoxDistance
    
    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.
    
    Specified by:
    
    dist in interface BoxDistance
    
    Parameters:
    
    center - a point
    
    entry - a box
    
    Returns:
    
    distance between point and box