summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/datasource/parser/DistanceParser.java
diff options
context:
space:
mode:
authorAndrej Shadura <andrewsh@debian.org>2019-03-09 22:30:28 +0000
committerAndrej Shadura <andrewsh@debian.org>2019-03-09 22:30:28 +0000
commitcde76aeb42240f7270bc6605c606ae07d2dc5a7d (patch)
treec3ebf1d7745224f524da31dbabc5d76b9ea75916 /src/de/lmu/ifi/dbs/elki/datasource/parser/DistanceParser.java
Import Upstream version 0.4.0~beta1
Diffstat (limited to 'src/de/lmu/ifi/dbs/elki/datasource/parser/DistanceParser.java')
-rw-r--r--src/de/lmu/ifi/dbs/elki/datasource/parser/DistanceParser.java48
1 files changed, 48 insertions, 0 deletions
diff --git a/src/de/lmu/ifi/dbs/elki/datasource/parser/DistanceParser.java b/src/de/lmu/ifi/dbs/elki/datasource/parser/DistanceParser.java
new file mode 100644
index 00000000..f9b403d6
--- /dev/null
+++ b/src/de/lmu/ifi/dbs/elki/datasource/parser/DistanceParser.java
@@ -0,0 +1,48 @@
+package de.lmu.ifi.dbs.elki.datasource.parser;
+/*
+This file is part of ELKI:
+Environment for Developing KDD-Applications Supported by Index-Structures
+
+Copyright (C) 2011
+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;
+
+/**
+ * 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>> {
+ /**
+ * 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);
+}