ValueRangePostList Class Reference

#include <valuerangepostlist.h>

Inheritance diagram for ValueRangePostList:

Collaboration diagram for ValueRangePostList:

List of all members.

Public Member Functions

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.

Xapian::doccount get_termfreq_est () const

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

Xapian::doccount get_termfreq_max () const

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

TermFreqs get_termfreq_est_using_stats (const Xapian::Weight::Internal &stats) const

Get an estimate for the termfreq and reltermfreq, given the stats.

Xapian::weight get_maxweight () const

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

Xapian::docid get_docid () const

Return the current docid.

Xapian::weight get_weight () const

Return the weight contribution for the current position.

Xapian::termcount get_doclength () const

Return the length of current document.

Xapian::weight recalc_maxweight ()

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

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).

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).

PostList * next (Xapian::weight w_min)

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

PostList * skip_to (Xapian::docid, Xapian::weight w_min)

Skip forward to the specified docid.

PostList * check (Xapian::docid did, Xapian::weight w_min, bool &valid)

Check if the specified docid occurs in this postlist.

bool at_end () const

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

Xapian::termcount count_matching_subqs () const

Count the number of leaf subqueries which match at the current position.

string get_description () const

Return a string description of this object.

Protected Member Functions

ValueRangePostList (const ValueRangePostList &)

Disallow copying.

void operator= (const ValueRangePostList &)

Disallow assignment.

Protected Attributes

const Xapian::Database::Internal * db

Xapian::valueno slot

const std::string begin

const std::string end

Xapian::doccount db_size

ValueList * valuelist

Detailed Description

Definition at line 30 of file valuerangepostlist.h.

Constructor & Destructor Documentation

ValueRangePostList::ValueRangePostList ( const ValueRangePostList & ) [protected]

Disallow copying.

ValueRangePostList::ValueRangePostList	(	const Xapian::Database::Internal *	db_,
		Xapian::valueno	slot_,
		const std::string &	begin_,
		const std::string &	end_
	)			`[inline]`

Definition at line 49 of file valuerangepostlist.h.

ValueRangePostList::~ValueRangePostList ( )

Definition at line 33 of file valuerangepostlist.cc.

References valuelist.

Member Function Documentation

bool ValueRangePostList::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 169 of file valuerangepostlist.cc.

References db.

