#include <postlisttree.h>

Collaboration diagram for PostListTree:

Public Member Functions
	PostListTree (ValueStreamDocument &vsdoc_, Xapian::Database &db_, const Xapian::Weight &wtscheme)

void	delete_postlists ()
	Delete all the PostList objects. More...

	~PostListTree ()

bool *	get_max_weight_cached_flag_ptr ()
	Return pointer to flag to set to false to invalidate cached max weight. More...

double	set_postlists (PostList **pls, Xapian::doccount n_shards_)

double	recalc_maxweight ()

void	force_recalc ()

Xapian::docid	get_docid () const

Xapian::termcount	get_doclength (Xapian::docid shard_did) const

double	get_weight () const

bool	next (double w_min)
	Return false if we're done. More...

void	get_doc_stats (Xapian::docid shard_did, Xapian::termcount &doclen, Xapian::termcount &unique_terms, Xapian::termcount &wdfdocmax) const

Xapian::termcount	count_matching_subqs () const

std::string	get_description () const

Private Attributes
PostList *	pl = NULL

bool	use_cached_max_weight = false

bool	need_doclength

bool	need_unique_terms

bool	need_wdfdocmax

double	max_weight

Xapian::doccount	current_shard = 0
	The current shard. More...

PostList **	shard_pls = nullptr
	The postlists for the shards. More...

double *	max_after = nullptr
	The maximum weight any shards after each index could return. More...

Xapian::doccount	n_shards = 0
	The number of shards. More...

ValueStreamDocument &	vsdoc
	Document proxy used for valuestream caching. More...

Xapian::Database &	db

Xapian::Database::Internal *	shard_db = nullptr

Detailed Description

Definition at line 28 of file postlisttree.h.

Constructor & Destructor Documentation

◆ PostListTree()

PostListTree::PostListTree	(	ValueStreamDocument &	vsdoc_,
		Xapian::Database &	db_,
		const Xapian::Weight &	wtscheme
	)

inline

Definition at line 80 of file postlisttree.h.

◆ ~PostListTree()

PostListTree::~PostListTree ( )

inline

Definition at line 99 of file postlisttree.h.

References delete_postlists().

Member Function Documentation

◆ count_matching_subqs()

Xapian::termcount PostListTree::count_matching_subqs ( ) const

inline

Definition at line 231 of file postlisttree.h.

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

Referenced by ProtoMSet::update_max_weight().

◆ delete_postlists()

void PostListTree::delete_postlists ( )

inline

Delete all the PostList objects.

Definition at line 90 of file postlisttree.h.

References max_after, n_shards, and shard_pls.

Referenced by Matcher::get_local_mset(), and ~PostListTree().

◆ force_recalc()

void PostListTree::force_recalc ( )

inline

Definition at line 154 of file postlisttree.h.

References use_cached_max_weight.

Referenced by OrPostList::check(), AndPostList::check_helper(), OrPostList::decay_to_and(), OrPostList::decay_to_andmaybe(), MaxPostList::erase_sublist(), XorPostList::erase_sublist(), OrPostList::next(), AndPostList::next_helper(), OrPostList::skip_to(), and AndPostList::skip_to_helper().

◆ get_description()

std::string PostListTree::get_description ( ) const

inline

Definition at line 235 of file postlisttree.h.

References current_shard, Xapian::Internal::PostList::get_description(), n_shards, and shard_pls.

◆ get_doc_stats()

void PostListTree::get_doc_stats	(	Xapian::docid	shard_did,
		Xapian::termcount &	doclen,
		Xapian::termcount &	unique_terms,
		Xapian::termcount &	wdfdocmax
	)		const

inline

Definition at line 215 of file postlisttree.h.

References Xapian::Database::Internal::get_doclength(), Xapian::Database::Internal::get_unique_terms(), Xapian::Database::Internal::get_wdfdocmax(), need_doclength, need_unique_terms, need_wdfdocmax, and shard_db.

Referenced by get_weight(), and SelectPostList::vet().

◆ get_docid()

Xapian::docid PostListTree::get_docid ( ) const

inline

Definition at line 158 of file postlisttree.h.

References current_shard, Xapian::Internal::PostList::get_docid(), n_shards, pl, and unshard().

Referenced by Matcher::get_local_mset().

◆ get_doclength()

Xapian::termcount PostListTree::get_doclength ( Xapian::docid shard_did ) const

inline

Definition at line 162 of file postlisttree.h.

References Xapian::Database::Internal::get_doclength(), and shard_db.

◆ get_max_weight_cached_flag_ptr()

bool* PostListTree::get_max_weight_cached_flag_ptr ( )

inline

Return pointer to flag to set to false to invalidate cached max weight.

Used with ExternalPostList, which wraps a PostingSource object.

Definition at line 107 of file postlisttree.h.

References use_cached_max_weight.

Referenced by Xapian::Internal::QueryPostingSource::postlist().

◆ get_weight()

double PostListTree::get_weight ( ) const

inline

Definition at line 166 of file postlisttree.h.

References get_doc_stats(), Xapian::Internal::PostList::get_docid(), Xapian::Internal::PostList::get_weight(), and pl.

Referenced by ProtoMSet::early_reject(), and Matcher::get_local_mset().

◆ next()

