xapian-core
1.4.26
|
#include <externalpostlist.h>
Public Member Functions | |
ExternalPostList (const Xapian::Database &db, Xapian::PostingSource *source_, double factor_, MultiMatch *matcher, Xapian::doccount shard_index) | |
Constructor. More... | |
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... | |
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... | |
PositionList * | read_position_list () |
Read the position list for the term in the current document and return a pointer to it (owned by the PostList). More... | |
PostList * | next (double w_min) |
Advance the current position to the next document in the postlist. More... | |
PostList * | skip_to (Xapian::docid, double w_min) |
Skip forward to the specified docid. More... | |
PostList * | check (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 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 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 PositionList * | open_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... | |
Internal * | next () |
Advance the current position to the next document in the postlist. More... | |
Internal * | skip_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 | |
ExternalPostList (const ExternalPostList &) | |
Disallow copying. More... | |
void | operator= (const ExternalPostList &) |
Disallow assignment. More... | |
PostList * | update_after_advance () |
Private Attributes | |
Xapian::Internal::opt_intrusive_ptr< Xapian::PostingSource > | source |
Xapian::docid | current |
double | factor |
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... | |
Definition at line 33 of file externalpostlist.h.
|
private |
Disallow copying.
ExternalPostList::ExternalPostList | ( | const Xapian::Database & | db, |
Xapian::PostingSource * | source_, | ||
double | factor_, | ||
MultiMatch * | matcher, | ||
Xapian::doccount | shard_index | ||
) |
Constructor.
matcher | The matcher to notify when maximum weight changes. |
Definition at line 34 of file externalpostlist.cc.
References Assert, Xapian::PostingSource::clone(), Xapian::PostingSource::init(), Xapian::PostingSource::register_matcher_(), Xapian::PostingSource::release(), and source.
|
virtual |
Return true if the current position is past the last entry in this list.
Implements Xapian::PostingIterator::Internal.
Definition at line 184 of file externalpostlist.cc.
References Xapian::Internal::opt_intrusive_ptr< T >::get(), LOGCALL, RETURN, and source.
|
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 165 of file externalpostlist.cc.
References Assert, Xapian::PostingSource::at_end(), Xapian::PostingSource::check(), current, Xapian::Internal::opt_intrusive_ptr< T >::get(), Xapian::PostingSource::get_docid(), LOGCALL, LOGLINE, RETURN, and source.
|
virtual |
Count the number of leaf subqueries which match at the current position.
Reimplemented from Xapian::PostingIterator::Internal.
Definition at line 191 of file externalpostlist.cc.
|
virtual |
Return a string description of this object.
Implements Xapian::PostingIterator::Internal.
Definition at line 197 of file externalpostlist.cc.
References Xapian::Internal::opt_intrusive_ptr< T >::get(), Xapian::PostingSource::get_description(), and source.
|
virtual |
Return the current docid.
Implements Xapian::PostingIterator::Internal.
Definition at line 90 of file externalpostlist.cc.
|
virtual |
Return the length of current document.
Implements Xapian::PostingIterator::Internal.
Definition at line 107 of file externalpostlist.cc.
References Assert.
|
virtual |
Return an upper bound on what get_weight() can return.
Implements Xapian::PostingIterator::Internal.
Definition at line 80 of file externalpostlist.cc.
References factor, Xapian::Internal::opt_intrusive_ptr< T >::get(), Xapian::PostingSource::get_maxweight(), LOGCALL, RETURN, and source.
Referenced by recalc_maxweight().
|
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 66 of file externalpostlist.cc.
References Assert, Xapian::Internal::opt_intrusive_ptr< T >::get(), Xapian::PostingSource::get_termfreq_est(), and source.
|
virtual |
Get an upper bound on the number of documents indexed by this term.
Implements Xapian::PostingIterator::Internal.
Definition at line 73 of file externalpostlist.cc.
References Assert, Xapian::Internal::opt_intrusive_ptr< T >::get(), Xapian::PostingSource::get_termfreq_max(), and source.
|
virtual |
Get a lower bound on the number of documents indexed by this term.
Implements Xapian::PostingIterator::Internal.
Definition at line 59 of file externalpostlist.cc.
References Assert, Xapian::Internal::opt_intrusive_ptr< T >::get(), Xapian::PostingSource::get_termfreq_min(), and source.
|
virtual |
Return the number of unique terms in the current document.
Implements Xapian::PostingIterator::Internal.
Definition at line 114 of file externalpostlist.cc.
References Assert.
|
virtual |
Return the weight contribution for the current position.
Implements Xapian::PostingIterator::Internal.
Definition at line 98 of file externalpostlist.cc.
References Assert, factor, Xapian::Internal::opt_intrusive_ptr< T >::get(), Xapian::PostingSource::get_weight(), LOGCALL, RETURN, and source.
|
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.
w_min | The minimum weight contribution that is needed (this is just a hint which PostList subclasses may ignore). |
Implements Xapian::PostingIterator::Internal.
Definition at line 146 of file externalpostlist.cc.
References Assert, Xapian::Internal::opt_intrusive_ptr< T >::get(), LOGCALL, Xapian::PostingSource::next(), RETURN, source, and update_after_advance().
|
private |
Disallow assignment.
|
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::PostingIterator::Internal.
Definition at line 127 of file externalpostlist.cc.
|
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 121 of file externalpostlist.cc.
References get_maxweight().
|
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).
w_min | The minimum weight contribution that is needed (this is just a hint which PostList subclasses may ignore). |
Implements Xapian::PostingIterator::Internal.
Definition at line 155 of file externalpostlist.cc.
References Assert, current, Xapian::Internal::opt_intrusive_ptr< T >::get(), LOGCALL, RETURN, Xapian::PostingSource::skip_to(), source, and update_after_advance().
|
private |
Definition at line 133 of file externalpostlist.cc.
References Assert, Xapian::PostingSource::at_end(), current, Xapian::Internal::opt_intrusive_ptr< T >::get(), Xapian::PostingSource::get_docid(), LOGCALL, LOGLINE, RETURN, and source.
|
private |
Definition at line 42 of file externalpostlist.h.
Referenced by check(), get_docid(), skip_to(), and update_after_advance().
|
private |
Definition at line 44 of file externalpostlist.h.
Referenced by get_maxweight(), and get_weight().
|
private |
Definition at line 40 of file externalpostlist.h.
Referenced by at_end(), check(), ExternalPostList(), get_description(), get_maxweight(), get_termfreq_est(), get_termfreq_max(), get_termfreq_min(), get_weight(), next(), skip_to(), and update_after_advance().