PostList returning entries from an MSet. More...

#include <msetpostlist.h>

Inheritance diagram for MSetPostList:

Collaboration diagram for MSetPostList:

Public Member Functions
	MSetPostList (const Xapian::MSet mset, bool decreasing_relevance_)

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

const std::string *	get_sort_key () const

const std::string *	get_collapse_key () const
	If the collapse key is already known, return it. More...

Xapian::termcount	get_doclength () const
	Not implemented for MSetPostList. 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...

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

PostList *	skip_to (Xapian::docid did, double w_min)
	Not meaningful for MSetPostList. More...

bool	at_end () const
	Return true if the current position is past the last entry in this list. 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 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...

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 Xapian::termcount	count_matching_subqs () const
	Count the number of leaf subqueries which match at the current position. 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 MSetPostList &)
	Don't allow assignment. More...

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

Private Attributes
int	cursor
	The MSet element that this PostList is pointing to. More...

Xapian::Internal::intrusive_ptr< Xapian::MSet::Internal >	mset_internal
	The MSet::Internal object which we're returning entries from. More...

bool	decreasing_relevance
	Is the sort order such the relevance decreases down the MSet? More...

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

PostList returning entries from an MSet.

This class is used with the remote backend. We perform a match on the remote server, then serialise the resulting MSet and pass it back to the client where we include it in the match by wrapping it in an MSetPostList.

Definition at line 35 of file msetpostlist.h.

Constructor & Destructor Documentation

◆ MSetPostList() [1/2]

MSetPostList::MSetPostList ( const MSetPostList & )

private

Don't allow copying.

◆ MSetPostList() [2/2]

MSetPostList::MSetPostList	(	const Xapian::MSet	mset,
		bool	decreasing_relevance_
	)

inline

Definition at line 55 of file msetpostlist.h.

References at_end(), get_collapse_key(), get_description(), get_docid(), get_doclength(), get_maxweight(), get_sort_key(), get_termfreq_est(), get_termfreq_max(), get_termfreq_min(), get_unique_terms(), get_weight(), Xapian::PostingIterator::Internal::next(), recalc_maxweight(), and skip_to().

Member Function Documentation

◆ at_end()

bool MSetPostList::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 154 of file msetpostlist.cc.

References Assert, LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ get_collapse_key()

const string * MSetPostList::get_collapse_key ( ) const

virtual

If the collapse key is already known, return it.

This is implemented by MSetPostList (and MergePostList). Other subclasses rely on the default implementation which just returns NULL.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 98 of file msetpostlist.cc.

References Assert, LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ get_description()

string MSetPostList::get_description ( ) const

virtual

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Definition at line 162 of file msetpostlist.cc.

Referenced by MSetPostList().

◆ get_docid()

Xapian::docid MSetPostList::get_docid ( ) const

virtual

Return the current docid.

Implements Xapian::PostingIterator::Internal.

Definition at line 74 of file msetpostlist.cc.

References Assert, LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ get_doclength()

Xapian::termcount MSetPostList::get_doclength ( ) const

virtual

Not implemented for MSetPostList.

Implements Xapian::PostingIterator::Internal.

Definition at line 106 of file msetpostlist.cc.

Referenced by MSetPostList().

◆ get_maxweight()

double MSetPostList::get_maxweight ( ) const

virtual

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

Implements Xapian::PostingIterator::Internal.

Definition at line 54 of file msetpostlist.cc.

References LOGCALL, and RETURN.

Referenced by MSetPostList(), and recalc_maxweight().

◆ get_sort_key()

const string * MSetPostList::get_sort_key ( ) const

virtual

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 90 of file msetpostlist.cc.

References Assert, LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ get_termfreq_est()

Xapian::doccount MSetPostList::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 40 of file msetpostlist.cc.

References LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ get_termfreq_max()

Xapian::doccount MSetPostList::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 47 of file msetpostlist.cc.

References LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ get_termfreq_min()

Xapian::doccount MSetPostList::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 33 of file msetpostlist.cc.

References LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ get_unique_terms()

Xapian::termcount MSetPostList::get_unique_terms ( ) const

virtual

Return the number of unique terms in the current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 112 of file msetpostlist.cc.

Referenced by MSetPostList().

◆ get_weight()

double MSetPostList::get_weight ( ) const

virtual

Return the weight contribution for the current position.

Implements Xapian::PostingIterator::Internal.

Definition at line 82 of file msetpostlist.cc.

References Assert, LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ next()

PostList * MSetPostList::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 125 of file msetpostlist.cc.

References Assert, LOGCALL, and RETURN.

◆ operator=()

void MSetPostList::operator= ( const MSetPostList & )

private

Don't allow assignment.

◆ recalc_maxweight()

double MSetPostList::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 118 of file msetpostlist.cc.

References get_maxweight(), LOGCALL, and RETURN.

Referenced by MSetPostList().

◆ skip_to()

PostList * MSetPostList::skip_to	(	Xapian::docid	did,
		double	w_min
	)

virtual

Not meaningful for MSetPostList.

Implements Xapian::PostingIterator::Internal.

Definition at line 145 of file msetpostlist.cc.

Referenced by MSetPostList().

Member Data Documentation

◆ cursor

int MSetPostList::cursor

private

The MSet element that this PostList is pointing to.

Definition at line 43 of file msetpostlist.h.

◆ decreasing_relevance

bool MSetPostList::decreasing_relevance

private

Is the sort order such the relevance decreases down the MSet?

This is true for sort_by_relevance and sort_by_relevance_then_value.

Definition at line 52 of file msetpostlist.h.

◆ mset_internal

Xapian::Internal::intrusive_ptr<Xapian::MSet::Internal> MSetPostList::mset_internal

private

The MSet::Internal object which we're returning entries from.

Definition at line 46 of file msetpostlist.h.

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

matcher/msetpostlist.h
matcher/msetpostlist.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MSetPostList() [1/2]

◆ MSetPostList() [2/2]

Member Function Documentation

◆ at_end()

◆ get_collapse_key()

◆ get_description()

◆ get_docid()

◆ get_doclength()

◆ get_maxweight()

◆ get_sort_key()

◆ get_termfreq_est()

◆ get_termfreq_max()

◆ get_termfreq_min()

◆ get_unique_terms()

◆ get_weight()

◆ next()

◆ operator=()

◆ recalc_maxweight()

◆ skip_to()

Member Data Documentation

◆ cursor

◆ decreasing_relevance

◆ mset_internal