CLucene - a full-featured, c++ search engine
API Documentation


lucene::search::TopDocs Class Reference

Expert: Returned by low-level search implementations. More...

#include <SearchHeader.h>


Public Member Functions

 TopDocs (const int32_t th, ScoreDoc *sds, int32_t scoreDocsLength)
 Expert: Constructs a TopDocs.
 ~TopDocs ()

Data Fields

int32_t totalHits
 Expert: The total number of hits for the query.
ScoreDocscoreDocs
 Expert: The top hits for the query.
int32_t scoreDocsLength


Detailed Description

Expert: Returned by low-level search implementations.

See also:
Searcher::search(Query,Filter,int32_t)

Constructor & Destructor Documentation

lucene::search::TopDocs::TopDocs ( const int32_t  th,
ScoreDoc sds,
int32_t  scoreDocsLength 
)

Expert: Constructs a TopDocs.

TopDocs takes ownership of the ScoreDoc array

lucene::search::TopDocs::~TopDocs (  ) 


Field Documentation

Expert: The total number of hits for the query.

See also:
Hits::length()

Expert: The top hits for the query.


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

clucene.sourceforge.net