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
|
package de.lmu.ifi.dbs.elki.distance.distancefunction;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2013
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 de.lmu.ifi.dbs.elki.data.NumberVector;
import de.lmu.ifi.dbs.elki.data.spatial.SpatialComparable;
import de.lmu.ifi.dbs.elki.data.type.SimpleTypeInformation;
import de.lmu.ifi.dbs.elki.data.type.TypeUtil;
import de.lmu.ifi.dbs.elki.distance.distancevalue.DoubleDistance;
/**
* Abstract base class for the most common family of distance functions: defined
* on number vectors and returning double values.
*
* @author Erich Schubert
*
* @apiviz.landmark
* @apiviz.excludeSubtypes
* @apiviz.uses NumberVector
* @apiviz.has DoubleDistance
*/
public abstract class AbstractVectorDoubleDistanceFunction extends AbstractPrimitiveDistanceFunction<NumberVector<?>, DoubleDistance> implements PrimitiveDoubleDistanceFunction<NumberVector<?>>, NumberVectorDistanceFunction<DoubleDistance> {
/**
* Constructor.
*/
public AbstractVectorDoubleDistanceFunction() {
super();
}
@Override
public SimpleTypeInformation<? super NumberVector<?>> getInputTypeRestriction() {
return TypeUtil.NUMBER_VECTOR_FIELD;
}
@Override
public final DoubleDistance distance(NumberVector<?> o1, NumberVector<?> o2) {
return new DoubleDistance(doubleDistance(o1, o2));
}
@Override
public DoubleDistance getDistanceFactory() {
return DoubleDistance.FACTORY;
}
/**
* Get the common dimensionality of the two objects. Throw an
* {@link IllegalArgumentException} otherwise.
*
* @param o1 First vector / MBR
* @param o2 Second vector / MBR
* @return Common dimensionality
* @throws IllegalArgumentException when dimensionalities are not the same.
*/
public static final int dimensionality(SpatialComparable o1, SpatialComparable o2) {
final int dim1 = o1.getDimensionality(), dim2 = o2.getDimensionality();
if (dim1 != dim2) {
throw new IllegalArgumentException("Objects do not have the same dimensionality.");
}
return dim1;
}
/**
* Get the common dimensionality of the two objects. Throw an
* {@link IllegalArgumentException} otherwise.
*
* @param o1 First vector / MBR
* @param o2 Second vector / MBR
* @param expect Expected dimensionality
* @return Common dimensionality
* @throws IllegalArgumentException when dimensionalities are not the same.
*/
public static final int dimensionality(SpatialComparable o1, SpatialComparable o2, int expect) {
final int dim1 = o1.getDimensionality(), dim2 = o2.getDimensionality();
if (dim1 != dim2 || dim1 != expect) {
throw new IllegalArgumentException("Objects do not have the expected dimensionality of " + expect);
}
return expect;
}
/**
* Get the common dimensionality of the two objects. Throw an
* {@link IllegalArgumentException} otherwise.
*
* @param o1 First vector / MBR
* @param o2 Second vector / MBR
* @return Common dimensionality
* @throws IllegalArgumentException when dimensionalities are not the same.
*/
public static final int dimensionality(NumberVector<?> o1, NumberVector<?> o2) {
final int dim1 = o1.getDimensionality(), dim2 = o2.getDimensionality();
if (dim1 != dim2) {
throw new IllegalArgumentException("Objects do not have the same dimensionality.");
}
return dim1;
}
/**
* Get the common dimensionality of the two objects. Throw an
* {@link IllegalArgumentException} otherwise.
*
* @param o1 First vector / MBR
* @param o2 Second vector / MBR
* @param expect Expected dimensionality
* @return Common dimensionality
* @throws IllegalArgumentException when dimensionalities are not the same.
*/
public static final int dimensionality(NumberVector<?> o1, NumberVector<?> o2, int expect) {
final int dim1 = o1.getDimensionality(), dim2 = o2.getDimensionality();
if (dim1 != dim2 || dim1 != expect) {
throw new IllegalArgumentException("Objects do not have the expected dimensionality of " + expect);
}
return expect;
}
}
|
