package de.lmu.ifi.dbs.elki.database.query.distance;
/*
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 .
*/
import de.lmu.ifi.dbs.elki.database.ids.DBID;
import de.lmu.ifi.dbs.elki.database.query.DatabaseQuery;
import de.lmu.ifi.dbs.elki.database.relation.Relation;
import de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction;
import de.lmu.ifi.dbs.elki.distance.distancevalue.Distance;
/**
* A distance query serves as adapter layer for database and primitive distances.
*
* @author Erich Schubert
*
* @apiviz.landmark
* @apiviz.has Distance
*
* @param O Input object type
* @param D Distance result type
*/
public interface DistanceQuery> extends DatabaseQuery {
/**
* Returns the distance between the two objects specified by their object ids.
*
* @param id1 first object id
* @param id2 second object id
* @return the distance between the two objects specified by their object ids
*/
D distance(DBID id1, DBID id2);
/**
* Returns the distance between the two objects specified by their object ids.
*
* @param o1 first object
* @param id2 second object id
* @return the distance between the two objects specified by their object ids
*/
D distance(O o1, DBID id2);
/**
* Returns the distance between the two objects specified by their object ids.
*
* @param id1 first object id
* @param o2 second object
* @return the distance between the two objects specified by their object ids
*/
D distance(DBID id1, O o2);
/**
* Returns the distance between the two objects specified by their object ids.
*
* @param o1 first object
* @param o2 second object
* @return the distance between the two objects specified by their object ids
*/
D distance(O o1, O o2);
/**
* Method to get the distance functions factory.
*
* @return Factory for distance objects
*/
D getDistanceFactory();
/**
* Get the inner distance function.
*
* @return Distance function
*/
DistanceFunction super O, D> getDistanceFunction();
/**
* Provides an infinite distance.
*
* @return an infinite distance
*/
D infiniteDistance();
/**
* Provides a null distance.
*
* @return a null distance
*/
D nullDistance();
/**
* Provides an undefined distance.
*
* @return an undefined distance
*/
D undefinedDistance();
/**
* Access the underlying data query.
*
* @return data query in use
*/
Relation extends O> getRelation();
}