Module org.apache.lucene.core

Package org.apache.lucene.search

Class MaxScoreBulkScorer

java.lang.Object

org.apache.lucene.search.BulkScorer

org.apache.lucene.search.MaxScoreBulkScorer

final class MaxScoreBulkScorer
extends BulkScorer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	MaxScoreBulkScorer.ScoreAndDoc

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final DisiWrapper[]	allScorers
private final long	cost
private final DisiPriorityQueue	essentialQueue
(package private) int	firstEssentialScorer
(package private) int	firstRequiredScorer
(package private) static final int	INNER_WINDOW_SIZE
private final int	maxDoc
(package private) final double[]	maxScoreSums
(package private) float	minCompetitiveScore
private MaxScoreBulkScorer.ScoreAndDoc	scorable
private final DisiWrapper[]	scratch
private final long[]	windowMatches
private final double[]	windowScores

Constructor Summary

Constructors

Constructor	Description
MaxScoreBulkScorer(int maxDoc, List<Scorer> scorers)

Method Summary

Modifier and Type	Method	Description
private int	computeOuterWindowMax(int windowMin)
long	cost()	Same as DocIdSetIterator.cost() for bulk scorers.
private int	nextCandidate(int rangeEnd)	Return the next candidate on or after rangeEnd.
(package private) boolean	partitionScorers()
int	score(LeafCollector collector, Bits acceptDocs, int min, int max)	Collects matching documents in a range and return an estimation of the next matching document which is on or after max.
private void	scoreInnerWindow(LeafCollector collector, Bits acceptDocs, int max)
private void	scoreInnerWindowAsConjunction(LeafCollector collector, Bits acceptDocs, int max)
private void	scoreInnerWindowMultipleEssentialClauses(LeafCollector collector, Bits acceptDocs, int max)
private void	scoreInnerWindowSingleEssentialClause(LeafCollector collector, Bits acceptDocs, int upTo)
private void	scoreNonEssentialClauses(LeafCollector collector, int doc, double essentialScore, int numNonEssentialClauses)
(package private) void	updateMaxWindowScores(int windowMin, int windowMax)

Methods inherited from class org.apache.lucene.search.BulkScorer

score

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INNER_WINDOW_SIZE

static final int INNER_WINDOW_SIZE

See Also:

• Constant Field Values

maxDoc

private final int maxDoc

allScorers

final DisiWrapper[] allScorers

scratch

private final DisiWrapper[] scratch

essentialQueue

private final DisiPriorityQueue essentialQueue

firstEssentialScorer

int firstEssentialScorer

firstRequiredScorer

int firstRequiredScorer

cost

private final long cost

minCompetitiveScore

float minCompetitiveScore

scorable

private MaxScoreBulkScorer.ScoreAndDoc scorable

maxScoreSums

final double[] maxScoreSums

windowMatches

private final long[] windowMatches

windowScores

private final double[] windowScores

Constructor Details

MaxScoreBulkScorer

MaxScoreBulkScorer(int maxDoc,
 List<Scorer> scorers)
            throws IOException

Throws:

IOException

Method Details

score

public int score(LeafCollector collector,
 Bits acceptDocs,
 int min,
 int max)
          throws IOException

Description copied from class: BulkScorer

Collects matching documents in a range and return an estimation of the next matching document which is on or after max.

The return value must be:

• >= max,
• DocIdSetIterator.NO_MORE_DOCS if there are no more matches,
• <= the first matching document that is >= max otherwise.

min is the minimum document to be considered for matching. All documents strictly before this value must be ignored.

Although max would be a legal return value for this method, higher values might help callers skip more efficiently over non-matching portions of the docID space.

For instance, a Scorer-based implementation could look like below:

 private final Scorer scorer; // set via constructor

 public int score(LeafCollector collector, Bits acceptDocs, int min, int max) throws IOException {
   collector.setScorer(scorer);
   int doc = scorer.docID();
   if (doc < min) {
     doc = scorer.advance(min);
   }
   while (doc < max) {
     if (acceptDocs == null || acceptDocs.get(doc)) {
       collector.collect(doc);
     }
     doc = scorer.nextDoc();
   }
   return doc;
 }
 

Specified by:

score in class BulkScorer

Parameters:

collector - The collector to which all matching documents are passed.

acceptDocs - Bits that represents the allowed documents to match, or null if they are all allowed to match.

min - Score starting at, including, this document

max - Score up to, but not including, this doc

Returns:

an under-estimation of the next matching doc after max

Throws:

IOException

scoreInnerWindow

private void scoreInnerWindow(LeafCollector collector,
 Bits acceptDocs,
 int max)
                       throws IOException

Throws:

IOException

scoreInnerWindowSingleEssentialClause

private void scoreInnerWindowSingleEssentialClause(LeafCollector collector,
 Bits acceptDocs,
 int upTo)
                                            throws IOException

Throws:

IOException

scoreInnerWindowAsConjunction

private void scoreInnerWindowAsConjunction(LeafCollector collector,
 Bits acceptDocs,
 int max)
                                    throws IOException

Throws:

IOException

scoreInnerWindowMultipleEssentialClauses

private void scoreInnerWindowMultipleEssentialClauses(LeafCollector collector,
 Bits acceptDocs,
 int max)
                                               throws IOException

Throws:

IOException

computeOuterWindowMax

private int computeOuterWindowMax(int windowMin)
                           throws IOException

Throws:

IOException

updateMaxWindowScores

void updateMaxWindowScores(int windowMin,
 int windowMax)
                    throws IOException

Throws:

IOException

scoreNonEssentialClauses

private void scoreNonEssentialClauses(LeafCollector collector,
 int doc,
 double essentialScore,
 int numNonEssentialClauses)
                               throws IOException

Throws:

IOException

partitionScorers

boolean partitionScorers()

nextCandidate

private int nextCandidate(int rangeEnd)

Return the next candidate on or after rangeEnd.

cost

public long cost()

Description copied from class: BulkScorer

Same as DocIdSetIterator.cost() for bulk scorers.

Specified by:

cost in class BulkScorer