org.onlab.graph

Class AbstractGraphPathSearch.DefaultResult

java.lang.Object

org.onlab.graph.AbstractGraphPathSearch.DefaultResult

All Implemented Interfaces:

GraphPathSearch.Result<V,E>

Direct Known Subclasses:

DepthFirstSearch.SpanningTreeResult, KShortestPathsSearch.InnerOrderedResult

Enclosing class:

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

protected class AbstractGraphPathSearch.DefaultResult
extends java.lang.Object
implements GraphPathSearch.Result<V,E>

Default path search result that uses the DefaultPath to convey paths in a graph.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<V,Weight>	costs
protected int	maxPaths
protected java.util.Map<V,java.util.Set<E>>	parents
protected java.util.Set<Path<V,E>>	paths

Constructor Summary

Constructors

Constructor and Description
DefaultResult(V src, V dst) Creates the result of a single-path search.
DefaultResult(V src, V dst, int maxPaths) Creates the result of path search.

Method Summary

Modifier and Type	Method and Description
protected void	buildPaths() Builds a set of paths for the specified src/dst vertex pair.
java.util.Map<V,Weight>	costs() Return a bindings of each vertex to its cost in the path.
V	dst() Returns the search destination, if was was given.
java.util.Map<V,java.util.Set<E>>	parents() Returns bindings of each vertex to its parent edges in the path.
java.util.Set<Path<V,E>>	paths() Returns the set of paths produced as a result of the graph search.
V	src() Returns the search source.

Methods inherited from class java.lang.Object

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

Field Detail

paths

protected final java.util.Set<Path<V extends Vertex,E extends Edge<V>>> paths

costs

protected final java.util.Map<V extends Vertex,Weight> costs

parents

protected final java.util.Map<V extends Vertex,java.util.Set<E extends Edge<V>>> parents

maxPaths

protected final int maxPaths

Constructor Detail

DefaultResult

public DefaultResult(V src,
                     V dst)

Creates the result of a single-path search.

Parameters:

src - path source

dst - optional path destination

DefaultResult

public DefaultResult(V src,
                     V dst,
                     int maxPaths)

Creates the result of path search.

Parameters:

src - path source

dst - optional path destination

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

Method Detail

src

public V src()

Description copied from interface: GraphPathSearch.Result

Returns the search source.

Specified by:

src in interface GraphPathSearch.Result<V extends Vertex,E extends Edge<V>>

Returns:

search source

dst

public V dst()

Description copied from interface: GraphPathSearch.Result

Returns the search destination, if was was given.

Specified by:

dst in interface GraphPathSearch.Result<V extends Vertex,E extends Edge<V>>

Returns:

optional search destination

paths

public java.util.Set<Path<V,E>> paths()

Description copied from interface: GraphPathSearch.Result

Returns the set of paths produced as a result of the graph search.

Specified by:

paths in interface GraphPathSearch.Result<V extends Vertex,E extends Edge<V>>

Returns:

set of paths

costs

public java.util.Map<V,Weight> costs()

Description copied from interface: GraphPathSearch.Result

Return a bindings of each vertex to its cost in the path.

Specified by:

costs in interface GraphPathSearch.Result<V extends Vertex,E extends Edge<V>>

Returns:

map of vertex to path cost bindings

parents

public java.util.Map<V,java.util.Set<E>> parents()

Description copied from interface: GraphPathSearch.Result

Returns bindings of each vertex to its parent edges in the path.

Specified by:

parents in interface GraphPathSearch.Result<V extends Vertex,E extends Edge<V>>

Returns:

map of vertex to its parent edge bindings

buildPaths

protected void buildPaths()

Builds a set of paths for the specified src/dst vertex pair.