xapian-core  2.0.0
Public Member Functions | Private Attributes | List of all members
OrPosPostList Class Reference

Wrapper postlist providing positions for an OR. More...

#include <orpospostlist.h>

+ Inheritance diagram for OrPosPostList:
+ Collaboration diagram for OrPosPostList:

Public Member Functions

 OrPosPostList (PostList *pl_)
 
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...
 
std::string get_description () const
 Return a string description of this object. More...
 
- Public Member Functions inherited from WrapperPostList
 WrapperPostList (PostList *pl_)
 
 ~WrapperPostList ()
 
Xapian::docid get_docid () const
 Return the current docid. More...
 
double get_weight (Xapian::termcount doclen, Xapian::termcount unique_terms, Xapian::termcount wdfdocmax) const
 Return the weight contribution for the current position. More...
 
bool at_end () const
 Return true if the current position is past the last entry in this list. More...
 
double recalc_maxweight ()
 Recalculate the upper bound on what get_weight() can return. More...
 
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...
 
PostListnext (double w_min)
 Advance the current position to the next document in the postlist. More...
 
PostListskip_to (Xapian::docid, double w_min)
 Skip forward to the specified docid. More...
 
std::string get_description () const
 Return a string description of this object. More...
 
Xapian::termcount get_wdf () const
 Return the wdf for the document at the current position. More...
 
Xapian::termcount count_matching_subqs () const
 Count the number of leaf subqueries which match at the current position. More...
 
- Public Member Functions inherited from Xapian::Internal::PostList
virtual ~PostList ()
 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...
 
Xapian::doccount get_termfreq () const
 Get an estimate of the number of documents this PostList will return. More...
 
virtual 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...
 
virtual PostListcheck (Xapian::docid did, double w_min, bool &valid)
 Check if the specified docid occurs in this postlist. More...
 
PostListnext ()
 Advance the current position to the next document in the postlist. More...
 
PostListskip_to (Xapian::docid did)
 Skip forward to the specified docid. More...
 
virtual void gather_position_lists (OrPositionList *orposlist)
 Gather PositionList* objects for a subtree. More...
 
virtual void get_docid_range (docid &first, docid &last) const
 Get the bounds on the range of docids this PostList can return. More...
 

Private Attributes

OrPositionList position_list
 

Additional Inherited Members

- Protected Member Functions inherited from Xapian::Internal::PostList
 PostList ()
 Only constructable as a base class for derived classes. More...
 
- Protected Attributes inherited from WrapperPostList
PostListpl
 
- Protected Attributes inherited from Xapian::Internal::PostList
Xapian::doccount termfreq
 Estimate of the number of documents this PostList will return. More...
 

Detailed Description

Wrapper postlist providing positions for an OR.

Definition at line 28 of file orpospostlist.h.

Constructor & Destructor Documentation

◆ OrPosPostList()

OrPosPostList::OrPosPostList ( PostList pl_)
inline

Definition at line 32 of file orpospostlist.h.

Member Function Documentation

◆ get_description()

string OrPosPostList::get_description ( ) const
virtual

Return a string description of this object.

Implements Xapian::Internal::PostList.

Definition at line 34 of file orpospostlist.cc.

◆ read_position_list()

PositionList * OrPosPostList::read_position_list ( )
virtual

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

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::Internal::PostList.

Definition at line 28 of file orpospostlist.cc.

Member Data Documentation

◆ position_list

OrPositionList OrPosPostList::position_list
private

Definition at line 29 of file orpospostlist.h.


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