xapian-core  2.0.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
GlassSpellingTermList Class Reference

The list of words containing a particular trigram. More...

#include <glass_spelling.h>

+ Inheritance diagram for GlassSpellingTermList:
+ Collaboration diagram for GlassSpellingTermList:

Public Member Functions

 GlassSpellingTermList (const std::string &data_)
 Constructor. More...
 
Xapian::termcount get_approx_size () const
 Return approximate size of this termlist. More...
 
Xapian::termcount get_wdf () const
 Return the wdf for the term at the current position. More...
 
Xapian::doccount get_termfreq () const
 Return the term frequency for the term at the current position. More...
 
TermListnext ()
 Advance the current position to the next term in the termlist. More...
 
TermListskip_to (std::string_view term)
 Skip forward to the specified term. More...
 
Xapian::termcount positionlist_count () const
 Return the length of the position list for the current position. More...
 
PositionListpositionlist_begin () const
 Return PositionList for the current position. More...
 
- Public Member Functions inherited from Xapian::TermIterator::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 void accumulate_stats (Xapian::Internal::ExpandStats &stats) const
 Collate weighting information for the current term. More...
 
const std::string & get_termname () const
 Return the termname at the current position. More...
 
virtual const Xapian::VecCOW< Xapian::termpos > * get_vec_termpos () const
 Get pointer to VecCOW<termpos> if that's the internal representation. More...
 
- Public Member Functions inherited from Xapian::Internal::intrusive_base
 intrusive_base ()
 Construct with no references. More...
 

Private Member Functions

 GlassSpellingTermList (const GlassSpellingTermList &)
 Copying is not allowed. More...
 
void operator= (const GlassSpellingTermList &)
 Assignment is not allowed. More...
 

Private Attributes

std::string data
 The encoded data. More...
 
unsigned p
 Position in the data. More...
 

Additional Inherited Members

- Public Attributes inherited from Xapian::TermIterator::Internal
size_t shard_index = 0
 Which shard of a multidatabase this is from. More...
 
- Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Member Functions inherited from Xapian::TermIterator::Internal
 Internal ()
 Only constructable as a base class for derived classes. More...
 
- Protected Attributes inherited from Xapian::TermIterator::Internal
std::string current_term
 The current term. More...
 

Detailed Description

The list of words containing a particular trigram.

Definition at line 146 of file glass_spelling.h.

Constructor & Destructor Documentation

◆ GlassSpellingTermList() [1/2]

GlassSpellingTermList::GlassSpellingTermList ( const GlassSpellingTermList )
private

Copying is not allowed.

◆ GlassSpellingTermList() [2/2]

GlassSpellingTermList::GlassSpellingTermList ( const std::string &  data_)
inlineexplicit

Constructor.

Definition at line 161 of file glass_spelling.h.

Member Function Documentation

◆ get_approx_size()

Xapian::termcount GlassSpellingTermList::get_approx_size ( ) const
virtual

Return approximate size of this termlist.

Implements Xapian::TermIterator::Internal.

Definition at line 382 of file glass_spelling.cc.

◆ get_termfreq()

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

Return the term frequency for the term at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 396 of file glass_spelling.cc.

◆ get_wdf()

Xapian::termcount GlassSpellingTermList::get_wdf ( ) const
virtual

Return the wdf for the term at the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 390 of file glass_spelling.cc.

◆ next()

TermList * GlassSpellingTermList::next ( )
virtual

Advance the current position to the next term in the termlist.

The list starts before the first term in the list, so next(), skip_to() or check() must be called before any methods which need the context of the current position.

Returns
Normally returns NULL to indicate success. If the end has been reached, returns this; if another 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::TermIterator::Internal.

Definition at line 402 of file glass_spelling.cc.

References MAGIC_XOR_VALUE, and p.

Referenced by skip_to().

◆ operator=()

void GlassSpellingTermList::operator= ( const GlassSpellingTermList )
private

Assignment is not allowed.

◆ positionlist_begin()

PositionList * GlassSpellingTermList::positionlist_begin ( ) const
virtual

Return PositionList for the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 436 of file glass_spelling.cc.

◆ positionlist_count()

Xapian::termcount GlassSpellingTermList::positionlist_count ( ) const
virtual

Return the length of the position list for the current position.

Implements Xapian::TermIterator::Internal.

Definition at line 430 of file glass_spelling.cc.

◆ skip_to()

TermList * GlassSpellingTermList::skip_to ( std::string_view  term)
virtual

Skip forward to the specified term.

If the specified term isn't in the list, position ourselves on the first term after term.

Returns
Normally returns NULL to indicate success. If no terms after term exist, returns this; if another 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::TermIterator::Internal.

Definition at line 420 of file glass_spelling.cc.

References next(), and term.

Member Data Documentation

◆ data

std::string GlassSpellingTermList::data
private

The encoded data.

Definition at line 148 of file glass_spelling.h.

◆ p

unsigned GlassSpellingTermList::p
private

Position in the data.

Definition at line 151 of file glass_spelling.h.


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