bool PostListTree::next ( double w_min )

inline

Return false if we're done.

Definition at line 173 of file postlisttree.h.

References Xapian::Internal::PostList::at_end(), current_shard, db, Xapian::Internal::intrusive_ptr_nonnull< T >::get(), Xapian::Database::internal, n_shards, ValueStreamDocument::new_shard(), Xapian::Internal::PostList::next(), pl, rare, recalc_maxweight(), shard_db, shard_pls, use_cached_max_weight, usual, and vsdoc.

Referenced by Matcher::get_local_mset().

◆ recalc_maxweight()

double PostListTree::recalc_maxweight ( )

inline

Definition at line 138 of file postlisttree.h.

References current_shard, max_after, max_weight, Xapian::Internal::PostList::recalc_maxweight(), shard_pls, and use_cached_max_weight.

Referenced by next(), and set_postlists().

◆ set_postlists()

double PostListTree::set_postlists	(	PostList **	pls,
		Xapian::doccount	n_shards_
	)

inline

Definition at line 109 of file postlisttree.h.

References Assert, current_shard, db, Xapian::Internal::intrusive_ptr_nonnull< T >::get(), Xapian::Database::internal, max_after, max_weight, n_shards, ValueStreamDocument::new_shard(), pl, recalc_maxweight(), shard_db, shard_pls, use_cached_max_weight, and vsdoc.

Referenced by Matcher::get_local_mset().

Member Data Documentation

◆ current_shard

Xapian::doccount PostListTree::current_shard = 0

private

The current shard.

Definition at line 42 of file postlisttree.h.

Referenced by get_description(), get_docid(), next(), recalc_maxweight(), and set_postlists().

◆ db

Xapian::Database& PostListTree::db

private

Definition at line 75 of file postlisttree.h.

Referenced by next(), and set_postlists().

◆ max_after

double* PostListTree::max_after = nullptr

private

The maximum weight any shards after each index could return.

For each shard, this gives the maximum weight out of all the shards after the current one. So for the last shard this will be zero.

For each match, this is calculated once early on by set_postlists() and then doesn't change.

We use this information in recalc_maxweight() to avoid needing to iterate over all the remaining shards.

Definition at line 63 of file postlisttree.h.

Referenced by delete_postlists(), recalc_maxweight(), and set_postlists().

◆ max_weight

double PostListTree::max_weight

private

Definition at line 39 of file postlisttree.h.

Referenced by recalc_maxweight(), and set_postlists().

◆ n_shards

Xapian::doccount PostListTree::n_shards = 0

private

The number of shards.

Definition at line 66 of file postlisttree.h.

Referenced by delete_postlists(), get_description(), get_docid(), next(), and set_postlists().

◆ need_doclength

bool PostListTree::need_doclength

private

Definition at line 33 of file postlisttree.h.

Referenced by get_doc_stats().

◆ need_unique_terms

bool PostListTree::need_unique_terms

private

Definition at line 35 of file postlisttree.h.

Referenced by get_doc_stats().

◆ need_wdfdocmax

bool PostListTree::need_wdfdocmax

private

Definition at line 37 of file postlisttree.h.

Referenced by get_doc_stats().

◆ pl

PostList* PostListTree::pl = NULL

private

Definition at line 29 of file postlisttree.h.

Referenced by count_matching_subqs(), get_docid(), get_weight(), next(), and set_postlists().

◆ shard_db

Xapian::Database::Internal* PostListTree::shard_db = nullptr

private

Definition at line 77 of file postlisttree.h.

Referenced by get_doc_stats(), get_doclength(), next(), and set_postlists().

◆ shard_pls

PostList** PostListTree::shard_pls = nullptr

private

The postlists for the shards.

Entries corresponding to remote shards will be nullptr - the results from remote shards are included by merging MSet objects, rather than via the PostList tree.

Definition at line 50 of file postlisttree.h.

Referenced by delete_postlists(), get_description(), next(), recalc_maxweight(), and set_postlists().

◆ use_cached_max_weight

bool PostListTree::use_cached_max_weight = false

private

Definition at line 31 of file postlisttree.h.

Referenced by force_recalc(), get_max_weight_cached_flag_ptr(), next(), recalc_maxweight(), and set_postlists().

◆ vsdoc

ValueStreamDocument& PostListTree::vsdoc

private

Document proxy used for valuestream caching.

Each time we move to a new shard we must notify this object so it can invalidate any cached valuestreams (which are specific to the shard).

Definition at line 73 of file postlisttree.h.

Referenced by next(), and set_postlists().

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

matcher/postlisttree.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PostListTree()

◆ ~PostListTree()

Member Function Documentation

◆ count_matching_subqs()

◆ delete_postlists()

◆ force_recalc()

◆ get_description()

◆ get_doc_stats()

◆ get_docid()

◆ get_doclength()

◆ get_max_weight_cached_flag_ptr()

◆ get_weight()

◆ next()

◆ recalc_maxweight()

◆ set_postlists()

Member Data Documentation

◆ current_shard

◆ db

◆ max_after

◆ max_weight

◆ n_shards

◆ need_doclength

◆ need_unique_terms

◆ need_wdfdocmax

◆ pl

◆ shard_db

◆ shard_pls

◆ use_cached_max_weight

◆ vsdoc