strus  0.17
Classes | Public Member Functions | List of all members
strus::PostingJoinOperatorInterface Class Referenceabstract

Interface for creating iterators on joined sets of postings. More...

#include <postingJoinOperatorInterface.hpp>

Classes

struct  Description
 Structure that describes the join operator. More...
 

Public Member Functions

virtual ~PostingJoinOperatorInterface ()
 Destructor. More...
 
virtual PostingIteratorInterfacecreateResultIterator (const std::vector< Reference< PostingIteratorInterface > > &argitrs, int range, unsigned int cardinality) const =0
 Create an iterator on the join operator result (set of postings) More...
 
virtual Description getDescription () const =0
 Get a description of the function for user help and introspection. More...
 

Detailed Description

Interface for creating iterators on joined sets of postings.

Constructor & Destructor Documentation

virtual strus::PostingJoinOperatorInterface::~PostingJoinOperatorInterface ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual PostingIteratorInterface* strus::PostingJoinOperatorInterface::createResultIterator ( const std::vector< Reference< PostingIteratorInterface > > &  argitrs,
int  range,
unsigned int  cardinality 
) const
pure virtual

Create an iterator on the join operator result (set of postings)

Parameters
[in]argitrsargument posting iterators of the join operation
[in]rangerange of the operation
[in]cardinalityrequired size of matching results (e.g. minimum number of elements of any input subset selection that builds a result) (0 for default)
Returns
the iterator on the resulting set of postings
virtual Description strus::PostingJoinOperatorInterface::getDescription ( ) const
pure virtual

Get a description of the function for user help and introspection.

Returns
the description structure

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