xapian-core  2.0.0
Public Member Functions | Private Member Functions | 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::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_, std::string_view term, bool keep_reference)
 Default constructor. More...
 
 ~GlassPostList ()
 Destructor. More...
 
bool open_nearby_postlist (std::string_view term_, bool need_read_pos, LeafPostList *&pl) const
 Open another postlist from the same database. More...
 
bool jump_to (Xapian::docid desired_did)
 Used for looking up doclens. More...
 
Xapian::docid get_docid () const
 Returns the current docid. 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
 
void get_docid_range (Xapian::docid &first, Xapian::docid &last) const
 Get the bounds on the range of docids this PostList can return. More...
 
std::string get_description () const
 Get a description of the document. 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...
 
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 PostListcheck (Xapian::docid did, double w_min, bool &valid)
 Check if the specified docid occurs in this postlist. More...
 
PostListnext ()
 Advance the current position to the next document in the postlist. More...
 
PostListskip_to (Xapian::docid did)
 Skip forward to the specified docid. More...
 

Private Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from GlassPostList
static void read_freqs (const char **posptr, const char *end, Xapian::doccount *number_of_entries_ptr, Xapian::termcount *collection_freq_ptr)
 Read the term frequency and collection frequency. More...
 
- 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::Weightweight = 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 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 
)

Definition at line 35 of file glass_alldocspostlist.cc.

Member Function Documentation

◆ get_description()

string GlassAllDocsPostList::get_description ( ) const
virtual

Return a string description of this object.

Implements Xapian::Internal::PostList.

Definition at line 69 of file glass_alldocspostlist.cc.

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

◆ 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::Internal::PostList.

Definition at line 47 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::Internal::PostList.

Definition at line 62 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::Internal::PostList.

Definition at line 55 of file glass_alldocspostlist.cc.

References LOGCALL.


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