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

AveragePayloadFunction.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 AVERAGEPAYLOADFUNCTION_H
8 #define AVERAGEPAYLOADFUNCTION_H
9
10 #include "PayloadFunction.h"
11
12 namespace Lucene {
13
17 class LPPAPI AveragePayloadFunction : public PayloadFunction {
18 public:
19 virtual ~AveragePayloadFunction();
20 LUCENE_CLASS(AveragePayloadFunction);
21
22 public:
23 virtual double currentScore(int32_t docId, const String& field, int32_t start, int32_t end, int32_t numPayloadsSeen,
24 double currentScore, double currentPayloadScore);
25 virtual double docScore(int32_t docId, const String& field, int32_t numPayloadsSeen, double payloadScore);
26 virtual int32_t hashCode();
27 virtual bool equals(const LuceneObjectPtr& other);
28 };
29
30 }
31
32 #endif
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
PayloadFunction.h
Lucene::AveragePayloadFunction
Calculate the final score as the average score of all payloads seen.
Definition: AveragePayloadFunction.h:17
Lucene::AveragePayloadFunction::equals
virtual bool equals(const LuceneObjectPtr &other)
Return whether two objects are equal.
Lucene::AveragePayloadFunction::currentScore
virtual double currentScore(int32_t docId, const String &field, int32_t start, int32_t end, int32_t numPayloadsSeen, double currentScore, double currentPayloadScore)
Calculate the score up to this point for this doc and field.
Lucene::AveragePayloadFunction::docScore
virtual double docScore(int32_t docId, const String &field, int32_t numPayloadsSeen, double payloadScore)
Calculate the final score for all the payloads seen so far for this doc/field.
Lucene::AveragePayloadFunction::hashCode
virtual int32_t hashCode()
Return hash code for this object.
Lucene::AveragePayloadFunction::~AveragePayloadFunction
virtual ~AveragePayloadFunction()
Lucene::PayloadFunction
An abstract class that defines a way for Payload*Query instances to transform the cumulative effects ...
Definition: PayloadFunction.h:18
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::LuceneObjectPtr
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition: LuceneTypes.h:539

clucene.sourceforge.net