ch.awae.utils.pathfinding

Interface GraphDataProvider<T>

public interface GraphDataProvider<T>

Method Summary

Modifier and Type	Method and Description
double	getDistance(T from, T to) Provides the distance between two vertices.
default double	getHeuristicDistance(T from, T to) Provides a heuristic distance between two vertices.
java.lang.Iterable<T>	getNeighbours(T vertex) Looks up and provides the vertices directly reachable from the given vertex.
default GraphDataProvider<T>	withDistance(Function2<T,T,java.lang.Double> distance) Replaces the distance function with a custom function.
default GraphDataProvider<T>	withHeuristic(Function2<T,T,java.lang.Double> heuristic) Replaces the distance heuristic with a custom function.

Method Detail

getNeighbours

java.lang.Iterable<T> getNeighbours(T vertex)

Looks up and provides the vertices directly reachable from the given vertex.

getDistance

double getDistance(T from,
                   T to)

Provides the distance between two vertices. If they are neighbours, this must provide the exact distance. Otherwise a heuristic distance is acceptable as well.

Parameters:

from -

to -

Returns:

getHeuristicDistance

default double getHeuristicDistance(T from,
                                    T to)

Provides a heuristic distance between two vertices. By default this forwards to getDistance(Object, Object).

withHeuristic

default GraphDataProvider<T> withHeuristic(Function2<T,T,java.lang.Double> heuristic)

Replaces the distance heuristic with a custom function.

withDistance

default GraphDataProvider<T> withDistance(Function2<T,T,java.lang.Double> distance)

Replaces the distance function with a custom function.