RectangleDistanceFunction (tinspin-indexes 1.8.0 API)

All Known Implementing Classes:

RectangleDistanceFunction.FarthestNeighbor, RectangleDistanceFunction.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 RectangleDistanceFunction
```

Nested Class Summary

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

Field Summary

Fields
Modifier and Type Field Description

static RectangleDistanceFunction CENTER

static RectangleDistanceFunction EDGE

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`static double`	`centerDistance(double[] center, double[] min, double[] max)`
`double`	`dist(double[] point, 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 RectangleDistanceFunction CENTER

EDGE

static final RectangleDistanceFunction EDGE

Method Detail
- dist
```
double dist(double[] point,
            double[] min,
            double[] max)
```
  Parameters:
  
  point - A point
  
  min - Minimum corner of axis aligned box
  
  max - Maximum corner of axis aligned box
  
  Returns:
  
  Distance between point and box
- 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.
  
  Parameters:
  
  center - a point
  
  entry - a rectangle
  
  Returns:
  
  distance between point and rectangle
- centerDistance
```
static double centerDistance(double[] center,
                             double[] min,
                             double[] max)
```
- edgeDistance
```
static double edgeDistance(double[] center,
                           double[] min,
                           double[] max)
```