#include <honey_alldocspostlist.h>

Inheritance diagram for HoneyAllDocsPostList:

Collaboration diagram for HoneyAllDocsPostList:

Public Member Functions
	HoneyAllDocsPostList (const HoneyDatabase *db_, Xapian::doccount doccount)

	~HoneyAllDocsPostList ()

Xapian::docid	get_docid () const
	Return the current docid. More...

Xapian::termcount	get_wdf () const
	Return the wdf for the document at the current position. More...

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

Xapian::termcount	get_wdf_upper_bound () const

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

Public Member Functions inherited from LeafPostList
	~LeafPostList ()

Xapian::termcount	get_collfreq () const
	Get the collection frequency of the term. More...

void	set_termweight (const Xapian::Weight *weight_)
	Set the weighting scheme to use during matching. More...

double	resolve_lazy_termweight (Xapian::Weight weight_, Xapian::Weight::Internal stats, Xapian::termcount qlen, Xapian::termcount wqf, double factor, const Xapian::Database::Internal *shard)

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

Xapian::termcount	count_matching_subqs () const
	Count the number of leaf subqueries which match at the current position. More...

void	gather_position_lists (OrPositionList *orposlist)
	Gather PositionList* objects for a subtree. More...

virtual bool	open_nearby_postlist (std::string_view term_, bool need_read_pos, LeafPostList *&pl) const
	Open another postlist from the same database. More...

const std::string &	get_term () const
	Get the term name. More...

void	set_term (std::string_view term_)
	Set the term name. 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 *	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...

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	get_docid_range (docid &first, docid &last) const
	Get the bounds on the range of docids this PostList can return. More...

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

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

Private Attributes
HoneyCursor *	cursor
	Cursor on the postlist table. More...

Honey::DocLenChunkReader	reader

Additional Inherited Members
Protected Member Functions inherited from LeafPostList
	LeafPostList (std::string_view term_)
	Only constructable as a base class for derived classes. More...

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

Protected Attributes inherited from LeafPostList
const Xapian::Weight *	weight = nullptr

std::string	term
	The term name for this postlist (empty for an alldocs postlist). More...

Xapian::termcount	collfreq
	The collection frequency of the term. More...

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 137 of file honey_alldocspostlist.h.

Constructor & Destructor Documentation

◆ HoneyAllDocsPostList() [1/2]

HoneyAllDocsPostList::HoneyAllDocsPostList ( const HoneyAllDocsPostList & )

privatedelete

Don't allow copying.

◆ HoneyAllDocsPostList() [2/2]

HoneyAllDocsPostList::HoneyAllDocsPostList	(	const HoneyDatabase *	db_,
		Xapian::doccount	doccount
	)

Definition at line 37 of file honey_alldocspostlist.cc.

◆ ~HoneyAllDocsPostList()

HoneyAllDocsPostList::~HoneyAllDocsPostList ( )

Definition at line 54 of file honey_alldocspostlist.cc.

References cursor.

Member Function Documentation

◆ at_end()

bool HoneyAllDocsPostList::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 74 of file honey_alldocspostlist.cc.

References cursor.

Referenced by get_wdf().

◆ check()

PostList * HoneyAllDocsPostList::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 142 of file honey_alldocspostlist.cc.

References HoneyCursor::after_end(), Assert, Honey::DocLenChunkReader::at_end(), cursor, HoneyCursor::find_entry_ge(), Honey::make_doclenchunk_key(), rare, reader, Honey::DocLenChunkReader::skip_to(), and Honey::DocLenChunkReader::update().

◆ get_description()

string HoneyAllDocsPostList::get_description ( ) const

virtual

Return a string description of this object.

Implements Xapian::Internal::PostList.

Definition at line 191 of file honey_alldocspostlist.cc.

References Xapian::Internal::str(), and Xapian::Internal::PostList::termfreq.

◆ get_docid()

Xapian::docid HoneyAllDocsPostList::get_docid ( ) const

virtual

Return the current docid.

Implements Xapian::Internal::PostList.

Definition at line 60 of file honey_alldocspostlist.cc.

References Honey::DocLenChunkReader::get_docid(), and reader.

◆ get_wdf()

Xapian::termcount HoneyAllDocsPostList::get_wdf ( ) const

virtual

Return the wdf for the document at the current position.

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::Internal::PostList.

Definition at line 66 of file honey_alldocspostlist.cc.

References AssertParanoid, at_end(), LOGCALL, and RETURN.

◆ get_wdf_upper_bound()

Xapian::termcount HoneyAllDocsPostList::get_wdf_upper_bound ( ) const

virtual

Implements LeafPostList.

Definition at line 184 of file honey_alldocspostlist.cc.

References LOGCALL, and RETURN.

◆ next()

PostList * HoneyAllDocsPostList::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 80 of file honey_alldocspostlist.cc.

References HoneyCursor::after_end(), Assert, Honey::DocLenChunkReader::at_end(), cursor, Honey::DocLenChunkReader::next(), HoneyCursor::next(), reader, and Honey::DocLenChunkReader::update().

◆ operator=()

HoneyAllDocsPostList& HoneyAllDocsPostList::operator= ( const HoneyAllDocsPostList & )

privatedelete

Don't allow assignment.

◆ skip_to()

PostList * HoneyAllDocsPostList::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 101 of file honey_alldocspostlist.cc.

References HoneyCursor::after_end(), Assert, Honey::DocLenChunkReader::at_end(), cursor, HoneyCursor::find_entry_ge(), Honey::make_doclenchunk_key(), rare, reader, Honey::DocLenChunkReader::skip_to(), and Honey::DocLenChunkReader::update().

Member Data Documentation

◆ cursor

HoneyCursor* HoneyAllDocsPostList::cursor

private

Cursor on the postlist table.

Definition at line 145 of file honey_alldocspostlist.h.

Referenced by at_end(), check(), next(), skip_to(), and ~HoneyAllDocsPostList().

◆ reader

Honey::DocLenChunkReader HoneyAllDocsPostList::reader

private

Definition at line 147 of file honey_alldocspostlist.h.

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

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

backends/honey/honey_alldocspostlist.h
backends/honey/honey_alldocspostlist.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HoneyAllDocsPostList() [1/2]

◆ HoneyAllDocsPostList() [2/2]

◆ ~HoneyAllDocsPostList()

Member Function Documentation

◆ at_end()

◆ check()

◆ get_description()

◆ get_docid()

◆ get_wdf()

◆ get_wdf_upper_bound()

◆ next()

◆ operator=()

◆ skip_to()

Member Data Documentation

◆ cursor

◆ reader