Module org.jhotdraw8.graph

Package org.jhotdraw8.graph.path.algo

Class UniqueShortestVertexPathSearchAlgo<V,C extends Number & Comparable<C>>

java.lang.Object

org.jhotdraw8.graph.path.algo.UniqueShortestVertexPathSearchAlgo<V,C>

Type Parameters:

V - the vertex data type

C - the cost number type

All Implemented Interfaces:

VertexPathSearchAlgo<V,C>

public class UniqueShortestVertexPathSearchAlgo<V,C extends Number & Comparable<C>>
extends Object
implements VertexPathSearchAlgo<V,C>

See UniqueShortestArcPathSearchAlgo for a description of this algorithm.

Constructor Summary

Constructors

Constructor	Description
UniqueShortestVertexPathSearchAlgo()

Method Summary

Modifier and Type	Method	Description
@Nullable VertexBackLinkWithCost<V,C>	search(@NonNull Iterable<V> startVertices, @NonNull Predicate<V> goalPredicate, @NonNull Function<V,Iterable<V>> nextVertices, int maxDepth, @NonNull C zero, @NonNull C costLimit, @NonNull BiFunction<V,V,C> costFunction, @NonNull BiFunction<C,C,C> sumFunction, @NonNull AddToSet<V> visited)	Search engine method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UniqueShortestVertexPathSearchAlgo

public UniqueShortestVertexPathSearchAlgo()

Method Details

search

public @Nullable VertexBackLinkWithCost<V,C> search(@NonNull Iterable<V> startVertices,
 @NonNull Predicate<V> goalPredicate,
 @NonNull Function<V,Iterable<V>> nextVertices,
 int maxDepth,
 @NonNull C zero,
 @NonNull C costLimit,
 @NonNull BiFunction<V,V,C> costFunction,
 @NonNull BiFunction<C,C,C> sumFunction,
 @NonNull AddToSet<V> visited)

Search engine method.

Specified by:

search in interface VertexPathSearchAlgo<V,C extends Number & Comparable<C>>

Parameters:

startVertices - the set of start vertices

goalPredicate - the goal predicate

nextVertices - the next vertices function

maxDepth - the maximal depth (inclusive) of the search Must be >= 0.

zero - the zero cost value

costLimit - the maximal cost (inclusive) of a path. Must be >= zero.

costFunction - the cost function
The cost must be > 0 if the graph has cycles.
The cost must be >= 0 if the graph is acyclic.

sumFunction - the sum function for adding two cost values

visited -

Returns:

on success: a back link, otherwise: null