Package org.apache.lucene.document
Class XYPointDistanceComparator
java.lang.Object
org.apache.lucene.search.FieldComparator<Double>
org.apache.lucene.document.XYPointDistanceComparator
- All Implemented Interfaces:
LeafFieldComparator
Compares documents by distance from an origin point
When the least competitive item on the priority queue changes (setBottom), we recompute a bounding box representing competitive distance to the top-N. Then in compareBottom, we can quickly reject hits based on bounding box alone without computing distance for every element.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.search.FieldComparator
FieldComparator.RelevanceComparator, FieldComparator.TermOrdValComparator, FieldComparator.TermValComparator
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) double
(package private) SortedNumericDocValues
private long[]
(package private) final String
(package private) int
(package private) int
(package private) int
(package private) int
(package private) int
(package private) double
(package private) final double[]
private int
(package private) final double
(package private) final double
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
compare
(int slot1, int slot2) Compare hit at slot1 with hit at slot2.int
compareBottom
(int doc) Compare the bottom of the queue with this doc.int
compareTop
(int doc) Compare the top value with this doc.void
copy
(int slot, int doc) This method is called when a new hit is competitive.getLeafComparator
(LeafReaderContext context) Get a per-segmentLeafFieldComparator
to collect the givenLeafReaderContext
.void
setBottom
(int slot) Set the bottom slot, ie the "weakest" (sorted last) entry in the queue.void
Sets the Scorer to use in case a document's score is needed.void
setTopValue
(Double value) Record the top value, for future calls toLeafFieldComparator.compareTop(int)
.private void
(package private) double
sortKey
(int doc) value
(int slot) Return the actual value in the slot.Methods inherited from class org.apache.lucene.search.FieldComparator
compareValues, disableSkipping, setSingleSort
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.lucene.search.LeafFieldComparator
competitiveIterator, setHitsThresholdReached
-
Field Details
-
field
-
x
final double x -
y
final double y -
values
final double[] values -
bottom
double bottom -
topValue
double topValue -
currentDocs
SortedNumericDocValues currentDocs -
minX
int minX -
maxX
int maxX -
minY
int minY -
maxY
int maxY -
setBottomCounter
int setBottomCounter -
currentValues
private long[] currentValues -
valuesDocID
private int valuesDocID
-
-
Constructor Details
-
XYPointDistanceComparator
-
-
Method Details
-
setScorer
Description copied from interface:LeafFieldComparator
Sets the Scorer to use in case a document's score is needed.- Specified by:
setScorer
in interfaceLeafFieldComparator
- Parameters:
scorer
- Scorer instance that you should use to obtain the current hit's score, if necessary.
-
compare
public int compare(int slot1, int slot2) Description copied from class:FieldComparator
Compare hit at slot1 with hit at slot2.- Specified by:
compare
in classFieldComparator<Double>
- Parameters:
slot1
- first slot to compareslot2
- second slot to compare- Returns:
- any
N < 0
if slot2's value is sorted after slot1, anyN > 0
if the slot2's value is sorted before slot1 and0
if they are equal
-
setBottom
public void setBottom(int slot) Description copied from interface:LeafFieldComparator
Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. WhenLeafFieldComparator.compareBottom(int)
is called, you should compare against this slot. This will always be called beforeLeafFieldComparator.compareBottom(int)
.- Specified by:
setBottom
in interfaceLeafFieldComparator
- Parameters:
slot
- the currently weakest (sorted last) slot in the queue
-
setTopValue
Description copied from class:FieldComparator
Record the top value, for future calls toLeafFieldComparator.compareTop(int)
. This is only called for searches that use searchAfter (deep paging), and is called before any calls toFieldComparator.getLeafComparator(LeafReaderContext)
.- Specified by:
setTopValue
in classFieldComparator<Double>
-
setValues
- Throws:
IOException
-
compareBottom
Description copied from interface:LeafFieldComparator
Compare the bottom of the queue with this doc. This will only invoked after setBottom has been called. This should return the same result asFieldComparator.compare(int,int)
} as if bottom were slot1 and the new document were slot 2.For a search that hits many results, this method will be the hotspot (invoked by far the most frequently).
- Specified by:
compareBottom
in interfaceLeafFieldComparator
- Parameters:
doc
- that was hit- Returns:
- any
N < 0
if the doc's value is sorted after the bottom entry (not competitive), anyN > 0
if the doc's value is sorted before the bottom entry and0
if they are equal. - Throws:
IOException
-
copy
Description copied from interface:LeafFieldComparator
This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot.- Specified by:
copy
in interfaceLeafFieldComparator
- Parameters:
slot
- which slot to copy the hit todoc
- docID relative to current reader- Throws:
IOException
-
getLeafComparator
Description copied from class:FieldComparator
Get a per-segmentLeafFieldComparator
to collect the givenLeafReaderContext
. All docIDs supplied to thisLeafFieldComparator
are relative to the current reader (you must add docBase if you need to map it to a top-level docID).- Specified by:
getLeafComparator
in classFieldComparator<Double>
- Parameters:
context
- current reader context- Returns:
- the comparator to use for this segment
- Throws:
IOException
- if there is a low-level IO error
-
value
Description copied from class:FieldComparator
Return the actual value in the slot.- Specified by:
value
in classFieldComparator<Double>
- Parameters:
slot
- the value- Returns:
- value in this slot
-
compareTop
Description copied from interface:LeafFieldComparator
Compare the top value with this doc. This will only invoked after setTopValue has been called. This should return the same result asFieldComparator.compare(int,int)
} as if topValue were slot1 and the new document were slot 2. This is only called for searches that use searchAfter (deep paging).- Specified by:
compareTop
in interfaceLeafFieldComparator
- Parameters:
doc
- that was hit- Returns:
- any
N < 0
if the doc's value is sorted after the top entry (not competitive), anyN > 0
if the doc's value is sorted before the top entry and0
if they are equal. - Throws:
IOException
-
sortKey
- Throws:
IOException
-