xapian-core  1.4.21
Public Member Functions | Private Member Functions | Private Attributes | List of all members
GlassAllDocsPostList Class Reference

#include <glass_alldocspostlist.h>

+ Inheritance diagram for GlassAllDocsPostList:
+ Collaboration diagram for GlassAllDocsPostList:

Public Member Functions

 GlassAllDocsPostList (Xapian::Internal::intrusive_ptr< const GlassDatabase > db_, Xapian::doccount doccount_)
 
Xapian::doccount get_termfreq () const
 Return the exact term frequency. More...
 
Xapian::termcount get_doclength () const
 Return the length of current document. More...
 
Xapian::termcount get_wdf () const
 Return the wdf for the document at the current position. More...
 
PositionListread_position_list ()
 Read the position list for the term in the current document and return a pointer to it (owned by the PostList). More...
 
PositionListopen_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...
 
std::string get_description () const
 Return a string description of this object. More...
 
- Public Member Functions inherited from GlassPostList
 GlassPostList (Xapian::Internal::intrusive_ptr< const GlassDatabase > this_db_, const string &term, bool keep_reference)
 Default constructor. More...
 
 ~GlassPostList ()
 Destructor. More...
 
LeafPostListopen_nearby_postlist (const std::string &term_) const
 Open another postlist from the same database. More...
 
bool jump_to (Xapian::docid desired_did)
 Used for looking up doclens. More...
 
Xapian::doccount get_termfreq () const
 Returns number of docs indexed by this term. More...
 
Xapian::docid get_docid () const
 Returns the current docid. More...
 
Xapian::termcount get_doclength () const
 Returns the length of current document. More...
 
Xapian::termcount get_unique_terms () const
 Returns the number of unique terms in the current document. More...
 
Xapian::termcount get_wdf () const
 Returns the Within Document Frequency of the term in the current document. More...
 
PositionListread_position_list ()
 Get the list of positions of the term in the current document. More...
 
PositionListopen_position_list () const
 Get the list of positions of the term in the current document. More...
 
PostListnext (double w_min)
 Move to the next document. More...
 
PostListskip_to (Xapian::docid desired_did, double w_min)
 Skip to next document with docid >= docid. More...
 
bool at_end () const
 Return true if and only if we're off the end of the list. More...
 
Xapian::termcount get_wdf_upper_bound () const
 
std::string get_description () const
 Get a description of the document. More...
 
- Public Member Functions inherited from LeafPostList
 ~LeafPostList ()
 
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)
 
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...
 
double get_maxweight () const
 Return an upper bound on what get_weight() can return. More...
 
double get_weight () const
 Return the weight contribution for the current position. More...
 
double recalc_maxweight ()
 Recalculate the upper bound on what get_weight() can return. 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...
 
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...
 
void set_term (const std::string &term_)
 Set the term name. 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 Internalcheck (Xapian::docid did, double w_min, bool &valid)
 Check if the specified docid occurs in this postlist. More...
 
Internalnext ()
 Advance the current position to the next document in the postlist. More...
 
Internalskip_to (Xapian::docid did)
 Skip forward to the specified docid. More...
 
- Public Member Functions inherited from Xapian::Internal::intrusive_base
 intrusive_base ()
 Construct with no references. More...
 

Private Member Functions

void operator= (const GlassAllDocsPostList &)
 Don't allow assignment. More...
 
 GlassAllDocsPostList (const GlassAllDocsPostList &)
 Don't allow copying. More...
 

Private Attributes

Xapian::doccount doccount
 The number of documents in the database. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from GlassPostList
static void read_number_of_entries (const char **posptr, const char *end, Xapian::doccount *number_of_entries_ptr, Xapian::termcount *collection_freq_ptr)
 Read the number of entries and the collection frequency. More...
 
- Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Member Functions inherited from LeafPostList
 LeafPostList (const std::string &term_)
 Only constructable as a base class for derived classes. More...
 
- Protected Member Functions inherited from Xapian::PostingIterator::Internal
 Internal ()
 Only constructable as a base class for derived classes. More...
 
- Protected Attributes inherited from LeafPostList
const Xapian::Weightweight
 
bool need_doclength
 
bool need_unique_terms
 
std::string term
 The term name for this postlist (empty for an alldocs postlist). More...
 

Detailed Description

Definition at line 29 of file glass_alldocspostlist.h.

Constructor & Destructor Documentation

◆ GlassAllDocsPostList() [1/2]

GlassAllDocsPostList::GlassAllDocsPostList ( const GlassAllDocsPostList )
private

Don't allow copying.

◆ GlassAllDocsPostList() [2/2]

GlassAllDocsPostList::GlassAllDocsPostList ( Xapian::Internal::intrusive_ptr< const GlassDatabase db_,
Xapian::doccount  doccount_ 
)

Member Function Documentation

◆ get_description()

string GlassAllDocsPostList::get_description ( ) const
virtual

Return a string description of this object.

Implements Xapian::PostingIterator::Internal.

Definition at line 81 of file glass_alldocspostlist.cc.

References doccount, and Xapian::Internal::str().

◆ get_doclength()

Xapian::termcount GlassAllDocsPostList::get_doclength ( ) const
virtual

Return the length of current document.

Implements Xapian::PostingIterator::Internal.

Definition at line 51 of file glass_alldocspostlist.cc.

References GlassPostList::get_wdf(), LOGCALL, and RETURN.

◆ get_termfreq()

Xapian::doccount GlassAllDocsPostList::get_termfreq ( ) const
virtual

Return the exact term frequency.

Leaf postlists have an exact termfreq, which get_termfreq_min(), get_termfreq_max(), and get_termfreq_est() all report.

Implements LeafPostList.

Definition at line 44 of file glass_alldocspostlist.cc.

References doccount, LOGCALL, and RETURN.

◆ get_wdf()

Xapian::termcount GlassAllDocsPostList::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 59 of file glass_alldocspostlist.cc.

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

◆ open_position_list()

PositionList * GlassAllDocsPostList::open_position_list ( ) const
virtual

Read the position list for the term in the current document and return a pointer to it (not owned by the PostList).

The default implementation throws Xapian::UnimplementedError.

Reimplemented from Xapian::PostingIterator::Internal.

Definition at line 74 of file glass_alldocspostlist.cc.

References LOGCALL.

◆ operator=()

void GlassAllDocsPostList::operator= ( const GlassAllDocsPostList )
private

Don't allow assignment.

◆ read_position_list()

PositionList * GlassAllDocsPostList::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 67 of file glass_alldocspostlist.cc.

References LOGCALL.

Member Data Documentation

◆ doccount

Xapian::doccount GlassAllDocsPostList::doccount
private

The number of documents in the database.

Definition at line 37 of file glass_alldocspostlist.h.

Referenced by get_description(), and get_termfreq().


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