blob: 066252638c9f3656c73ffdff39c797b0239571d5 (
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
|
package de.lmu.ifi.dbs.elki.algorithm;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
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.distance.distancefunction.PrimitiveDistanceFunction;
import de.lmu.ifi.dbs.elki.distance.distancefunction.minkowski.EuclideanDistanceFunction;
import de.lmu.ifi.dbs.elki.result.Result;
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 base class for distance-based algorithms that need to work with
* synthetic objects such as mean vectors.
*
* This class only allows distances that are defined on arbitrary objects, not
* only database objects!
*
* @author Arthur Zimek
*
* @apiviz.has PrimitiveDistanceFunction
* @apiviz.excludeSubtypes
*
* @param <O> the type of objects handled by this Algorithm
* @param <R> the type of result to retrieve from this Algorithm
*/
public abstract class AbstractPrimitiveDistanceBasedAlgorithm<O, R extends Result> extends AbstractAlgorithm<R> {
/**
* Holds the instance of the distance function specified by
* {@link DistanceBasedAlgorithm#DISTANCE_FUNCTION_ID}.
*/
protected PrimitiveDistanceFunction<? super O> distanceFunction;
/**
* Constructor.
*
* @param distanceFunction Distance function
*/
protected AbstractPrimitiveDistanceBasedAlgorithm(PrimitiveDistanceFunction<? super O> distanceFunction) {
super();
this.distanceFunction = distanceFunction;
}
/**
* Returns the distanceFunction.
*
* @return the distanceFunction
*/
public PrimitiveDistanceFunction<? super O> getDistanceFunction() {
return distanceFunction;
}
/**
* Parameterization helper class.
*
* @author Erich Schubert
*
* @apiviz.exclude
*/
public abstract static class Parameterizer<O> extends AbstractParameterizer {
/**
* Distance function to use.
*/
protected PrimitiveDistanceFunction<O> distanceFunction;
@Override
protected void makeOptions(Parameterization config) {
super.makeOptions(config);
ObjectParameter<PrimitiveDistanceFunction<O>> distanceFunctionP = makeParameterDistanceFunction(EuclideanDistanceFunction.class, PrimitiveDistanceFunction.class);
if(config.grab(distanceFunctionP)) {
distanceFunction = distanceFunctionP.instantiateClass(config);
}
}
}
}
|
