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
|
package de.lmu.ifi.dbs.elki.distance.distancevalue;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2012
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import java.io.Externalizable;
/**
* The interface Distance defines the requirements of any instance class.
*
* See {@link de.lmu.ifi.dbs.elki.distance.DistanceUtil} for related utility
* functions such as <code>min</code>, <code>max</code>.
*
* @author Arthur Zimek
*
* @see de.lmu.ifi.dbs.elki.distance.DistanceUtil
*
* @apiviz.landmark
*
* @param <D> the type of Distance used
*/
public interface Distance<D extends Distance<D>> extends Comparable<D>, Externalizable {
/**
* Returns a new distance as sum of this distance and the given distance.
*
* @param distance the distance to be added to this distance
* @return a new distance as sum of this distance and the given distance
*/
D plus(D distance);
/**
* Returns a new Distance by subtracting the given distance from this
* distance.
*
* @param distance the distance to be subtracted from this distance
* @return a new Distance by subtracting the given distance from this distance
*/
D minus(D distance);
/**
* Any implementing class should implement a proper toString-method for
* printing the result-values.
*
* @return String a human-readable representation of the Distance
*/
@Override
String toString();
/**
* Provides a measurement suitable to this measurement function based on the
* given pattern.
*
* @param pattern a pattern defining a similarity suitable to this measurement
* function
* @return a measurement suitable to this measurement function based on the
* given pattern
* @throws IllegalArgumentException if the given pattern is not compatible
* with the requirements of this measurement function
*/
D parseString(String pattern) throws IllegalArgumentException;
/**
* Returns a String as description of the required input format.
*
* @return a String as description of the required input format
*/
String requiredInputPattern();
/**
* Returns the number of Bytes this distance uses if it is written to an
* external file.
*
* @return the number of Bytes this distance uses if it is written to an
* external file
*/
int externalizableSize();
/**
* Provides an infinite distance.
*
* @return an infinite distance
*/
D infiniteDistance();
/**
* Provides a null distance.
*
* @return a null distance
*/
D nullDistance();
/**
* Provides an undefined distance.
*
* @return an undefined distance
*/
D undefinedDistance();
/**
* Returns true, if the distance is an infinite distance, false otherwise.
*
* @return true, if the distance is an infinite distance, false otherwise
*/
boolean isInfiniteDistance();
/**
* Returns true, if the distance is a null distance, false otherwise.
*
* @return true, if the distance is a null distance, false otherwise
*/
boolean isNullDistance();
/**
* Returns true, if the distance is an undefined distance, false otherwise.
*
* @return true, if the distance is an undefined distance, false otherwise
*/
boolean isUndefinedDistance();
}
|
