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

Loading...
Searching...
No Matches
TopDocs.h
Go to the documentation of this file.
1
2// 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_CLASS
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
Lucene::Collection
Utility template class to handle collections that can be safely copied and shared.
Definition Collection.h:17
Lucene::LuceneObject::LuceneObject
LuceneObject()
Lucene::TopDocs::TopDocs
TopDocs(int32_t totalHits, Collection< ScoreDocPtr > scoreDocs)
Constructs a TopDocs with a default maxScore = double.NaN.
Lucene::TopDocs::setMaxScore
void setMaxScore(double maxScore)
Sets the maximum score value encountered.
Lucene::TopDocs::getMaxScore
double getMaxScore()
Returns the maximum score value encountered. Note that in case scores are not tracked,...
Lucene::TopDocs::totalHits
int32_t totalHits
The total number of hits for the query.
Definition TopDocs.h:30
Lucene::TopDocs::scoreDocs
Collection< ScoreDocPtr > scoreDocs
The top hits for the query.
Definition TopDocs.h:33
Lucene::TopDocs::~TopDocs
virtual ~TopDocs()
Lucene::TopDocs::maxScore
double maxScore
Stores the maximum score value encountered, needed for normalizing.
Definition TopDocs.h:36
Lucene::TopDocs::TopDocs
TopDocs(int32_t totalHits, Collection< ScoreDocPtr > scoreDocs, double maxScore)
Constructs a TopDocs.
Lucene
Definition AbstractAllTermDocs.h:12

clucene.sourceforge.net