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

TopDocs.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3 // Distributable under the terms of either the Apache License (Version 2.0)
4 // or the GNU Lesser General Public License.
6
7 #ifndef TOPDOCS_H
8 #define TOPDOCS_H
9
10 #include "LuceneObject.h"
11
12 namespace Lucene {
13
16 class LPPAPI TopDocs : public LuceneObject {
17 public:
19 TopDocs(int32_t totalHits, Collection<ScoreDocPtr> scoreDocs);
20
22 TopDocs(int32_t totalHits, Collection<ScoreDocPtr> scoreDocs, double maxScore);
23
24 virtual ~TopDocs();
25
26 LUCENE_CLASS(TopDocs);
27
28 public:
30 int32_t totalHits;
31
33 Collection<ScoreDocPtr> scoreDocs;
34
36 double maxScore;
37
38 public:
41 double getMaxScore();
42
44 void setMaxScore(double maxScore);
45 };
46
47 }
48
49 #endif
LuceneObject.h
Lucene::TopDocs::maxScore
double maxScore
Stores the maximum score value encountered, needed for normalizing.
Definition: TopDocs.h:36
Lucene::TopDocs
Represents hits returned by Searcher#search(QueryPtr, FilterPtr, int32_t) and Searcher#search(QueryPt...
Definition: TopDocs.h:16
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::TopDocs::totalHits
int32_t totalHits
The total number of hits for the query.
Definition: TopDocs.h:26
Lucene::Collection< ScoreDocPtr >
Lucene::TopDocs::scoreDocs
Collection< ScoreDocPtr > scoreDocs
The top hits for the query.
Definition: TopDocs.h:33

clucene.sourceforge.net