blob: d53c9e2620b911ea72bf597d247fab0e6daaf1c7 (
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
|
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) 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.data.type.TypeInformation;
import de.lmu.ifi.dbs.elki.database.query.distance.DistanceQuery;
import de.lmu.ifi.dbs.elki.database.relation.Relation;
/**
* Base interface for any kind of distances.
*
* @author Erich Schubert
*
* @param <O> Object type
*
* @apiviz.landmark
*
* @apiviz.has TypeInformation
*/
public interface DistanceFunction<O> {
/**
* Is this function symmetric?
*
* @return {@code true} when symmetric
*/
boolean isSymmetric();
/**
* Is this distance function metric (in particular, does it satisfy the
* triangle equation?)
*
* @return {@code true} when metric.
*/
boolean isMetric();
/**
* Get the input data type of the function.
*
* @return Type restriction
*/
TypeInformation getInputTypeRestriction();
/**
* Instantiate with a database to get the actual distance query.
*
* @param relation The representation to use
* @return Actual distance query.
*/
public <T extends O> DistanceQuery<T> instantiate(Relation<T> relation);
}
|
