de.lmu.ifi.dbs.elki.distance.distancefunction.NumberVectorDistanceFunction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elki Show documentation

ELKI - Main Module – Open-Source Data-Mining Framework with Index Acceleration

There is a newer version: 0.7.5

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 .
 */

import de.lmu.ifi.dbs.elki.data.NumberVector;

/**
 * Base interface for the common case of distance functions defined on numerical
 * vectors.
 *
 * @author Erich Schubert
 * @since 0.4.0
 *
 * @apiviz.landmark
 *
 * @param  vector type, usually NumberVector or a parent type
 */
public interface NumberVectorDistanceFunction extends PrimitiveDistanceFunction {
  /**
   * Computes the distance between two given vectors according to this distance
   * function.
   *
   * @param o1 first DatabaseObject
   * @param o2 second DatabaseObject
   * @return the distance between two given vectors according to this distance
   *         function
   */
  double distance(NumberVector o1, NumberVector o2);
}