strus::DocumentTermIteratorInterface Class Reference

Structure that allows to iterate on document term occurrencies. More...

#include <documentTermIteratorInterface.hpp>

Classes
struct	Term

Public Member Functions
virtual	~DocumentTermIteratorInterface ()
	Destructor. More...
virtual Index	skipDoc (const Index &docno)=0
	Skip to the next document. More...
virtual bool	nextTerm (Term &value)=0
	Get the next term. More...
virtual unsigned int	termDocumentFrequency (const Index &termno) const =0
	Get the local document frequency of a term. More...
virtual std::string	termValue (const Index &termno) const =0
	Get string representation of a term. More...

Detailed Description

Structure that allows to iterate on document term occurrencies.

Constructor & Destructor Documentation

virtual strus::DocumentTermIteratorInterface::~DocumentTermIteratorInterface ( )

inlinevirtual

Destructor.

Member Function Documentation

virtual bool strus::DocumentTermIteratorInterface::nextTerm ( Term &  value )

pure virtual

Get the next term.

Parameters

[out]

value

the next term fetched, if exists

Note

terms are not ordered

Returns

true, if exists

virtual Index strus::DocumentTermIteratorInterface::skipDoc ( const Index &  docno )

pure virtual

Skip to the next document.

Parameters

[in]

docno

document number to seek

Returns

least upper bound of the document number seeked

virtual unsigned int strus::DocumentTermIteratorInterface::termDocumentFrequency ( const Index &  termno ) const

pure virtual

Get the local document frequency of a term.

Parameters

[in]

termno

internal local term number

Returns

the local document frequency (aka 'df')

virtual std::string strus::DocumentTermIteratorInterface::termValue ( const Index &  termno ) const

pure virtual

Get string representation of a term.

Parameters

[in]

termno

internal local term number

Returns

the term string

---

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

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