Package org.insa.graphs.algorithm

Class AbstractInputData

java.lang.Object

org.insa.graphs.algorithm.AbstractInputData

Direct Known Subclasses:

CarPoolingData, PackageSwitchData, ShortestPathData, WeaklyConnectedComponentsData

public abstract class AbstractInputData
extends java.lang.Object

Base class for algorithm input data classes. This class contains the basic data that are required by most graph algorithms, i.e. a graph, a mode (time / length) and a filter for the arc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractInputData.Mode	Enum specifying the top mode of the algorithms.

Field Summary

Fields

Modifier and Type	Field	Description
protected ArcInspector	arcInspector
private Graph	graph

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractInputData(Graph graph, ArcInspector arcInspector)	Create a new AbstractInputData instance for the given graph, mode and filter.

Method Summary

Modifier and Type	Method	Description
double	getCost(Arc arc)	Retrieve the cost associated with the given arc according to the underlying arc inspector.
Graph	getGraph()
int	getMaximumSpeed()	Retrieve the maximum speed associated with this input data, or GraphStatistics.NO_MAXIMUM_SPEED if none is associated.
AbstractInputData.Mode	getMode()
boolean	isAllowed(Arc arc)	Check if the given arc is allowed for the filter corresponding to this input.

Methods inherited from class java.lang.Object

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

Field Detail

graph

private final Graph graph

arcInspector

protected final ArcInspector arcInspector

Constructor Detail

AbstractInputData

protected AbstractInputData(Graph graph,
                            ArcInspector arcInspector)

Create a new AbstractInputData instance for the given graph, mode and filter.

Parameters:

graph - Graph for this input data.

arcInspector - Arc inspector for this input data.

Method Detail

getGraph

public Graph getGraph()

Returns:

Graph associated with this input.

getCost

public double getCost(Arc arc)

Retrieve the cost associated with the given arc according to the underlying arc inspector.

Parameters:

arc - Arc for which cost should be retrieved.

Returns:

Cost for the given arc.

See Also:

ArcInspector

getMode

public AbstractInputData.Mode getMode()

Returns:

Mode associated with this input data.

See Also:

AbstractInputData.Mode

getMaximumSpeed

public int getMaximumSpeed()

Retrieve the maximum speed associated with this input data, or GraphStatistics.NO_MAXIMUM_SPEED if none is associated. The maximum speed associated with input data is different from the maximum speed associated with graph (accessible via Graph.getGraphInformation()).

Returns:

The maximum speed for this inspector, or GraphStatistics.NO_MAXIMUM_SPEED if none is set.

isAllowed

public boolean isAllowed(Arc arc)

Check if the given arc is allowed for the filter corresponding to this input.

Parameters:

arc - Arc to check.

Returns:

true if the given arc is allowed.

See Also:

ArcInspector