Package org.goplanit.supply.fundamentaldiagram

Class FundamentalDiagramImpl

java.lang.Object

org.goplanit.supply.fundamentaldiagram.FundamentalDiagramImpl

All Implemented Interfaces:

FundamentalDiagram

Direct Known Subclasses:

NewellFundamentalDiagram

public abstract class FundamentalDiagramImpl
extends Object
implements FundamentalDiagram

Base class for fundamental diagram instances

Author:

markr

Field Summary

Fields inherited from interface org.goplanit.supply.fundamentaldiagram.FundamentalDiagram

NEWELL

Constructor Summary

Constructors

Constructor	Description
FundamentalDiagramImpl(FundamentalDiagramBranch freeFlowBranch, FundamentalDiagramBranch congestedBranch)	Constructor
FundamentalDiagramImpl(FundamentalDiagramImpl fundamentalDiagramImpl, boolean deepCopy)	Copy Constructor

Method Summary

Modifier and Type	Method	Description
abstract FundamentalDiagram	deepClone()	deep clone of fundamental diagram
FundamentalDiagramBranch	getCongestedBranch()	Congested branch of the FD
FundamentalDiagramBranch	getFreeFlowBranch()	Free flow branch of the FD
int	relaxedHashCode(int scale)	A fundamental diagram is based on a limited number of double variables to define it.
abstract FundamentalDiagram	shallowClone()	Shallow copy of the fundamental diagram

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.supply.fundamentaldiagram.FundamentalDiagram

getCapacityFlowPcuHour, getMaximumDensityPcuKm, getMaximumSpeedKmHour, setCapacityPcuHour, setMaximumDensityPcuKmHour, setMaximumSpeedKmHour

Constructor Detail

FundamentalDiagramImpl

public FundamentalDiagramImpl(FundamentalDiagramBranch freeFlowBranch,
                              FundamentalDiagramBranch congestedBranch)

Constructor

Parameters:

freeFlowBranch - to use

congestedBranch - to use

FundamentalDiagramImpl

public FundamentalDiagramImpl(FundamentalDiagramImpl fundamentalDiagramImpl,
                              boolean deepCopy)

Copy Constructor

Parameters:

fundamentalDiagramImpl - to copy

deepCopy - when true, create a deep copy, shallow copy otherwise

Method Detail

getFreeFlowBranch

public FundamentalDiagramBranch getFreeFlowBranch()

Free flow branch of the FD

Specified by:

getFreeFlowBranch in interface FundamentalDiagram

Returns:

free flow branch

getCongestedBranch

public FundamentalDiagramBranch getCongestedBranch()

Congested branch of the FD

Specified by:

getCongestedBranch in interface FundamentalDiagram

Returns:

congested branch

relaxedHashCode

public int relaxedHashCode(int scale)

A fundamental diagram is based on a limited number of double variables to define it. In case we want to use the same FD for extremely similar variables we can use this relaxed hash code that ensures that for the given precision level identical hashes are created even if the underlying floating point variables differ beyond this precision.

Specified by:

relaxedHashCode in interface FundamentalDiagram

Parameters:

scale - indicating how many decimals to consider, e.g., 2 considers 2 decimals for precision

Returns:

created relaxed hash code

shallowClone

public abstract FundamentalDiagram shallowClone()

Shallow copy of the fundamental diagram

Specified by:

shallowClone in interface FundamentalDiagram

Returns:

cloned instance

deepClone

public abstract FundamentalDiagram deepClone()

deep clone of fundamental diagram

Specified by:

deepClone in interface FundamentalDiagram

Returns:

cloned instance