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
|
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) 2014
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.type.TypeInformation;
import de.lmu.ifi.dbs.elki.database.query.distance.AbstractDatabaseDistanceQuery;
import de.lmu.ifi.dbs.elki.database.relation.Relation;
import de.lmu.ifi.dbs.elki.index.Index;
import de.lmu.ifi.dbs.elki.index.IndexFactory;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizer;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization.Parameterization;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.ObjectParameter;
/**
* Abstract super class for distance functions needing a database index.
*
* @author Elke Achtert
*
* @apiviz.has AbstractIndexBasedDistanceFunction.Instance
* @apiviz.composedOf IndexFactory
* @apiviz.excludeSubtypes
*
* @param <O> the type of object to compute the distances in between
* @param <I> the type of Index used
*/
public abstract class AbstractIndexBasedDistanceFunction<O, I extends Index> extends AbstractDatabaseDistanceFunction<O> implements IndexBasedDistanceFunction<O> {
/**
* Parameter to specify the preprocessor to be used.
* <p>
* Key: {@code -distancefunction.preprocessor}
* </p>
*/
protected IndexFactory<O, I> indexFactory;
/**
* Constructor.
*
* @param indexFactory Index factory
*/
public AbstractIndexBasedDistanceFunction(IndexFactory<O, I> indexFactory) {
super();
this.indexFactory = indexFactory;
}
@Override
public boolean isMetric() {
return false;
}
@Override
public boolean isSymmetric() {
return true;
}
@Override
final public TypeInformation getInputTypeRestriction() {
return indexFactory.getInputTypeRestriction();
}
/**
* The actual instance bound to a particular database.
*
* @author Erich Schubert
*
* @param <O> Object type
* @param <I> Index type
* @param <F> Distance function type
*/
abstract public static class Instance<O, I extends Index, F extends DistanceFunction<? super O>> extends AbstractDatabaseDistanceQuery<O> implements IndexBasedDistanceFunction.Instance<O, I> {
/**
* Index we use
*/
protected final I index;
/**
* Our parent distance function
*/
protected F parent;
/**
* Constructor.
*
* @param database Database
* @param index Index to use
* @param parent Parent distance function
*/
public Instance(Relation<O> database, I index, F parent) {
super(database);
this.index = index;
this.parent = parent;
}
@Override
public I getIndex() {
return index;
}
@Override
public F getDistanceFunction() {
return parent;
}
}
/**
* Parameterization class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*
* @param <F> Factory type
*/
public abstract static class Parameterizer<F extends IndexFactory<?, ?>> extends AbstractParameterizer {
/**
* The index factory we use.
*/
protected F factory;
/**
* Index factory parameter
*
* @param config Parameterization
* @param restriction Restriction class
* @param defaultClass Default value
*/
public void configIndexFactory(Parameterization config, Class<?> restriction, Class<?> defaultClass) {
ObjectParameter<F> param = new ObjectParameter<>(INDEX_ID, restriction, defaultClass);
if(config.grab(param)) {
factory = param.instantiateClass(config);
}
}
}
}
|
