Lucene++ - a full-featured, c++ search engine
API Documentation
Common scoring functionality for different types of queries. More...
#include <Scorer.h>
Public Member Functions | |
Scorer (const SimilarityPtr &similarity) | |
Constructs a Scorer. | |
virtual | ~Scorer () |
virtual String | getClassName () |
boost::shared_ptr< Scorer > | shared_from_this () |
SimilarityPtr | getSimilarity () |
Returns the Similarity implementation used by this scorer. | |
virtual void | score (const CollectorPtr &collector) |
Scores and collects all matching documents. | |
virtual double | score ()=0 |
Returns the score of the current document matching the query. Initially invalid, until nextDoc() or advance(int32_t) is called the first time, or when called from within Collector#collect. | |
![]() | |
virtual | ~DocIdSetIterator () |
virtual int32_t | docID ()=0 |
Returns the following: | |
virtual int32_t | nextDoc ()=0 |
Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set. | |
virtual int32_t | advance (int32_t target)=0 |
Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set. | |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
virtual String | toString () |
Returns a string representation of the object. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. |
Static Public Member Functions | |
static String | _getClassName () |
Protected Member Functions | |
virtual bool | score (const CollectorPtr &collector, int32_t max, int32_t firstDocID) |
Collects matching documents in a range. Hook for optimization. Note, firstDocID is added to ensure that nextDoc() was called before this method. |
Protected Attributes | |
SimilarityPtr | similarity |
Additional Inherited Members | |
![]() | |
static const int32_t | NO_MORE_DOCS |
When returned by nextDoc(), advance(int) and docID() it means there are no more docs in the iterator. |
Common scoring functionality for different types of queries.
A Scorer iterates over documents matching a query in increasing order of doc Id.
Document scores are computed using a given Similarity implementation.
NOTE: The values NEGATIVE_INFINITY and POSITIVE_INFINITY are not valid scores. Certain collectors (eg TopScoreDocCollector) will not properly collect hits with these scores.
Lucene::Scorer::Scorer | ( | const SimilarityPtr & | similarity | ) |
Constructs a Scorer.
similarity | The Similarity implementation used by this scorer. |
|
virtual |
|
inlinestatic |
Reimplemented from Lucene::DocIdSetIterator.
Reimplemented in Lucene::CountingConjunctionSumScorer, Lucene::CountingDisjunctionSumScorer, Lucene::SingleMatchScorer, Lucene::BucketScorer, Lucene::PayloadNearSpanScorer, Lucene::BooleanScorer2, Lucene::BooleanScorer, Lucene::ScoreCachingWrappingScorer, Lucene::PhraseScorer, Lucene::TermScorer, Lucene::ReqExclScorer, Lucene::DisjunctionMaxScorer, Lucene::DisjunctionSumScorer, Lucene::ReqOptSumScorer, Lucene::ConjunctionScorer, Lucene::SpanScorer, Lucene::ExactPhraseScorer, and Lucene::SloppyPhraseScorer.
|
inlinevirtual |
Reimplemented from Lucene::DocIdSetIterator.
Reimplemented in Lucene::CountingConjunctionSumScorer, Lucene::CountingDisjunctionSumScorer, Lucene::SingleMatchScorer, Lucene::BucketScorer, Lucene::PayloadNearSpanScorer, Lucene::BooleanScorer2, Lucene::BooleanScorer, Lucene::ScoreCachingWrappingScorer, Lucene::PhraseScorer, Lucene::TermScorer, Lucene::ReqExclScorer, Lucene::DisjunctionMaxScorer, Lucene::DisjunctionSumScorer, Lucene::ReqOptSumScorer, Lucene::ConjunctionScorer, Lucene::SpanScorer, Lucene::ExactPhraseScorer, and Lucene::SloppyPhraseScorer.
SimilarityPtr Lucene::Scorer::getSimilarity | ( | ) |
Returns the Similarity implementation used by this scorer.
Reimplemented in Lucene::ScoreCachingWrappingScorer.
|
virtual |
Scores and collects all matching documents.
collector | The collector to which all matching documents are passed. |
Reimplemented in Lucene::BooleanScorer, Lucene::BooleanScorer2, Lucene::DisjunctionSumScorer, Lucene::TermScorer, and Lucene::ScoreCachingWrappingScorer.
|
pure virtual |
Returns the score of the current document matching the query. Initially invalid, until nextDoc() or advance(int32_t) is called the first time, or when called from within Collector#collect.
Implemented in Lucene::CountingConjunctionSumScorer, Lucene::CountingDisjunctionSumScorer, Lucene::SingleMatchScorer, Lucene::BucketScorer, Lucene::PayloadNearSpanScorer, Lucene::BooleanScorer2, Lucene::BooleanScorer, Lucene::DisjunctionSumScorer, Lucene::TermScorer, Lucene::PhraseScorer, Lucene::DisjunctionMaxScorer, Lucene::ReqExclScorer, Lucene::ScoreCachingWrappingScorer, Lucene::ReqOptSumScorer, Lucene::SpanScorer, and Lucene::ConjunctionScorer.
|
protectedvirtual |
Collects matching documents in a range. Hook for optimization. Note, firstDocID is added to ensure that nextDoc() was called before this method.
collector | The collector to which all matching documents are passed. |
max | Do not score documents past this. |
firstDocID | The first document ID (ensures nextDoc() is called before this method. |
Reimplemented in Lucene::DisjunctionSumScorer, Lucene::TermScorer, Lucene::BooleanScorer2, Lucene::BooleanScorer, and Lucene::ScoreCachingWrappingScorer.
|
inline |
Reimplemented from Lucene::DocIdSetIterator.
Reimplemented in Lucene::CountingConjunctionSumScorer, Lucene::CountingDisjunctionSumScorer, Lucene::SingleMatchScorer, Lucene::BucketScorer, Lucene::PayloadNearSpanScorer, Lucene::BooleanScorer2, Lucene::BooleanScorer, Lucene::ScoreCachingWrappingScorer, Lucene::PhraseScorer, Lucene::TermScorer, Lucene::ReqExclScorer, Lucene::DisjunctionMaxScorer, Lucene::DisjunctionSumScorer, Lucene::ReqOptSumScorer, Lucene::ConjunctionScorer, Lucene::SpanScorer, Lucene::ExactPhraseScorer, and Lucene::SloppyPhraseScorer.
|
protected |