1 files changed, 87 insertions, 0 deletions
diff --git a/src/de/lmu/ifi/dbs/elki/database/ids/KNNList.java b/src/de/lmu/ifi/dbs/elki/database/ids/KNNList.java
new file mode 100644
index 00000000..6d3dc778
--- /dev/null
+++ b/src/de/lmu/ifi/dbs/elki/database/ids/KNNList.java
@@ -0,0 +1,87 @@
+package de.lmu.ifi.dbs.elki.database.ids;
+
+
+/*
+ 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/>.
+ */
+
+
+/**
+ * Interface for kNN results.
+ * 
+ * To iterate over the results, use the following code:
+ * 
+ * <pre>
+ * {@code
+ * for (DistanceDBIDResultIter<D> iter = result.iter(); iter.valid(); iter.advance()) {
+ *   // You can get the distance via: iter.getDistance();
+ *   // Or use iter just like any other DBIDRef
+ * }
+ * }
+ * </pre>
+ * 
+ * If you are only interested in the IDs of the objects, the following is also
+ * sufficient:
+ * 
+ * <pre>
+ * {@code
+ * for (DBIDIter<D> iter = result.iter(); iter.valid(); iter.advance()) {
+ *   // Use iter just like any other DBIDRef
+ * }
+ * }
+ * </pre>
+ * 
+ * @author Erich Schubert
+ * 
+ * @apiviz.landmark
+ * 
+ * @apiviz.composedOf DoubleDBIDPair
+ */
+public interface KNNList extends DoubleDBIDList {
+  /**
+   * Size
+   */
+  @Override
+  public int size();
+
+  /**
+   * Get the K parameter (note: this may be less than the size of the list!)
+   * 
+   * @return K
+   */
+  public int getK();
+
+  /**
+   * Direct object access.
+   * 
+   * @param index
+   */
+  @Override
+  public DoubleDBIDPair get(int index);
+
+  /**
+   * Get the distance to the k nearest neighbor, or maxdist otherwise.
+   * 
+   * @return Maximum distance
+   */
+  public double getKNNDistance();
+}
+\ No newline at end of file