Module org.jhotdraw8.graph

Package org.jhotdraw8.graph.path.algo

Class AnyIndexedVertexPathSearchAlgo<C extends Number & Comparable<C>>

java.lang.Object

org.jhotdraw8.graph.path.algo.AnyIndexedVertexPathSearchAlgo<C>

Type Parameters:

C - the cost number type

All Implemented Interfaces:

IndexedVertexPathSearchAlgo<C>

public class AnyIndexedVertexPathSearchAlgo<C extends Number & Comparable<C>>
extends Object
implements IndexedVertexPathSearchAlgo<C>

See AnyArcPathSearchAlgo for a description of this algorithm.

This implementation is optimized for IndexedDirectedGraph.

Constructor Summary

Constructors

Constructor	Description
AnyIndexedVertexPathSearchAlgo()

Method Summary

Modifier and Type	Method	Description
@Nullable IndexedVertexBackLinkWithCost<C>	search(@NonNull Iterable<Integer> startVertices, @NonNull IntPredicate goalPredicate, @NonNull Function<Integer,Spliterator.OfInt> nextVerticesFunction, int maxDepth, @NonNull C zero, @NonNull C costLimit, @NonNull BiFunction<Integer,Integer,C> costFunction, @NonNull BiFunction<C,C,C> sumFunction, @NonNull AddToIntSet visited)	Search engine method.
@Nullable IndexedVertexBackLink	search(@NonNull Iterable<Integer> startVertices, @NonNull IntPredicate goalPredicate, @NonNull Function<Integer,Spliterator.OfInt> nextVerticesFunction, @NonNull AddToIntSet visited, int maxDepth)	Search engine method.

Methods inherited from class java.lang.Object

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

Constructor Details

AnyIndexedVertexPathSearchAlgo

public AnyIndexedVertexPathSearchAlgo()

Method Details

search

public @Nullable IndexedVertexBackLinkWithCost<C> search(@NonNull Iterable<Integer> startVertices,
 @NonNull IntPredicate goalPredicate,
 @NonNull Function<Integer,Spliterator.OfInt> nextVerticesFunction,
 int maxDepth,
 @NonNull C zero,
 @NonNull C costLimit,
 @NonNull BiFunction<Integer,Integer,C> costFunction,
 @NonNull BiFunction<C,C,C> sumFunction,
 @NonNull AddToIntSet visited)

Search engine method.

Specified by:

search in interface IndexedVertexPathSearchAlgo<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 cost limit is ignored

costFunction - the cost function

sumFunction - the sum function for adding two cost values

visited -

Returns:

search

public @Nullable IndexedVertexBackLink search(@NonNull Iterable<Integer> startVertices,
 @NonNull IntPredicate goalPredicate,
 @NonNull Function<Integer,Spliterator.OfInt> nextVerticesFunction,
 @NonNull AddToIntSet visited,
 int maxDepth)

Search engine method.

Parameters:

startVertices - the set of start vertices

goalPredicate - the goal predicate

nextVerticesFunction - the next vertices function

visited - the set of visited vertices (see AddToIntSet)

maxDepth - the maximal depth (inclusive) of the search.

Returns: