xapian-core  1.4.21
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
MultiPostList Class Reference

#include <multi_postlist.h>

+ Inheritance diagram for MultiPostList:
+ Collaboration diagram for MultiPostList:

Public Member Functions

 ~MultiPostList ()
 
Xapian::doccount get_termfreq_min () const
 Get a lower bound on the number of documents indexed by this term. More...
 
Xapian::doccount get_termfreq_max () const
 Get an upper bound on the number of documents indexed by this term. More...
 
Xapian::doccount get_termfreq_est () const
 Get an estimate of the number of documents indexed by this term. More...
 
double get_maxweight () const
 Return an upper bound on what get_weight() can return. More...
 
double get_weight () const
 Return the weight contribution for the current position. More...
 
double recalc_maxweight ()
 Recalculate the upper bound on what get_weight() can return. More...
 
Xapian::docid get_docid () const
 Return the current docid. More...
 
Xapian::termcount get_doclength () const
 Return the length of current document. More...
 
Xapian::termcount get_unique_terms () const
 Return the number of unique terms in the current document. More...
 
Xapian::termcount get_wdf () const
 Return the wdf for the document at the current position. More...
 
PositionListopen_position_list () const
 Read the position list for the term in the current document and return a pointer to it (not owned by the PostList). More...
 
PostListnext (double w_min)
 Advance the current position to the next document in the postlist. More...
 
PostListskip_to (Xapian::docid did, double w_min)
 Skip forward to the specified docid. More...
 
bool at_end () const
 Return true if the current position is past the last entry in this list. More...
 
std::string get_description () const
 Return a string description of this object. More...
 
- Public Member Functions inherited from Xapian::PostingIterator::Internal
virtual ~Internal ()
 We have virtual methods and want to be able to delete derived classes using a pointer to the base class, so we need a virtual destructor. More...
 
virtual TermFreqs get_termfreq_est_using_stats (const Xapian::Weight::Internal &stats) const
 Get an estimate for the termfreq and reltermfreq, given the stats. More...
 
virtual const std::string * get_sort_key () const
 
virtual const std::string * get_collapse_key () const
 If the collapse key is already known, return it. More...
 
virtual PositionListread_position_list ()
 Read the position list for the term in the current document and return a pointer to it (owned by the PostList). More...
 
virtual Internalcheck (Xapian::docid did, double w_min, bool &valid)
 Check if the specified docid occurs in this postlist. More...
 
Internalnext ()
 Advance the current position to the next document in the postlist. More...
 
Internalskip_to (Xapian::docid did)
 Skip forward to the specified docid. More...
 
virtual Xapian::termcount count_matching_subqs () const
 Count the number of leaf subqueries which match at the current position. More...
 
virtual void gather_position_lists (OrPositionList *orposlist)
 Gather PositionList* objects for a subtree. More...
 
- Public Member Functions inherited from Xapian::Internal::intrusive_base
 intrusive_base ()
 Construct with no references. More...
 

Private Member Functions

 MultiPostList (std::vector< LeafPostList *> &pls, const Xapian::Database &this_db_)
 

Private Attributes

std::vector< LeafPostList * > postlists
 
Xapian::Database this_db
 
bool finished
 
Xapian::docid currdoc
 
Xapian::doccount multiplier
 

Friends

class Xapian::Database
 

Additional Inherited Members

- Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Member Functions inherited from Xapian::PostingIterator::Internal
 Internal ()
 Only constructable as a base class for derived classes. More...
 

Detailed Description

Definition at line 29 of file multi_postlist.h.

Constructor & Destructor Documentation

◆ MultiPostList()

MultiPostList::MultiPostList ( std::vector< LeafPostList *> &  pls,
const Xapian::Database this_db_ 
)
private

Definition at line 34 of file multi_postlist.cc.

References multiplier.

◆ ~MultiPostList()

MultiPostList::~MultiPostList ( )

Definition at line 45 of file multi_postlist.cc.

References postlists.

Member Function Documentation

◆ at_end()

bool MultiPostList::at_end ( ) const
virtual

Return true if the current position is past the last entry in this list.

Implements Xapian::PostingIterator::Internal.

Definition at line 206 of file multi_postlist.cc.

References finished.

Referenced by get_docid(), get_doclength(), get_unique_terms(), next(), and skip_to().

◆ get_description()

std::string MultiPostList::get_description ( ) const
virtual

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Definition at line 212 of file multi_postlist.cc.

References postlists.

◆ get_docid()

Xapian::docid MultiPostList::get_docid ( ) const
virtual

Return the current docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 95 of file multi_postlist.cc.

References Assert, at_end(), currdoc, LOGCALL, and RETURN.

Referenced by get_doclength(), and get_unique_terms().

◆ get_doclength()

Xapian::termcount MultiPostList::get_doclength ( ) const
virtual

Return the length of current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 104 of file multi_postlist.cc.

References Assert, AssertEqParanoid, at_end(), currdoc, get_docid(), Xapian::Database::get_doclength(), LOGCALL, multiplier, postlists, RETURN, and this_db.

◆ get_maxweight()

