blob: 93874eaf83d9ffde9dd8b96a61a6a6c37c5c349e (
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
|
package de.lmu.ifi.dbs.elki.distance.distancefunction.external;
/*
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.io.InputStream;
import de.lmu.ifi.dbs.elki.distance.distancevalue.Distance;
import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID;
/**
* A DistanceParser shall provide a DistanceParsingResult by parsing an InputStream.
*
* @author Arthur Zimek
*
* @apiviz.uses DistanceParsingResult oneway - - «create»
*
* @param <D> distance type
*/
public interface DistanceParser<D extends Distance<D>> {
/**
* Parameter for distance function.
*/
public static final OptionID DISTANCE_ID = OptionID.getOrCreateOptionID("parser.distance", "Distance type used for parsing values.");
/**
* Returns a list of the objects parsed from the specified input stream
* and a list of the labels associated with the objects.
*
* @param in the stream to parse objects from
* @return a list containing those objects parsed
* from the input stream and their associated labels.
*/
DistanceParsingResult<D> parse(InputStream in);
}
|