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


CustomScoreProvider.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 CUSTOMSCOREPROVIDER_H
8 #define CUSTOMSCOREPROVIDER_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
21 class LPPAPI CustomScoreProvider : public LuceneObject {
22 public:
25 
27 
29 
30 protected:
32 
33 public:
52  virtual double customScore(int32_t doc, double subQueryScore, Collection<double> valSrcScores);
53 
71  virtual double customScore(int32_t doc, double subQueryScore, double valSrcScore);
72 
80  virtual ExplanationPtr customExplain(int32_t doc, const ExplanationPtr& subQueryExpl, Collection<ExplanationPtr> valSrcExpls);
81 
88  virtual ExplanationPtr customExplain(int32_t doc, const ExplanationPtr& subQueryExpl, const ExplanationPtr& valSrcExpl);
89 };
90 
91 }
92 
93 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
An instance of this subclass should be returned by CustomScoreQuery#getCustomScoreProvider,...
Definition: CustomScoreProvider.h:21
virtual double customScore(int32_t doc, double subQueryScore, double valSrcScore)
Compute a custom score by the subQuery score and the ValueSourceQuery score.
virtual ExplanationPtr customExplain(int32_t doc, const ExplanationPtr &subQueryExpl, Collection< ExplanationPtr > valSrcExpls)
Explain the custom score. Whenever overriding customScore(int32_t, double, Collection<double>),...
CustomScoreProvider(const IndexReaderPtr &reader)
Creates a new instance of the provider class for the given IndexReader.
IndexReaderPtr reader
Definition: CustomScoreProvider.h:28
virtual ExplanationPtr customExplain(int32_t doc, const ExplanationPtr &subQueryExpl, const ExplanationPtr &valSrcExpl)
Explain the custom score. Whenever overriding customScore(int32_t, double, double),...
virtual double customScore(int32_t doc, double subQueryScore, Collection< double > valSrcScores)
Compute a custom score by the subQuery score and a number of ValueSourceQuery scores.
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Definition: AbstractAllTermDocs.h:12
boost::shared_ptr< Explanation > ExplanationPtr
Definition: LuceneTypes.h:333
boost::shared_ptr< IndexReader > IndexReaderPtr
Definition: LuceneTypes.h:157

clucene.sourceforge.net