PostList which adds on a term-independent weight contribution. More...

#include <extraweightpostlist.h>

Inheritance diagram for ExtraWeightPostList:

Collaboration diagram for ExtraWeightPostList:

Public Member Functions
	ExtraWeightPostList (PostList pl_, Xapian::Weight weight_, PostListTree *pltree_)

	~ExtraWeightPostList ()

double	get_weight (Xapian::termcount doclen, Xapian::termcount unique_terms, Xapian::termcount wdfdocmax) const
	Return the weight contribution for the current position. 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, double w_min)
	Skip forward to the specified docid. More...

std::string	get_description () const
	Return a string description of this object. More...

Public Member Functions inherited from WrapperPostList
	WrapperPostList (PostList *pl_)

	~WrapperPostList ()

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

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

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

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::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 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 PostList *	check (Xapian::docid did, double w_min, bool &valid)
	Check if the specified docid occurs in this 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...

Private Member Functions
void	operator= (const ExtraWeightPostList &)=delete
	Don't allow assignment. More...

	ExtraWeightPostList (const ExtraWeightPostList &)=delete
	Don't allow copying. More...

Private Attributes
Xapian::Weight *	weight

PostListTree *	pltree

double	max_extra

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

Protected Attributes inherited from WrapperPostList
PostList *	pl

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

Detailed Description

PostList which adds on a term-independent weight contribution.

Definition at line 33 of file extraweightpostlist.h.

Constructor & Destructor Documentation

◆ ExtraWeightPostList() [1/2]

ExtraWeightPostList::ExtraWeightPostList ( const ExtraWeightPostList & )

privatedelete

Don't allow copying.

◆ ExtraWeightPostList() [2/2]

ExtraWeightPostList::ExtraWeightPostList	(	PostList *	pl_,
		Xapian::Weight *	weight_,
		PostListTree *	pltree_
	)

inline

Definition at line 47 of file extraweightpostlist.h.

◆ ~ExtraWeightPostList()

ExtraWeightPostList::~ExtraWeightPostList ( )

inline

Definition at line 55 of file extraweightpostlist.h.

References weight.

Member Function Documentation

◆ get_description()

string ExtraWeightPostList::get_description ( ) const

virtual

Return a string description of this object.

Implements Xapian::Internal::PostList.

Definition at line 76 of file extraweightpostlist.cc.

References Xapian::Internal::str().

◆ get_weight()

double ExtraWeightPostList::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 32 of file extraweightpostlist.cc.

References AssertRel.

◆ next()

PostList * ExtraWeightPostList::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 55 of file extraweightpostlist.cc.

References Xapian::Internal::PostList::next().

◆ operator=()

void ExtraWeightPostList::operator= ( const ExtraWeightPostList & )

privatedelete

Don't allow assignment.

◆ recalc_maxweight()

double ExtraWeightPostList::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 49 of file extraweightpostlist.cc.

◆ skip_to()

PostList * ExtraWeightPostList::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 67 of file extraweightpostlist.cc.

References Assert.

Member Data Documentation

◆ max_extra

double ExtraWeightPostList::max_extra

private

Definition at line 44 of file extraweightpostlist.h.

◆ pltree

PostListTree* ExtraWeightPostList::pltree

private

Definition at line 42 of file extraweightpostlist.h.

◆ weight

Xapian::Weight* ExtraWeightPostList::weight

private

Definition at line 40 of file extraweightpostlist.h.

Referenced by ~ExtraWeightPostList().

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

matcher/extraweightpostlist.h
matcher/extraweightpostlist.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExtraWeightPostList() [1/2]

◆ ExtraWeightPostList() [2/2]

◆ ~ExtraWeightPostList()

Member Function Documentation

◆ get_description()

◆ get_weight()

◆ next()

◆ operator=()

◆ recalc_maxweight()

◆ skip_to()

Member Data Documentation

◆ max_extra

◆ pltree

◆ weight