Module org.jgrapht.core

Package org.jgrapht.alg.shortestpath

Class BaseMultiObjectiveShortestPathAlgorithm<V,E>

java.lang.Object

org.jgrapht.alg.shortestpath.BaseMultiObjectiveShortestPathAlgorithm<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

MultiObjectiveShortestPathAlgorithm<V,E>

Direct Known Subclasses:

MartinShortestPath

abstract class BaseMultiObjectiveShortestPathAlgorithm<V,E>
extends java.lang.Object
implements MultiObjectiveShortestPathAlgorithm<V,E>

A base implementation of the multi-objective shortest path interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgrapht.alg.interfaces.MultiObjectiveShortestPathAlgorithm

MultiObjectiveShortestPathAlgorithm.MultiObjectiveSingleSourcePaths<V,E>

Field Summary

Fields

Modifier and Type	Field	Description
protected Graph<V,E>	graph	The underlying graph.
(package private) static java.lang.String	GRAPH_MUST_CONTAIN_THE_SINK_VERTEX	Error message for reporting that a sink vertex is missing.
(package private) static java.lang.String	GRAPH_MUST_CONTAIN_THE_SOURCE_VERTEX	Error message for reporting that a source vertex is missing.

Constructor Summary

Constructors

Constructor	Description
BaseMultiObjectiveShortestPathAlgorithm(Graph<V,E> graph)	Constructs a new instance of the algorithm for a given graph

Method Summary

Modifier and Type	Method	Description
protected GraphPath<V,E>	createEmptyPath(V source, V sink)	Create an empty path.
MultiObjectiveShortestPathAlgorithm.MultiObjectiveSingleSourcePaths<V,E>	getPaths(V source)	Compute all shortest paths starting from a single source vertex.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapht.alg.interfaces.MultiObjectiveShortestPathAlgorithm

getPaths

Field Detail

GRAPH_MUST_CONTAIN_THE_SOURCE_VERTEX

static final java.lang.String GRAPH_MUST_CONTAIN_THE_SOURCE_VERTEX

Error message for reporting that a source vertex is missing.

See Also:

Constant Field Values

GRAPH_MUST_CONTAIN_THE_SINK_VERTEX

static final java.lang.String GRAPH_MUST_CONTAIN_THE_SINK_VERTEX

Error message for reporting that a sink vertex is missing.

See Also:

Constant Field Values

graph

protected final Graph<V,E> graph

The underlying graph.

Constructor Detail

BaseMultiObjectiveShortestPathAlgorithm

public BaseMultiObjectiveShortestPathAlgorithm(Graph<V,E> graph)

Constructs a new instance of the algorithm for a given graph

Parameters:

graph - the graph

Method Detail

getPaths

public MultiObjectiveShortestPathAlgorithm.MultiObjectiveSingleSourcePaths<V,E> getPaths(V source)

Description copied from interface: MultiObjectiveShortestPathAlgorithm

Compute all shortest paths starting from a single source vertex.

Specified by:

getPaths in interface MultiObjectiveShortestPathAlgorithm<V,E>

Parameters:

source - the source vertex

Returns:

the shortest paths

createEmptyPath

protected final GraphPath<V,E> createEmptyPath(V source,
                                                     V sink)

Create an empty path. Returns null if the source vertex is different than the target vertex.

Parameters:

source - the source vertex

sink - the sink vertex

Returns:

an empty path or null null if the source vertex is different than the target vertex