[go: up one dir, main page]

File: Metrics.h

package info (click to toggle)
timbl 6.10-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,088 kB
  • sloc: cpp: 17,211; ansic: 425; sh: 70; makefile: 63
file content (192 lines) | stat: -rw-r--r-- 5,929 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
  Copyright (c) 1998 - 2024
  ILK   - Tilburg University
  CLST  - Radboud University
  CLiPS - University of Antwerp

  This file is part of timbl

  timbl is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or
  (at your option) any later version.

  timbl is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, see <http://www.gnu.org/licenses/>.

  For questions and suggestions, see:
      https://github.com/LanguageMachines/timbl/issues
  or send mail to:
      lamasoftware (at ) science.ru.nl

*/

#ifndef TIMBL_METRICS_H
#define TIMBL_METRICS_H

#include <exception>
#include <limits>

namespace Timbl{

  class FeatureValue;

  class metricClass {
  public:
    explicit metricClass( MetricType m ): _type(m){};
    virtual ~metricClass() {};
    MetricType type() const { return _type; };
    virtual bool isSimilarityMetric() const = 0;
    virtual bool isNumerical() const = 0;
    virtual bool isStorable() const = 0;
    virtual double distance( const FeatureValue *,
			     const FeatureValue *,
			     size_t=1, double = 1.0 ) const = 0;
    virtual double get_max_similarity() const {
      throw std::logic_error( "get_max_similarity not implemented for " +
			      TiCC::toString( _type ) );
    }
  private:
    MetricType _type;
  };

  metricClass *getMetricClass( MetricType );

  class distanceMetricClass: public metricClass {
  public:
    explicit distanceMetricClass( MetricType m ): metricClass(m){};
    virtual ~distanceMetricClass() override {};
    bool isSimilarityMetric() const override { return false; };
  };

  class OverlapMetric: public distanceMetricClass {
  public:
  OverlapMetric(): distanceMetricClass( Overlap ){};
    bool isNumerical() const override { return false; };
    bool isStorable() const override { return false; };
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
  };

  class NumericMetricClass: public distanceMetricClass {
  public:
    explicit NumericMetricClass( MetricType m ): distanceMetricClass( m ){};
    virtual ~NumericMetricClass() override {};
    bool isNumerical() const override { return true; };
    bool isStorable() const override { return false; };
  };

  class NumericMetric: public NumericMetricClass {
  public:
  NumericMetric(): NumericMetricClass( Numeric ){};
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
  };

  class EuclideanMetric: public NumericMetricClass {
  public:
  EuclideanMetric(): NumericMetricClass( Euclidean ){};
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
  };

  class ValueDiffMetric: public distanceMetricClass {
  public:
  ValueDiffMetric(): distanceMetricClass( ValueDiff ){};
    bool isNumerical() const override { return false; };
    bool isStorable() const override { return true; };
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
  };

  class DiceMetric: public distanceMetricClass {
  public:
  DiceMetric(): distanceMetricClass( Dice ){};
    bool isNumerical() const override { return false; };
    bool isStorable() const override { return true; };
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
  };

  class JeffreyMetric: public distanceMetricClass {
  public:
  JeffreyMetric(): distanceMetricClass( JeffreyDiv ){};
    bool isNumerical() const override{ return false; };
    bool isStorable() const override { return true; };
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
  };

  class JSMetric: public distanceMetricClass {
  public:
  JSMetric(): distanceMetricClass( JSDiv ){};
    bool isNumerical() const override { return false; };
    bool isStorable() const override { return true; };
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
  };

  class LevenshteinMetric: public distanceMetricClass {
  public:
  LevenshteinMetric(): distanceMetricClass( Levenshtein ){};
    bool isNumerical() const override { return false; };
    bool isStorable() const override { return true; };
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
  };

  class similarityMetricClass: public metricClass {
  public:
    explicit similarityMetricClass( MetricType m ): metricClass( m ){};
    virtual ~similarityMetricClass() override {};
    bool isSimilarityMetric() const override { return true; };
    bool isNumerical() const override { return true; };
    bool isStorable() const override { return false; };
  };

  class CosineMetric: public similarityMetricClass {
  public:
  CosineMetric(): similarityMetricClass( Cosine ){};
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
    double get_max_similarity() const override { return 1.0; };
  };

  class DotProductMetric: public similarityMetricClass {
  public:
  DotProductMetric(): similarityMetricClass( DotProduct ){};
    double distance( const FeatureValue *,
		     const FeatureValue *,
		     size_t,
		     double ) const override;
    double get_max_similarity() const override {
      return std::numeric_limits<int>::max();
    };
  };

}

#endif // TIMBL_METRICS_H