Xpace
Xpace::Index::Iter Class Reference

index term iterator More...

#include <index.h>

Public Member Functions

String getTerm (uint64 *count=0) const
 
RefListCursor getRefList () const
 
RefListCursor getRefList (const Iter &end) const
 
bool operator! () const
 
bool move (int64 delta, bool relative=true)
 
int64 diff (const Iter &rhs) const
 the distance between two iterators More...
 
uint64 getPos () const
 

Friends

class Index
 
class RLC_Index
 

Detailed Description

index term iterator

Definition at line 130 of file index.h.

Member Function Documentation

String Xpace::Index::Iter::getTerm ( uint64 count = 0) const
Return values
thecount of docs containing the term (if index has counts)
Returns
a string representation (from a Collator) of this index term
RefListCursor Xpace::Index::Iter::getRefList ( ) const
Returns
the list of references for this index term
RefListCursor Xpace::Index::Iter::getRefList ( const Iter end) const
Returns
the list of all references for all index terms in the interval [*this, end)
Parameters
(onepast) the end of the interval
bool Xpace::Index::Iter::operator! ( ) const
Returns
true if the iterator is past the end of the index's term list
bool Xpace::Index::Iter::move ( int64  delta,
bool  relative = true 
)
Parameters
deltamove the iterator this far in the index list
relativeif true move from current position, else move from start
Returns
true if move successful, false (and don't move) if not
int64 Xpace::Index::Iter::diff ( const Iter rhs) const

the distance between two iterators

Parameters
rhsthe other iterator
Returns
the distance
uint64 Xpace::Index::Iter::getPos ( ) const
Returns
the position of the iterator

Friends And Related Function Documentation

friend class Index
friend

Definition at line 175 of file index.h.

friend class RLC_Index
friend

Definition at line 176 of file index.h.


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

current as of Wed Jun 10 2026 12:00:06