org.onlab.graph

Class AbstractGraphPathSearch<V extends Vertex,E extends Edge<V>>

java.lang.Object

org.onlab.graph.AbstractGraphPathSearch<V,E>

Type Parameters:

V - vertex type

E - edge type

All Implemented Interfaces:

GraphPathSearch<V,E>

Direct Known Subclasses:

BellmanFordGraphSearch, BreadthFirstSearch, DepthFirstSearch, DijkstraGraphSearch, KShortestPathsSearch, SrlgGraphSearch

public abstract class AbstractGraphPathSearch<V extends Vertex,E extends Edge<V>>
extends java.lang.Object
implements GraphPathSearch<V,E>

Basis for various graph path search algorithm implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractGraphPathSearch.DefaultResult Default path search result that uses the DefaultPath to convey paths in a graph.

Nested classes/interfaces inherited from interface org.onlab.graph.GraphPathSearch

GraphPathSearch.Result<V extends Vertex,E extends Edge<V>>

Field Summary

Fields inherited from interface org.onlab.graph.GraphPathSearch

ALL_PATHS

Constructor Summary

Constructors

Constructor and Description
AbstractGraphPathSearch()

Method Summary

Modifier and Type	Method and Description
protected void	checkArguments(Graph<V,E> graph, V src, V dst) Checks the specified path search arguments for validity.
protected abstract GraphPathSearch.Result<V,E>	internalSearch(Graph<V,E> graph, V src, V dst, EdgeWeigher<V,E> weigher, int maxPaths)
GraphPathSearch.Result<V,E>	search(Graph<V,E> graph, V src, V dst, EdgeWeigher<V,E> weigher, int maxPaths) Searches the specified graph for paths between vertices.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGraphPathSearch

public AbstractGraphPathSearch()

Method Detail

checkArguments

protected void checkArguments(Graph<V,E> graph,
                              V src,
                              V dst)

Checks the specified path search arguments for validity.

Parameters:

graph - graph; must not be null

src - source vertex; must not be null and belong to graph

dst - optional target vertex; must belong to graph

search

public GraphPathSearch.Result<V,E> search(Graph<V,E> graph,
                                          V src,
                                          V dst,
                                          EdgeWeigher<V,E> weigher,
                                          int maxPaths)

Description copied from interface: GraphPathSearch

Searches the specified graph for paths between vertices.

Specified by:

search in interface GraphPathSearch<V extends Vertex,E extends Edge<V>>

Parameters:

graph - graph to be searched

src - optional source vertex

dst - optional destination vertex; if null paths to all vertex destinations will be searched

weigher - optional edge-weigher; if null, DefaultEdgeWeigher will be used (assigns equal weights to all links)

maxPaths - limit on number of paths; GraphPathSearch.ALL_PATHS if no limit

Returns:

search results

internalSearch

protected abstract GraphPathSearch.Result<V,E> internalSearch(Graph<V,E> graph,
                                                              V src,
                                                              V dst,
                                                              EdgeWeigher<V,E> weigher,
                                                              int maxPaths)