Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::CountingDisjunctionSumScorer Class Reference

#include <BooleanScorer2.h>

+ Inheritance diagram for Lucene::CountingDisjunctionSumScorer:

Public Member Functions

 CountingDisjunctionSumScorer (const BooleanScorer2Ptr &scorer, Collection< ScorerPtr > subScorers, int32_t minimumNrMatchers)
 
virtual ~CountingDisjunctionSumScorer ()
 
virtual String getClassName ()
 
boost::shared_ptr< CountingDisjunctionSumScorershared_from_this ()
 
virtual double score ()
 Returns the score of the current document matching the query. Initially invalid, until next() is called the first time.
 
- Public Member Functions inherited from Lucene::DisjunctionSumScorer
 DisjunctionSumScorer (Collection< ScorerPtr > subScorers, int32_t minimumNrMatchers=1)
 
virtual ~DisjunctionSumScorer ()
 
boost::shared_ptr< DisjunctionSumScorershared_from_this ()
 
virtual void initialize ()
 Called directly after instantiation to create objects that depend on this object being fully constructed.
 
virtual void score (const CollectorPtr &collector)
 Scores and collects all matching documents.
 
virtual int32_t nextDoc ()
 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 docID ()
 Returns the following:
 
int32_t nrMatchers ()
 Returns the number of subscorers matching the current document. Initially invalid, until next() is called the first time.
 
virtual int32_t advance (int32_t target)
 Advances to the first match beyond the current whose document number is greater than or equal to a given target. The implementation uses the skipTo() method on the subscorers.
 
- Public Member Functions inherited from Lucene::Scorer
 Scorer (const SimilarityPtr &similarity)
 Constructs a Scorer.
 
 Scorer (const WeightPtr &weight)
 
virtual ~Scorer ()
 
boost::shared_ptr< Scorershared_from_this ()
 
SimilarityPtr getSimilarity ()
 Returns the Similarity implementation used by this scorer.
 
void visitSubScorers (QueryPtr parent, BooleanClause::Occur relationship, ScorerVisitor *visitor)
 
void visitScorers (ScorerVisitor *visitor)
 
virtual float termFreq ()
 
- Public Member Functions inherited from Lucene::DocIdSetIterator
virtual ~DocIdSetIterator ()
 
boost::shared_ptr< DocIdSetIteratorshared_from_this ()
 
- Public Member Functions inherited from Lucene::LuceneObject
virtual ~LuceneObject ()
 
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.
 
- Public Member Functions inherited from Lucene::LuceneSync
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 ()
 
- Static Public Member Functions inherited from Lucene::DisjunctionSumScorer
static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::Scorer
static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::DocIdSetIterator
static String _getClassName ()
 

Protected Attributes

BooleanScorer2WeakPtr _scorer
 
int32_t lastScoredDoc
 
double lastDocScore
 
- Protected Attributes inherited from Lucene::DisjunctionSumScorer
int32_t nrScorers
 The number of subscorers.
 
Collection< ScorerPtrsubScorers
 The subscorers.
 
int32_t minimumNrMatchers
 The minimum number of scorers that should match.
 
ScorerDocQueuePtr scorerDocQueue
 The scorerDocQueue contains all subscorers ordered by their current doc(), with the minimum at the top. The scorerDocQueue is initialized the first time next() or skipTo() is called. An exhausted scorer is immediately removed from the scorerDocQueue. If less than the minimumNrMatchers scorers remain in the scorerDocQueue next() and skipTo() return false.
 
int32_t currentDoc
 The document number of the current match.
 
int32_t _nrMatchers
 The number of subscorers that provide the current match.
 
double currentScore
 
- Protected Attributes inherited from Lucene::Scorer
SimilarityPtr similarity
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Data Fields inherited from Lucene::Scorer
WeightPtr weight
 
- Static Public Attributes inherited from Lucene::DocIdSetIterator
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.
 
- Protected Member Functions inherited from Lucene::DisjunctionSumScorer
void initScorerDocQueue ()
 Called the first time next() or skipTo() is called to initialize scorerDocQueue.
 
virtual bool score (const CollectorPtr &collector, int32_t max, int32_t firstDocID)
 Collects matching documents in a range. Hook for optimization. Note that next() must be called once before this method is called for the first time.
 
bool advanceAfterCurrent ()
 Advance all subscorers after the current document determined by the top of the scorerDocQueue. Repeat until at least the minimum number of subscorers match on the same document and all subscorers are after that document or are exhausted. On entry the scorerDocQueue has at least minimumNrMatchers available. At least the scorer with the minimum document number will be advanced.
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Constructor & Destructor Documentation

◆ CountingDisjunctionSumScorer()

Lucene::CountingDisjunctionSumScorer::CountingDisjunctionSumScorer ( const BooleanScorer2Ptr scorer,
Collection< ScorerPtr subScorers,
int32_t  minimumNrMatchers 
)

◆ ~CountingDisjunctionSumScorer()

virtual Lucene::CountingDisjunctionSumScorer::~CountingDisjunctionSumScorer ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::CountingDisjunctionSumScorer::_getClassName ( )
inlinestatic

◆ getClassName()

virtual String Lucene::CountingDisjunctionSumScorer::getClassName ( )
inlinevirtual

Reimplemented from Lucene::DisjunctionSumScorer.

◆ score()

virtual double Lucene::CountingDisjunctionSumScorer::score ( )
virtual

Returns the score of the current document matching the query. Initially invalid, until next() is called the first time.

Reimplemented from Lucene::DisjunctionSumScorer.

◆ shared_from_this()

boost::shared_ptr< CountingDisjunctionSumScorer > Lucene::CountingDisjunctionSumScorer::shared_from_this ( )
inline

Field Documentation

◆ _scorer

BooleanScorer2WeakPtr Lucene::CountingDisjunctionSumScorer::_scorer
protected

◆ lastDocScore

double Lucene::CountingDisjunctionSumScorer::lastDocScore
protected

◆ lastScoredDoc

int32_t Lucene::CountingDisjunctionSumScorer::lastScoredDoc
protected

The documentation for this class was generated from the following file:

clucene.sourceforge.net