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

	~OrPosPostList ()

Xapian::doccount	get_termfreq_min () const
	Get a lower bound on 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...

Xapian::doccount	get_termfreq_est () const
	Get an estimate of 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...

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

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

Internal *	next (double w_min)
	Advance the current position to the next document in the postlist. More...

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

virtual Internal *	check (Xapian::docid did, double w_min, bool &valid)
	Check if the specified docid occurs in this 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
void	operator= (const OrPosPostList &)
	Don't allow assignment. More...

	OrPosPostList (const OrPosPostList &)
	Don't allow copying. More...

Private Attributes
PostList *	pl

OrPositionList	position_list

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

Detailed Description

Wrapper postlist providing positions for an OR.

Definition at line 28 of file orpospostlist.h.

Constructor & Destructor Documentation

◆ OrPosPostList() [1/2]

OrPosPostList::OrPosPostList ( const OrPosPostList & )

private

Don't allow copying.

◆ OrPosPostList() [2/2]

OrPosPostList::OrPosPostList ( PostList * pl_ )

inline

◆ ~OrPosPostList()

OrPosPostList::~OrPosPostList ( )

Definition at line 25 of file orpospostlist.cc.

References pl.

Referenced by OrPosPostList().

Member Function Documentation

◆ at_end()

bool OrPosPostList::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 85 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::at_end(), and pl.

Referenced by OrPosPostList().

◆ count_matching_subqs()

Xapian::termcount OrPosPostList::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 140 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::count_matching_subqs(), and pl.

Referenced by OrPosPostList().

◆ get_description()

std::string OrPosPostList::get_description ( ) const

virtual

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Definition at line 125 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_description(), and pl.

Referenced by OrPosPostList().

◆ get_docid()

Xapian::docid OrPosPostList::get_docid ( ) const

virtual

Return the current docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 61 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_docid(), and pl.

Referenced by OrPosPostList().

◆ get_doclength()

Xapian::termcount OrPosPostList::get_doclength ( ) const

virtual

Return the length of current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 67 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_doclength(), and pl.

Referenced by OrPosPostList().

◆ get_maxweight()

double OrPosPostList::get_maxweight ( ) const

virtual

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

Implements Xapian::PostingIterator::Internal.

Definition at line 55 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_maxweight(), and pl.

Referenced by OrPosPostList().

◆ get_termfreq_est()

Xapian::doccount OrPosPostList::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 43 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_termfreq_est(), and pl.

Referenced by OrPosPostList().

◆ get_termfreq_est_using_stats()

TermFreqs OrPosPostList::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 49 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_termfreq_est_using_stats(), and pl.

Referenced by OrPosPostList().

◆ get_termfreq_max()

Xapian::doccount OrPosPostList::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 37 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_termfreq_max(), and pl.

Referenced by OrPosPostList().

◆ get_termfreq_min()

Xapian::doccount OrPosPostList::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 31 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_termfreq_min(), and pl.

Referenced by OrPosPostList().

◆ get_unique_terms()

Xapian::termcount OrPosPostList::get_unique_terms ( ) const

virtual

Return the number of unique terms in the current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 73 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_unique_terms(), and pl.

Referenced by OrPosPostList().

◆ get_wdf()

Xapian::termcount OrPosPostList::get_wdf ( ) const

virtual

Return the wdf for the document at the current position.

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 134 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_wdf(), and pl.

Referenced by OrPosPostList().

◆ get_weight()

double OrPosPostList::get_weight ( ) const

virtual

Return the weight contribution for the current position.

Implements Xapian::PostingIterator::Internal.

Definition at line 79 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::get_weight(), and pl.

Referenced by OrPosPostList().

◆ next()

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

Definition at line 103 of file orpospostlist.cc.

References Xapian::PostingIterator::Internal::next(), and pl.

◆ operator=()

void OrPosPostList::operator= ( const OrPosPostList & )

private

Don't allow assignment.

◆ 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::PostingIterator::Internal.

Definition at line 97 of file orpospostlist.cc.

References OrPositionList::gather(), pl, and position_list.

Referenced by OrPosPostList().

◆ recalc_maxweight()

double OrPosPostList::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 91 of file orpospostlist.cc.

References pl, and Xapian::PostingIterator::Internal::recalc_maxweight().

Referenced by OrPosPostList().

◆ skip_to()

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

Definition at line 114 of file orpospostlist.cc.

References pl, and Xapian::PostingIterator::Internal::skip_to().

Referenced by OrPosPostList().

Member Data Documentation

◆ pl

PostList* OrPosPostList::pl

private

Definition at line 35 of file orpospostlist.h.

Referenced by at_end(), count_matching_subqs(), get_description(), get_docid(), get_doclength(), get_maxweight(), get_termfreq_est(), get_termfreq_est_using_stats(), get_termfreq_max(), get_termfreq_min(), get_unique_terms(), get_wdf(), get_weight(), next(), read_position_list(), recalc_maxweight(), skip_to(), and ~OrPosPostList().

◆ position_list

OrPositionList OrPosPostList::position_list

private

Definition at line 37 of file orpospostlist.h.

Referenced by read_position_list().

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

matcher/orpospostlist.h
matcher/orpospostlist.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OrPosPostList() [1/2]

◆ OrPosPostList() [2/2]

◆ ~OrPosPostList()

Member Function Documentation

◆ at_end()

◆ count_matching_subqs()

◆ get_description()

◆ get_docid()

◆ get_doclength()

◆ get_maxweight()

◆ get_termfreq_est()

◆ get_termfreq_est_using_stats()

◆ get_termfreq_max()

◆ get_termfreq_min()

◆ get_unique_terms()

◆ get_wdf()

◆ get_weight()

◆ next()

◆ operator=()

◆ read_position_list()

◆ recalc_maxweight()

◆ skip_to()

Member Data Documentation

◆ pl

◆ position_list