/*
* Copyright (c) 2016 Martin Davis.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v. 1.0 which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
*
* http://www.eclipse.org/org/documents/edl-v10.php.
*/
package org.locationtech.jts.index.strtree;
/**
* A function method which computes the distance
* between two {@link ItemBoundable}s in an {@link STRtree}.
* Used for Nearest Neighbour searches.
*
* @author Martin Davis
*
*/
public interface ItemDistance
{
/**
* Computes the distance between two items.
*
* @param item1
* @param item2
* @return the distance between the items
*
* @throws IllegalArgumentException if the metric is not applicable to the arguments
*/
double distance(ItemBoundable item1, ItemBoundable item2);
}