org.kynosarges.tektosyne.graph

Class FloodFill<T>

java.lang.Object

org.kynosarges.tektosyne.graph.FloodFill<T>

Type Parameters:

T - the type of all nodes in the Graph

public class FloodFill<T>
extends java.lang.Object

Provides a flood fill algorithm for Graph instances. Starts on a specified starting node, and recursively finds any adjacent nodes that match the conditions defined by a specified Predicate.

Field Summary

Fields

Modifier and Type	Field and Description
Graph<T>	graph The Graph on which all searches are performed.

Constructor Summary

Constructors

Constructor and Description
FloodFill(Graph<T> graph) Creates a FloodFill algorithm for the specified Graph.

Method Summary

Modifier and Type	Method and Description
boolean	findMatching(java.util.function.Predicate<T> match, T source) Finds all contiguous graph nodes that match the specified conditions, starting from the specified source node.
java.util.List<T>	nodes() Gets all graph nodes that were reached by the last successful search.

Methods inherited from class java.lang.Object

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

Field Detail

graph

public final Graph<T> graph

The Graph on which all searches are performed.

Constructor Detail

FloodFill

public FloodFill(Graph<T> graph)

Creates a FloodFill algorithm for the specified Graph.

Parameters:

graph - the Graph on which all searches are performed

Throws:

java.lang.NullPointerException - if graph is null

Method Detail

findMatching

public boolean findMatching(java.util.function.Predicate<T> match,
                            T source)

Finds all contiguous graph nodes that match the specified conditions, starting from the specified source node. Returns false if graph does not contain source, or if there are no contiguous nodes for which match succeeds. Otherwise, returns true and sets nodes() to the result of the flood fill.

Parameters:

match - the Predicate to test against each graph node

source - the source node within graph where the search starts

Returns:

true if one or more graph nodes that pass match could be reached from the specified source, else false

Throws:

java.lang.NullPointerException - if match or source is null

nodes

public java.util.List<T> nodes()

Gets all graph nodes that were reached by the last successful search. Returns an empty collection if the last findMatching(java.util.function.Predicate<T>, T) call returned false, or if the method has not yet been called.

Returns:

an unmodifiable List containing all graph nodes that were reached by the last successful findMatching(java.util.function.Predicate<T>, T) call, not including the source node