Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-7941: Clarify contract for intersects() method.

This commit is contained in:
Karl Wright 2017-08-25 11:42:29 -04:00
parent 554f0d5f20
commit e157f1f8c2
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lucene/spatial3d/src/java/org/apache/lucene/spatial3d/geom/GeoShape.java
View File

@ -35,7 +35,8 @@ public interface GeoShape extends Membership, PlanetObject {
/**
* Assess whether a plane, within the provided bounds, intersects
* with the shape. Note well that this method is allowed to return "true"
* with the shape's edges. Any overlap, even a single point, is considered to be an
* intersection. Note well that this method is allowed to return "true"
* if there are internal edges of a composite shape which intersect the plane.
* Doing this can cause getRelationship() for most GeoBBox shapes to return
* OVERLAPS rather than the more correct CONTAINS, but that cannot be