Package com.luciad.network.function
Interface ILcdDistanceFunction<N,E>
 All Known Implementing Classes:
ALcdNodeDistanceFunction
public interface ILcdDistanceFunction<N,E>
A
ILcdDistanceFunction
calculates distances between two given nodes. This distance
can be of all kinds: it can be an exact distance, or an estimate, an Euclidean distance or a time
cost, ... Since:
 5.1

Method Summary
Modifier and TypeMethodDescriptiondouble
computeDistance
(ILcdGraph<N, E> aGraph, ILcdRoute<N, E> aPrecedingRoute, ILcdRoute<N, E> aSucceedingRoute, TLcdTraversalDirection aTraversalDirection) Returns the distance between the end node ofaPrecedingRoute
and the start node ofaSucceedingRoute
.int
getOrder()
Returns the order of this function.

Method Details

computeDistance
double computeDistance(ILcdGraph<N, E> aGraph, ILcdRoute<N, E> aPrecedingRoute, ILcdRoute<N, E> aSucceedingRoute, TLcdTraversalDirection aTraversalDirection) Returns the distance between the end node ofaPrecedingRoute
and the start node ofaSucceedingRoute
. Parameters:
aPrecedingRoute
 the route whose end node is the first of the two nodes between which a distance is to be calculated. Only the lastn
edges of this route will have an influence on the result, wheren
is equal to the order of this distance function. The route should be completely contained in the given graph, otherwise the correct behavior of this method is not guaranteed.aSucceedingRoute
 the route whose start node is the second of the two nodes between which a distance is to be calculated. Only the firstn
edges of this route will have an influence on the result, wheren
is equal to the order of this distance function. The route should be completely contained in the given graph, otherwise the correct behavior of this method is not guaranteed.aTraversalDirection
 indicating whether the traversal direction should be forward or backward. IfBACKWARD
, the given routes will be traversed in opposite direction, and the preceding route becomes thus the succeeding route and vice versa. Returns:
 a
double
indicating the distance between the end node ofaPrecedingRoute
and the start node ofaSucceedingRoute
.

getOrder
int getOrder()Returns the order of this function. The order of a distance function is the maximum number of edges preceding the start node or succeeding the end node, that are taken into account when calculating a distance.E.g. a simple cartesian distance function has order 0, because it doesn't use any other information than the distance between the endpoint of the preceding route and the start node of the succeeding route. Other, more complex functions can have a higher order.
 Returns:
 the order of this function.
