#include <valuerangepostlist.h>

Inheritance diagram for ValueRangePostList:

Collaboration diagram for ValueRangePostList:

Public Member Functions
	ValueRangePostList (const Xapian::Database::Internal db_, EstimateOp estimate_op_, Xapian::doccount termfreq_, Xapian::valueno slot_, const std::string &begin_, const std::string &end_)

	~ValueRangePostList ()

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

Xapian::termcount	get_wdfdocmax () const

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::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 Xapian::termcount	get_wdf () const
	Return the wdf for the document at the current position. 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...

PostList *	next ()
	Advance the current position to the next document in the postlist. More...

PostList *	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...

virtual void	get_docid_range (docid &first, docid &last) const
	Get the bounds on the range of docids this PostList can return. More...

Protected Member Functions
	ValueRangePostList (const ValueRangePostList &)
	Disallow copying. More...

void	operator= (const ValueRangePostList &)
	Disallow assignment. More...

Protected Member Functions inherited from Xapian::Internal::PostList
	PostList ()
	Only constructable as a base class for derived classes. More...

Protected Attributes
const Xapian::Database::Internal *	db

Xapian::valueno	slot

const std::string	begin

const std::string	end

Xapian::doccount	accepted = 0
	Number of times the range test accepted the candidate document. More...

Xapian::doccount	rejected = 0
	Number of times the range test rejected the candidate document. More...

EstimateOp *	estimate_op
	Object to report accepted/rejected counts to. More...

ValueList *	valuelist = nullptr

Protected Attributes inherited from Xapian::Internal::PostList
Xapian::doccount	termfreq
	Estimate of the number of documents this PostList will return. More...

Detailed Description

Definition at line 32 of file valuerangepostlist.h.

Constructor & Destructor Documentation

◆ ValueRangePostList() [1/2]

ValueRangePostList::ValueRangePostList ( const ValueRangePostList & )

protected

Disallow copying.

◆ ValueRangePostList() [2/2]

ValueRangePostList::ValueRangePostList	(	const Xapian::Database::Internal *	db_,
		EstimateOp *	estimate_op_,
		Xapian::doccount	termfreq_,
		Xapian::valueno	slot_,
		const std::string &	begin_,
		const std::string &	end_
	)

inline

Definition at line 58 of file valuerangepostlist.h.

References Xapian::Internal::PostList::termfreq.

◆ ~ValueRangePostList()

ValueRangePostList::~ValueRangePostList ( )

Definition at line 34 of file valuerangepostlist.cc.

Member Function Documentation

◆ at_end()

bool ValueRangePostList::at_end ( ) const

virtual

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

Implements Xapian::Internal::PostList.

Definition at line 147 of file valuerangepostlist.cc.

◆ check()

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

Definition at line 128 of file valuerangepostlist.cc.

References Assert, and AssertRelParanoid.

◆ count_matching_subqs()

Xapian::termcount ValueRangePostList::count_matching_subqs ( ) const

virtual

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

Reimplemented from Xapian::Internal::PostList.

Definition at line 153 of file valuerangepostlist.cc.

◆ get_description()

string ValueRangePostList::get_description ( ) const

virtual

Return a string description of this object.

Implements Xapian::Internal::PostList.

Definition at line 159 of file valuerangepostlist.cc.

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

◆ get_docid()

Xapian::docid ValueRangePostList::get_docid ( ) const

virtual

Return the current docid.

Implements Xapian::Internal::PostList.

Definition at line 47 of file valuerangepostlist.cc.

References Assert.

◆ get_wdfdocmax()

Xapian::termcount ValueRangePostList::get_wdfdocmax ( ) const

Definition at line 64 of file valuerangepostlist.cc.

References Assert.

◆ get_weight()

double ValueRangePostList::get_weight	(	Xapian::termcount	doclen,
		Xapian::termcount	unique_terms,
		Xapian::termcount	wdfdocmax
	)		const

virtual

Return the weight contribution for the current position.

Implements Xapian::Internal::PostList.

Definition at line 55 of file valuerangepostlist.cc.

References Assert.

◆ next()

PostList * ValueRangePostList::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_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::Internal::PostList.

Definition at line 85 of file valuerangepostlist.cc.

References Assert.

◆ operator=()

void ValueRangePostList::operator= ( const ValueRangePostList & )

protected

Disallow assignment.

◆ read_position_list()

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::Internal::PostList.

Definition at line 78 of file valuerangepostlist.cc.

References Assert.

◆ recalc_maxweight()

double ValueRangePostList::recalc_maxweight ( )

virtual

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

The maximum weight that get_weight() can return can decrease as the match progresses (typically when the PostList tree prunes) - calling this method calculates a current upper bound.

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

Implements Xapian::Internal::PostList.

Definition at line 71 of file valuerangepostlist.cc.

References Assert.

◆ skip_to()

PostList * ValueRangePostList::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_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::Internal::PostList.

Definition at line 109 of file valuerangepostlist.cc.

References Assert.

Member Data Documentation

◆ accepted

Xapian::doccount ValueRangePostList::accepted = 0

protected

Number of times the range test accepted the candidate document.

Definition at line 41 of file valuerangepostlist.h.

◆ begin

const std::string ValueRangePostList::begin

protected

Definition at line 38 of file valuerangepostlist.h.

◆ db

const Xapian::Database::Internal* ValueRangePostList::db

protected

Definition at line 34 of file valuerangepostlist.h.

◆ end

const std::string ValueRangePostList::end

protected

Definition at line 38 of file valuerangepostlist.h.

◆ estimate_op

EstimateOp* ValueRangePostList::estimate_op

protected

Object to report accepted/rejected counts to.

Definition at line 47 of file valuerangepostlist.h.

◆ rejected

Xapian::doccount ValueRangePostList::rejected = 0

protected

Number of times the range test rejected the candidate document.

Definition at line 44 of file valuerangepostlist.h.

◆ slot

Xapian::valueno ValueRangePostList::slot

protected

Definition at line 36 of file valuerangepostlist.h.

◆ valuelist

ValueList* ValueRangePostList::valuelist = nullptr

protected

Definition at line 49 of file valuerangepostlist.h.

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

matcher/valuerangepostlist.h
matcher/valuerangepostlist.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ValueRangePostList() [1/2]

◆ ValueRangePostList() [2/2]

◆ ~ValueRangePostList()

Member Function Documentation

◆ at_end()

◆ check()

◆ count_matching_subqs()

◆ get_description()

◆ get_docid()

◆ get_wdfdocmax()

◆ get_weight()

◆ next()

◆ operator=()

◆ read_position_list()

◆ recalc_maxweight()

◆ skip_to()

Member Data Documentation

◆ accepted

◆ begin

◆ db

◆ end

◆ estimate_op

◆ rejected

◆ slot

◆ valuelist