double MultiPostList::get_maxweight ( ) const
virtual

Return an upper bound on what get_weight() can return.

Implements Xapian::PostingIterator::Internal.

Definition at line 75 of file multi_postlist.cc.

References get_weight().

◆ get_termfreq_est()

Xapian::doccount MultiPostList::get_termfreq_est ( ) const
virtual

Get an estimate of the number of documents indexed by this term.

It should always be true that: get_termfreq_min() <= get_termfreq_est() <= get_termfreq_max()

Implements Xapian::PostingIterator::Internal.

Definition at line 69 of file multi_postlist.cc.

References get_termfreq_min().

◆ get_termfreq_max()

Xapian::doccount MultiPostList::get_termfreq_max ( ) const
virtual

Get an upper bound on the number of documents indexed by this term.

Implements Xapian::PostingIterator::Internal.

Definition at line 63 of file multi_postlist.cc.

References get_termfreq_min().

◆ get_termfreq_min()

Xapian::doccount MultiPostList::get_termfreq_min ( ) const
virtual

Get a lower bound on the number of documents indexed by this term.

Implements Xapian::PostingIterator::Internal.

Definition at line 55 of file multi_postlist.cc.

References Assert.

Referenced by get_termfreq_est(), and get_termfreq_max().

◆ get_unique_terms()

Xapian::termcount MultiPostList::get_unique_terms ( ) const
virtual

Return the number of unique terms in the current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 115 of file multi_postlist.cc.

References Assert, AssertEqParanoid, at_end(), currdoc, get_docid(), Xapian::Database::get_unique_terms(), LOGCALL, multiplier, postlists, RETURN, and this_db.

◆ get_wdf()

Xapian::termcount MultiPostList::get_wdf ( ) const
virtual

Return the wdf for the document at the current position.

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 126 of file multi_postlist.cc.

References currdoc, multiplier, and postlists.

◆ get_weight()

double MultiPostList::get_weight ( ) const
virtual

Return the weight contribution for the current position.

Implements Xapian::PostingIterator::Internal.

Definition at line 81 of file multi_postlist.cc.

References Assert.

Referenced by get_maxweight(), and recalc_maxweight().

◆ next()

PostList * MultiPostList::next ( double  w_min)
virtual

Advance the current position to the next document in the postlist.

The list starts before the first entry in the list, so next(), skip_to() or check() must be called before any methods which need the context of the current position.

Parameters
w_minThe minimum weight contribution that is needed (this is just a hint which PostList subclasses may ignore).
Returns
If a non-NULL pointer is returned, then the caller should substitute the returned pointer for its pointer to us, and then delete us. This "pruning" can only happen for a non-leaf subclass of this class.

Implements Xapian::PostingIterator::Internal.

Definition at line 138 of file multi_postlist.cc.

References Assert, at_end(), currdoc, finished, LOGCALL, LOGLINE, multiplier, postlists, and RETURN.

◆ open_position_list()

PositionList * MultiPostList::open_position_list ( ) const
virtual

Read the position list for the term in the current document and return a pointer to it (not owned by the PostList).

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 132 of file multi_postlist.cc.

References currdoc, multiplier, and postlists.

◆ recalc_maxweight()

double MultiPostList::recalc_maxweight ( )
virtual

Recalculate the upper bound on what get_weight() can return.

If the tree has pruned, get_maxweight() may use cached values. Calling this method instead forces a full recalculation.

Note that this method may be called after the postlist has reached the end. In this situation, the method should return 0.

Implements Xapian::PostingIterator::Internal.

Definition at line 89 of file multi_postlist.cc.

References get_weight().

◆ skip_to()

PostList * MultiPostList::skip_to ( Xapian::docid  did,
double  w_min 
)
virtual

Skip forward to the specified docid.

If the specified docid isn't in the list, position ourselves on the first document after it (or at_end() if no greater docids are present).

Parameters
w_minThe minimum weight contribution that is needed (this is just a hint which PostList subclasses may ignore).
Returns
If a non-NULL pointer is returned, then the caller should substitute the returned pointer for its pointer to us, and then delete us. This "pruning" can only happen for a non-leaf subclass of this class.

Implements Xapian::PostingIterator::Internal.

Definition at line 175 of file multi_postlist.cc.

References Assert, at_end(), currdoc, finished, LOGCALL, multiplier, postlists, and RETURN.

Friends And Related Function Documentation

◆ Xapian::Database

friend class Xapian::Database
friend

Definition at line 30 of file multi_postlist.h.

Member Data Documentation

◆ currdoc

Xapian::docid MultiPostList::currdoc
private

◆ finished

bool MultiPostList::finished
private

Definition at line 36 of file multi_postlist.h.

Referenced by at_end(), next(), and skip_to().

◆ multiplier

Xapian::doccount MultiPostList::multiplier
private

◆ postlists

std::vector<LeafPostList *> MultiPostList::postlists
private

◆ this_db

Xapian::Database MultiPostList::this_db
private

Definition at line 34 of file multi_postlist.h.

Referenced by get_doclength(), and get_unique_terms().


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