xapian-core  1.4.19
Public Member Functions | Private Member Functions | List of all members
ValueGePostList Class Reference

#include <valuegepostlist.h>

+ Inheritance diagram for ValueGePostList:
+ Collaboration diagram for ValueGePostList:

Public Member Functions

 ValueGePostList (const Xapian::Database::Internal *db_, Xapian::valueno slot_, const std::string &begin_)
 
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...
 
PostListcheck (Xapian::docid did, double w_min, bool &valid)
 Check if the specified docid occurs in this postlist. More...
 
std::string get_description () const
 Return a string description of this object. More...
 
- Public Member Functions inherited from ValueRangePostList
 ValueRangePostList (const Xapian::Database::Internal *db_, Xapian::valueno slot_, const std::string &begin_, const std::string &end_)
 
 ~ValueRangePostList ()
 
Xapian::doccount get_termfreq_min () const
 Get a lower 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...
 
Xapian::doccount get_termfreq_max () const
 Get an upper bound on the number of documents indexed by this term. More...
 
TermFreqs get_termfreq_est_using_stats (const Xapian::Weight::Internal &stats) const
 Get an estimate for the termfreq and reltermfreq, given the stats. More...
 
double get_maxweight () const
 Return an upper bound on what get_weight() can return. More...
 
Xapian::docid get_docid () const
 Return the current docid. More...
 
double get_weight () const
 Return the weight contribution for the current position. 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...
 
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...
 
PostListcheck (Xapian::docid did, double w_min, bool &valid)
 Check if the specified docid occurs in this postlist. More...
 
bool at_end () const
 Return true if the current position is past the last entry in this list. More...
 
Xapian::termcount count_matching_subqs () const
 Count the number of leaf subqueries which match at the current position. 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 Xapian::termcount get_wdf () const
 Return the wdf for the document at the current position. 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 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...
 
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 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

 ValueGePostList (const ValueGePostList &)
 Disallow copying. More...
 
void operator= (const ValueGePostList &)
 Disallow assignment. More...
 

Additional Inherited Members

- Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Member Functions inherited from ValueRangePostList
 ValueRangePostList (const ValueRangePostList &)
 Disallow copying. More...
 
void operator= (const ValueRangePostList &)
 Disallow assignment. More...
 
- Protected Member Functions inherited from Xapian::PostingIterator::Internal
 Internal ()
 Only constructable as a base class for derived classes. More...
 
- Protected Attributes inherited from ValueRangePostList
const Xapian::Database::Internaldb
 
Xapian::valueno slot
 
const std::string begin
 
const std::string end
 
Xapian::doccount db_size
 
ValueListvaluelist
 

Detailed Description

Definition at line 27 of file valuegepostlist.h.

Constructor & Destructor Documentation

◆ ValueGePostList() [1/2]

ValueGePostList::ValueGePostList ( const ValueGePostList )
private

Disallow copying.

◆ ValueGePostList() [2/2]

ValueGePostList::ValueGePostList ( const Xapian::Database::Internal db_,
Xapian::valueno  slot_,
const std::string &  begin_ 
)
inline

Member Function Documentation

◆ check()

PostList * ValueGePostList::check ( Xapian::docid  did,
double  w_min,
bool &  valid 
)
virtual

Check if the specified docid occurs in this postlist.

The caller is required to ensure that the specified docid actually exists in the database.

This method acts like skip_to() if that can be done at little extra cost, in which case it then sets valid to true.

Otherwise it simply checks if a particular docid is present. If it is, valid is set to true. If it isn't, it sets valid to false, and leaves the position unspecified (and hence the result of calling methods which depend on the current position, such as get_docid() and at_end(), are also unspecified). In this state, next() will advance to the first matching position after docid, and skip_to() will act as it would if the position was the first matching position after docid. If valid is set to false, then NULL must be returned (pruning in this situation doesn't make sense).

The default implementation calls skip_to().

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 64 of file valuegepostlist.cc.

References Assert, and AssertRelParanoid.

Referenced by ValueGePostList().

◆ get_description()

string ValueGePostList::get_description ( ) const
virtual

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Definition at line 79 of file valuegepostlist.cc.

References description_append(), and Xapian::Internal::str().

Referenced by ValueGePostList().

◆ next()

PostList * ValueGePostList::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 34 of file valuegepostlist.cc.

References Assert.

◆ operator=()

void ValueGePostList::operator= ( const ValueGePostList )
private

Disallow assignment.

◆ skip_to()

PostList * ValueGePostList::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 49 of file valuegepostlist.cc.

References Assert.

Referenced by ValueGePostList().


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