scoring.h revision 9ee90955287d616158ad4cf099c4772f58c16942 
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 bool forceCommit) const = 0;
32    virtual bool getMostProbableString(const DicTraverseSession *const traverseSession,
33            const int terminalSize, const float languageWeight, int *const outputCodePoints,
34            int *const type, int *const freq) const = 0;
35    virtual void safetyNetForMostProbableString(const int terminalSize,
36            const int maxScore, int *const outputCodePoints, int *const frequencies) const = 0;
37    // TODO: Make more generic
38    virtual void searchWordWithDoubleLetter(DicNode *terminals, const int terminalSize,
39            int *doubleLetterTerminalIndex, DoubleLetterLevel *doubleLetterLevel) const = 0;
40    virtual float getAdjustedLanguageWeight(DicTraverseSession *const traverseSession,
41            DicNode *const terminals, const int size) const = 0;
42    virtual float getDoubleLetterDemotionDistanceCost(const int terminalIndex,
43            const int doubleLetterTerminalIndex,
44            const DoubleLetterLevel doubleLetterLevel) const = 0;
45    virtual bool doesAutoCorrectValidWord() const = 0;
46    virtual bool autoCorrectsToMultiWordSuggestionIfTop() const = 0;
47    virtual bool sameAsTyped(const DicTraverseSession *const traverseSession,
48            const DicNode *const dicNode) const = 0;
49
50 protected:
51    Scoring() {}
52    virtual ~Scoring() {}
53
54 private:
55    DISALLOW_COPY_AND_ASSIGN(Scoring);
56};
57} // namespace latinime
58#endif // LATINIME_SCORING_H
59