1 /*
2  * Copyright (C) 2013 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef LATINIME_SCORING_H
18 #define LATINIME_SCORING_H
19 
20 #include "defines.h"
21 
22 namespace latinime {
23 
24 class DicNode;
25 class DicTraverseSession;
26 class SuggestionResults;
27 
28 // This class basically tweaks suggestions and distances apart from CompoundDistance
29 class Scoring {
30  public:
31     virtual int calculateFinalScore(const float compoundDistance, const int inputSize,
32             const ErrorTypeUtils::ErrorType containedErrorTypes, const bool forceCommit,
33             const bool boostExactMatches, const bool hasProbabilityZero) const = 0;
34     virtual void getMostProbableString(const DicTraverseSession *const traverseSession,
35             const float weightOfLangModelVsSpatialModel,
36             SuggestionResults *const outSuggestionResults) const = 0;
37     virtual float getAdjustedWeightOfLangModelVsSpatialModel(
38             DicTraverseSession *const traverseSession, DicNode *const terminals,
39             const int size) const = 0;
40     virtual float getDoubleLetterDemotionDistanceCost(
41             const DicNode *const terminalDicNode) const = 0;
42     virtual bool autoCorrectsToMultiWordSuggestionIfTop() const = 0;
43     virtual bool sameAsTyped(const DicTraverseSession *const traverseSession,
44             const DicNode *const dicNode) const = 0;
45 
46  protected:
Scoring()47     Scoring() {}
~Scoring()48     virtual ~Scoring() {}
49 
50  private:
51     DISALLOW_COPY_AND_ASSIGN(Scoring);
52 };
53 } // namespace latinime
54 #endif // LATINIME_SCORING_H
55