PostList * ValueRangePostList::check	(	Xapian::docid	did,
		Xapian::weight	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 depends on the current position, such as get_docid(), 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.

The default implementation calls skip_to().

Reimplemented from Xapian::PostingIterator::Internal.

Reimplemented in ValueGePostList.

Definition at line 154 of file valuerangepostlist.cc.

References Assert, AssertRelParanoid, begin, Xapian::ValueIterator::Internal::check(), db, end, Xapian::Database::Internal::get_lastdocid(), Xapian::ValueIterator::Internal::get_value(), Xapian::Database::Internal::open_value_list(), slot, and valuelist.

Xapian::termcount ValueRangePostList::count_matching_subqs ( ) const [virtual]

Count the number of leaf subqueries which match at the current position.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 175 of file valuerangepostlist.cc.

string ValueRangePostList::get_description ( ) const [virtual]

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Reimplemented in ValueGePostList.

Definition at line 181 of file valuerangepostlist.cc.

References begin, end, slot, and Xapian::Internal::str().

Xapian::docid ValueRangePostList::get_docid ( ) const [virtual]

Return the current docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 77 of file valuerangepostlist.cc.

References Assert, db, Xapian::ValueIterator::Internal::get_docid(), and valuelist.

Xapian::termcount ValueRangePostList::get_doclength ( ) const [virtual]

Return the length of current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 92 of file valuerangepostlist.cc.

References Assert, and db.

Xapian::weight ValueRangePostList::get_maxweight ( ) const [virtual]

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

Implements Xapian::PostingIterator::Internal.

Definition at line 71 of file valuerangepostlist.cc.

Xapian::doccount ValueRangePostList::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 45 of file valuerangepostlist.cc.

References AssertParanoid, db, db_size, and Xapian::Database::Internal::get_doccount().

TermFreqs ValueRangePostList::get_termfreq_est_using_stats ( const Xapian::Weight::Internal & stats ) const [virtual]

Get an estimate for the termfreq and reltermfreq, given the stats.

The frequencies may be for a combination of databases, or for just the relevant documents, so the results need not lie in the bounds given by get_termfreq_min() and get_termfreq_max().

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 54 of file valuerangepostlist.cc.

References Xapian::Weight::Internal::collection_size, LOGCALL, RETURN, and Xapian::Weight::Internal::rset_size.

Xapian::doccount ValueRangePostList::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 64 of file valuerangepostlist.cc.

References AssertParanoid, db, db_size, and Xapian::Database::Internal::get_doccount().

Xapian::doccount ValueRangePostList::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 39 of file valuerangepostlist.cc.

Xapian::weight ValueRangePostList::get_weight ( ) const [virtual]

Return the weight contribution for the current position.

Implements Xapian::PostingIterator::Internal.

Definition at line 85 of file valuerangepostlist.cc.

References Assert, and db.

PostList * ValueRangePostList::next ( Xapian::weight 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() must be called before any methods which need the context of the current position.

Parameters:

w_min

The 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.

Reimplemented in ValueGePostList.

Definition at line 120 of file valuerangepostlist.cc.

References Assert, Xapian::ValueIterator::Internal::at_end(), begin, db, end, Xapian::ValueIterator::Internal::get_value(), Xapian::ValueIterator::Internal::next(), Xapian::Database::Internal::open_value_list(), slot, and valuelist.

PositionList * ValueRangePostList::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 113 of file valuerangepostlist.cc.

References Assert, and db.

void ValueRangePostList::operator= ( const ValueRangePostList & ) [protected]

Disallow assignment.

PositionList * ValueRangePostList::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::PostingIterator::Internal.

Definition at line 106 of file valuerangepostlist.cc.

References Assert, and db.

Xapian::weight ValueRangePostList::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 99 of file valuerangepostlist.cc.

References Assert, and db.

PostList * ValueRangePostList::skip_to	(	Xapian::docid	,
		Xapian::weight	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_min

The 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.

Reimplemented in ValueGePostList.

Definition at line 137 of file valuerangepostlist.cc.

References Assert, Xapian::ValueIterator::Internal::at_end(), begin, db, end, Xapian::ValueIterator::Internal::get_value(), Xapian::ValueIterator::Internal::next(), Xapian::Database::Internal::open_value_list(), Xapian::ValueIterator::Internal::skip_to(), slot, and valuelist.

Member Data Documentation

const std::string ValueRangePostList::begin [protected]

Definition at line 36 of file valuerangepostlist.h.

Referenced by check(), ValueGePostList::check(), get_description(), ValueGePostList::get_description(), next(), ValueGePostList::next(), skip_to(), and ValueGePostList::skip_to().

const Xapian::Database::Internal* ValueRangePostList::db [protected]

Definition at line 32 of file valuerangepostlist.h.

Referenced by at_end(), check(), ValueGePostList::check(), get_docid(), get_doclength(), get_termfreq_est(), get_termfreq_max(), get_weight(), next(), ValueGePostList::next(), open_position_list(), read_position_list(), recalc_maxweight(), skip_to(), and ValueGePostList::skip_to().

Xapian::doccount ValueRangePostList::db_size [protected]

Definition at line 38 of file valuerangepostlist.h.

Referenced by get_termfreq_est(), and get_termfreq_max().

const std::string ValueRangePostList::end [protected]

Definition at line 36 of file valuerangepostlist.h.

Referenced by check(), get_description(), next(), and skip_to().

Xapian::valueno ValueRangePostList::slot [protected]

Definition at line 34 of file valuerangepostlist.h.

Referenced by check(), ValueGePostList::check(), get_description(), ValueGePostList::get_description(), next(), ValueGePostList::next(), skip_to(), and ValueGePostList::skip_to().

ValueList* ValueRangePostList::valuelist [protected]

Definition at line 40 of file valuerangepostlist.h.

Referenced by check(), ValueGePostList::check(), get_docid(), next(), ValueGePostList::next(), skip_to(), ValueGePostList::skip_to(), and ~ValueRangePostList().

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

matcher/valuerangepostlist.h
matcher/valuerangepostlist.cc


Public Member Functions
	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.
Xapian::doccount	get_termfreq_est () const
	Get an estimate of the number of documents indexed by this term.
Xapian::doccount	get_termfreq_max () const
	Get an upper bound on the number of documents indexed by this term.
TermFreqs	get_termfreq_est_using_stats (const Xapian::Weight::Internal &stats) const
	Get an estimate for the termfreq and reltermfreq, given the stats.
Xapian::weight	get_maxweight () const
	Return an upper bound on what get_weight() can return.
Xapian::docid	get_docid () const
	Return the current docid.
Xapian::weight	get_weight () const
	Return the weight contribution for the current position.
Xapian::termcount	get_doclength () const
	Return the length of current document.
Xapian::weight	recalc_maxweight ()
	Recalculate the upper bound on what get_weight() can return.
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).
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).
PostList *	next (Xapian::weight w_min)
	Advance the current position to the next document in the postlist.
PostList *	skip_to (Xapian::docid, Xapian::weight w_min)
	Skip forward to the specified docid.
PostList *	check (Xapian::docid did, Xapian::weight w_min, bool &valid)
	Check if the specified docid occurs in this postlist.
bool	at_end () const
	Return true if the current position is past the last entry in this list.
Xapian::termcount	count_matching_subqs () const
	Count the number of leaf subqueries which match at the current position.
string	get_description () const
	Return a string description of this object.
Protected Member Functions
	ValueRangePostList (const ValueRangePostList &)
	Disallow copying.
void	operator= (const ValueRangePostList &)
	Disallow assignment.
Protected Attributes
const Xapian::Database::Internal *	db
Xapian::valueno	slot
const std::string	begin
const std::string	end
Xapian::doccount	db_size
ValueList *	valuelist