blob: 3e5e86afd38c48e30683e6d5f1b5b4120409e0ae (
plain)
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
|
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.util.regex.Pattern;
/**
* An abstract distance implements equals conveniently for any extending class.
* At the same time any extending class is to implement hashCode properly.
*
* 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
* @param <D> the (final) type of Distance used
*/
public abstract class AbstractDistance<D extends AbstractDistance<D>> implements Distance<D> {
/**
* Indicates an infinity pattern.
*/
public static final String INFINITY_PATTERN = "inf";
/**
* Pattern for parsing and validating double values
*/
public static final Pattern DOUBLE_PATTERN = Pattern.compile("(\\d+|\\d*\\.\\d+)?([eE][-]?\\d+)?");
/**
* Pattern for parsing and validating integer values
*/
public static final Pattern INTEGER_PATTERN = Pattern.compile("\\d+");
/**
* Any extending class should implement a proper hashCode method.
*/
@Override
public abstract int hashCode();
/**
* Returns true if <code>this == o</code> has the value <code>true</code> or o
* is not null and o is of the same class as this instance and
* <code>this.compareTo(o)</code> is 0, false otherwise.
*/
@SuppressWarnings("unchecked")
@Override
public boolean equals(Object o) {
if(this == o) {
return true;
}
if(o == null || getClass() != o.getClass()) {
return false;
}
return this.compareTo((D) o) == 0;
}
/**
* Get the pattern accepted by this distance
*
* @return Pattern
*/
abstract public Pattern getPattern();
@Override
public final String requiredInputPattern() {
return getPattern().pattern();
}
/**
* Test a string value against the input pattern.
*
* @param value String value to test
* @return Match result
*/
public final boolean testInputPattern(String value) {
return getPattern().matcher(value).matches();
}
@Override
public boolean isInfiniteDistance() {
return this.equals(infiniteDistance());
}
@Override
public boolean isNullDistance() {
return this.equals(nullDistance());
}
@Override
public boolean isUndefinedDistance() {
return this.equals(undefinedDistance());
}
}
|
