Import Upstream version 0.4.0~beta1

1 files changed, 61 insertions, 0 deletions

diff --git a/src/de/lmu/ifi/dbs/elki/distance/distancefunction/IndexBasedDistanceFunction.java b/src/de/lmu/ifi/dbs/elki/distance/distancefunction/IndexBasedDistanceFunction.java
new file mode 100644
index 00000000..e32cd357
--- /dev/null
+++ b/src/de/lmu/ifi/dbs/elki/distance/distancefunction/IndexBasedDistanceFunction.java
@@ -0,0 +1,61 @@
+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) 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 de.lmu.ifi.dbs.elki.database.query.distance.DistanceQuery;
+import de.lmu.ifi.dbs.elki.distance.distancevalue.Distance;
+import de.lmu.ifi.dbs.elki.index.Index;
+import de.lmu.ifi.dbs.elki.utilities.optionhandling.OptionID;
+
+/**
+ * Distance function relying on an index (such as preprocessed neighborhoods).
+ * 
+ * @author Erich Schubert
+ * 
+ * @apiviz.landmark
+ * @apiviz.stereotype factory
+ * @apiviz.has Instance oneway - - «create»
+ */
+public interface IndexBasedDistanceFunction<O, D extends Distance<D>> extends DistanceFunction<O, D> {
+  /**
+   * OptionID for the index parameter
+   */
+  public static final OptionID INDEX_ID = OptionID.getOrCreateOptionID("distancefunction.index", "Distance index to use.");
+
+  /**
+   * Instance interface for Index based distance functions.
+   * 
+   * @author Erich Schubert
+   * 
+   * @param <T> Object type
+   * @param <D> Distance type
+   */
+  public static interface Instance<T, I extends Index, D extends Distance<D>> extends DistanceQuery<T, D> {
+    /**
+     * Get the index used.
+     * 
+     * @return the index used
+     */
+    public I getIndex();
+  }
+}
\ No newline at end of file