scoring.h revision a000a32c8094d0dec453b0cebf748a089b0ad39a 
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
22namespace latinime {
23
24class DicNode;
25class DicTraverseSession;
26
27// This class basically tweaks suggestions and distances apart from CompoundDistance
28class Scoring {
29 public:
30    virtual int calculateFinalScore(const float compoundDistance, const int inputSize,
31            const ErrorTypeUtils::ErrorType containedErrorTypes, const bool forceCommit,
32            const bool boostExactMatches) const = 0;
33    virtual bool getMostProbableString(const DicTraverseSession *const traverseSession,
34            const int terminalSize, const float languageWeight, int *const outputCodePoints,
35            int *const type, int *const freq) const = 0;
36    virtual void safetyNetForMostProbableString(const int scoreCount,
37            const int maxScore, int *const outputCodePoints, int *const scores) const = 0;
38    virtual float getAdjustedLanguageWeight(DicTraverseSession *const traverseSession,
39            DicNode *const terminals, const int size) const = 0;
40    virtual float getDoubleLetterDemotionDistanceCost(
41            const DicNode *const terminalDicNode) const = 0;
42    virtual bool doesAutoCorrectValidWord() const = 0;
43    virtual bool autoCorrectsToMultiWordSuggestionIfTop() const = 0;
44    virtual bool sameAsTyped(const DicTraverseSession *const traverseSession,
45            const DicNode *const dicNode) const = 0;
46
47 protected:
48    Scoring() {}
49    virtual ~Scoring() {}
50
51 private:
52    DISALLOW_COPY_AND_ASSIGN(Scoring);
53};
54} // namespace latinime
55#endif // LATINIME_SCORING_H
56