strus::ForwardIteratorInterface Class Reference

Iterator on the forward index mapping occurrencies to the terms inserted. More...

#include <forwardIteratorInterface.hpp>

Public Member Functions
virtual	~ForwardIteratorInterface ()
	Destructor. More...
virtual void	skipDoc (const Index &docno)=0
	Define the document of the items inspected. More...
virtual Index	skipPos (const Index &firstpos)=0
	Return the next matching position higher than or equal to firstpos in the current document. The current document is the one returned with the last 'skipDoc( const Index&)' call. More...
virtual std::string	fetch ()=0
	Fetch the item at the current position. More...

Detailed Description

Iterator on the forward index mapping occurrencies to the terms inserted.

Constructor & Destructor Documentation

virtual strus::ForwardIteratorInterface::~ForwardIteratorInterface ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual std::string strus::ForwardIteratorInterface::fetch ( )

pure virtual

Fetch the item at the current position.

Returns

the element string

virtual void strus::ForwardIteratorInterface::skipDoc ( const Index &  docno )

pure virtual

Define the document of the items inspected.

Parameters

[in]

docno

document number to seek

virtual Index strus::ForwardIteratorInterface::skipPos ( const Index &  firstpos )

pure virtual

Return the next matching position higher than or equal to firstpos in the current document. The current document is the one returned with the last 'skipDoc( const Index&)' call.

Parameters

[in]

firstpos

minimum position to seek

Returns

the matching upper bound position found

---

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

• /home/patrick/Projects/github/strus/include/strus/forwardIteratorInterface.hpp