org.apache.lucene.spatial.spatial4j.geo3d

Interface GeoDistance

All Superinterfaces:

Membership

All Known Subinterfaces:

GeoDistanceShape

All Known Implementing Classes:

GeoCircle, GeoPath

public interface GeoDistance
extends Membership

Generic geo-distance-capable shape class description. An implementer of this interface is capable of computing the described "distance" values, which are meant to provide both actual distance values, as well as distance estimates that can be computed more cheaply.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Method Summary

Methods

Modifier and Type	Method and Description
double	computeArcDistance(GeoPoint point) Compute a true, accurate, great-circle distance to a point.
double	computeLinearDistance(double x, double y, double z) Compute this shape's linear "distance" to the GeoPoint.
double	computeLinearDistance(GeoPoint point) Compute this shape's linear "distance" to the GeoPoint.
double	computeNormalDistance(double x, double y, double z) Compute this shape's normal "distance" to the GeoPoint.
double	computeNormalDistance(GeoPoint point) Compute this shape's normal "distance" to the GeoPoint.
double	computeSquaredLinearDistance(double x, double y, double z) Compute the square of this shape's linear "distance" to the GeoPoint.
double	computeSquaredLinearDistance(GeoPoint point) Compute the square of this shape's linear "distance" to the GeoPoint.
double	computeSquaredNormalDistance(double x, double y, double z) Compute the square of this shape's normal "distance" to the GeoPoint.
double	computeSquaredNormalDistance(GeoPoint point) Compute the square of this shape's normal "distance" to the GeoPoint.

Methods inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.Membership

isWithin, isWithin

Method Detail

computeNormalDistance

double computeNormalDistance(GeoPoint point)

Compute this shape's normal "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Parameters:

point - is the point to compute the distance to.

Returns:

the normal distance, defined as the perpendicular distance from from the point to one of the shape's bounding plane. Normal distances can therefore typically only go up to PI/2, except when they represent the sum of a sequence of normal distances.

computeNormalDistance

double computeNormalDistance(double x,
                           double y,
                           double z)

Compute this shape's normal "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Parameters:

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the normal distance, defined as the perpendicular distance from from the point to one of the shape's bounding plane. Normal distances can therefore typically only go up to PI/2, except when they represent the sum of a sequence of normal distances.

computeSquaredNormalDistance

double computeSquaredNormalDistance(GeoPoint point)

Compute the square of this shape's normal "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Parameters:

point - is the point to compute the distance to.

Returns:

the square of the normal distance, defined as the perpendicular distance from from the point to one of the shape's bounding plane. Normal distances can therefore typically only go up to PI/2, except when they represent the sum of a sequence of normal distances.

computeSquaredNormalDistance

double computeSquaredNormalDistance(double x,
                                  double y,
                                  double z)

Compute the square of this shape's normal "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Parameters:

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the square of the normal distance, defined as the perpendicular distance from from the point to one of the shape's bounding plane. Normal distances can therefore typically only go up to PI/2, except when they represent the sum of a sequence of normal distances.

computeLinearDistance

double computeLinearDistance(GeoPoint point)

Compute this shape's linear "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Parameters:

point - is the point to compute the distance to.

Returns:

the linear (or chord) distance, defined as the distance from from the point to the nearest point on the unit sphere and on one of the shape's bounding planes. Linear distances can therefore typically go up to PI, except when they represent the sum of a sequence of linear distances.

computeLinearDistance

double computeLinearDistance(double x,
                           double y,
                           double z)

Compute this shape's linear "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Parameters:

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the linear (or chord) distance, defined as the distance from from the point to the nearest point on the unit sphere and on one of the shape's bounding planes. Linear distances can therefore typically go up to PI, except when they represent the sum of a sequence of linear distances.

computeSquaredLinearDistance

double computeSquaredLinearDistance(GeoPoint point)

Compute the square of this shape's linear "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Parameters:

point - is the point to compute the distance to.

Returns:

the square of the linear (or chord) distance, defined as the distance from from the point to the nearest point on the unit sphere and on one of the shape's bounding planes. Linear distances can therefore typically go up to PI, except when they represent the sum of a sequence of linear distances.

computeSquaredLinearDistance

double computeSquaredLinearDistance(double x,
                                  double y,
                                  double z)

Compute the square of this shape's linear "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Parameters:

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the square of the linear (or chord) distance, defined as the distance from from the point to the nearest point on the unit sphere and on one of the shape's bounding planes. Linear distances can therefore typically go up to PI, except when they represent the sum of a sequence of linear distances.

computeArcDistance

double computeArcDistance(GeoPoint point)

Compute a true, accurate, great-circle distance to a point. Double.MAX_VALUE indicates a point is outside of the shape.

Parameters:

point - is the point.

Returns:

the distance.