strus  0.17
Public Member Functions | List of all members
strus::ResultDocument Class Reference

Structure defining one result element of a strus query. More...

#include <resultDocument.hpp>

Inheritance diagram for strus::ResultDocument:
strus::WeightedDocument

Public Member Functions

 ResultDocument ()
 Default constructor. More...
 
 ResultDocument (const ResultDocument &o)
 Copy constructor. More...
 
 ResultDocument (const WeightedDocument &o, const std::vector< SummaryElement > &summaryElements_)
 Constructor from a composition of the pure query evaluation result and the summary elements. More...
 
 ResultDocument (const WeightedDocument &o)
 Constructor from a composition of the pure query evaluation result without summary elements. More...
 
 ResultDocument (const Index &docno_, double weight_, const std::vector< SummaryElement > &summaryElements_)
 Constructor from a composition its basic parts. More...
 
const std::vector
< SummaryElement > & 
summaryElements () const
 Get the list of summary elements of this result. More...
 
- Public Member Functions inherited from strus::WeightedDocument
 WeightedDocument ()
 Default constructor. More...
 
 WeightedDocument (const WeightedDocument &o)
 Copy constructor. More...
 
 WeightedDocument (const Index &docno_, double weight_)
 Constructor. More...
 
Index docno () const
 Get the document number of the result. More...
 
double weight () const
 Get the accumulated weight of the ranking of the result. More...
 
bool operator< (const WeightedDocument &o) const
 Comparison for sorting. More...
 
bool operator> (const WeightedDocument &o) const
 Comparison for sorting. More...
 

Detailed Description

Structure defining one result element of a strus query.

Constructor & Destructor Documentation

strus::ResultDocument::ResultDocument ( )
inline

Default constructor.

strus::ResultDocument::ResultDocument ( const ResultDocument o)
inline

Copy constructor.

strus::ResultDocument::ResultDocument ( const WeightedDocument o,
const std::vector< SummaryElement > &  summaryElements_ 
)
inline

Constructor from a composition of the pure query evaluation result and the summary elements.

strus::ResultDocument::ResultDocument ( const WeightedDocument o)
inline

Constructor from a composition of the pure query evaluation result without summary elements.

strus::ResultDocument::ResultDocument ( const Index docno_,
double  weight_,
const std::vector< SummaryElement > &  summaryElements_ 
)
inline

Constructor from a composition its basic parts.

Member Function Documentation

const std::vector<SummaryElement>& strus::ResultDocument::summaryElements ( ) const
inline

Get the list of summary elements of this result.


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