strus  0.17
forwardIteratorInterface.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 Patrick P. Frey
3  *
4  * This Source Code Form is subject to the terms of the Mozilla Public
5  * License, v. 2.0. If a copy of the MPL was not distributed with this
6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
7  */
10 #ifndef _STRUS_FORWARD_INDEX_ITERATOR_INTERFACE_HPP_INCLUDED
11 #define _STRUS_FORWARD_INDEX_ITERATOR_INTERFACE_HPP_INCLUDED
12 #include "strus/index.hpp"
13 #include <string>
14 
15 namespace strus
16 {
17 
20 {
21 public:
24 
27  virtual void skipDoc( const Index& docno)=0;
28 
32  virtual Index skipPos( const Index& firstpos)=0;
33 
36  virtual std::string fetch()=0;
37 };
38 
39 }//namespace
40 #endif
41 
42 
int32_t Index
Number type generally used for locally counted indices.
Definition: index.hpp:29
virtual ~ForwardIteratorInterface()
Destructor.
Definition: forwardIteratorInterface.hpp:23
Numeric types used for local and global indices.
virtual void skipDoc(const Index &docno)=0
Define the document of the items inspected.
virtual std::string fetch()=0
Fetch the item at the current position.
virtual Index skipPos(const Index &firstpos)=0
Return the next matching position higher than or equal to firstpos in the current document...
Iterator on the forward index mapping occurrencies to the terms inserted.
Definition: forwardIteratorInterface.hpp:19