Module org.jhotdraw8.graph

Package org.jhotdraw8.graph.path.algo

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

java.lang.Object

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

Type Parameters:

V - the vertex data type

C - the cost number type

All Implemented Interfaces:

VertexPathSearchAlgo<V,C>

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

Builder for creating unique paths from a directed graph.

The builder searches for unique paths using a breadth-first search.
Returns only a path if it is unique or if there is only one hop from start to goal.

Author:

Werner Randelshofer

Constructor Summary

Constructors

Constructor	Description
UniqueOrOneHopVertexPathSearchAlgo()

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>> nextVerticesFunction, 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.
@Nullable VertexBackLinkWithCost<V,C>	search(@NonNull Iterable<V> startVertices, @NonNull Predicate<V> goalPredicate, @NonNull Function<V,Iterable<V>> nextVerticesFunction, @NonNull AddToSet<V> visited, int maxDepth, @NonNull C zero, @NonNull BiFunction<V,V,C> costFunction, @NonNull BiFunction<C,C,C> sumFunction)	Search engine method.

Methods inherited from class java.lang.Object

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

Constructor Details

UniqueOrOneHopVertexPathSearchAlgo

public UniqueOrOneHopVertexPathSearchAlgo()

Method Details

search

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

Description copied from interface: VertexPathSearchAlgo

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

nextVerticesFunction - the next vertices function

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

zero - the zero cost value

costLimit - the algorithm-specific cost limit

sumFunction - the sum function for adding two cost values

visited - the visited function

Returns:

on success: a back link, otherwise: null

search

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

Search engine method.

Parameters:

startVertices - the set of start vertices

goalPredicate - the goal predicate

nextVerticesFunction - the next arcs function

visited - the set of visited vertices (see AddToSet)

zero - the zero cost value

costFunction - the cost function

sumFunction - the sum function for adding two cost values

Returns:

on success: a back link, otherwise: null