Package org.goplanit.gap

Class LinkBasedRelativeDualityGapFunction

java.lang.Object

org.goplanit.component.PlanitComponent<GapFunction>

org.goplanit.gap.GapFunction

org.goplanit.gap.LinkBasedRelativeDualityGapFunction

All Implemented Interfaces:

Serializable, Comparable<IdAble>, EventListener, PlanitComponentListener, EventListener, ExternalIdAble, IdAble

public class LinkBasedRelativeDualityGapFunction
extends GapFunction

Gap function based on the work of Bovy and Jansen (1983) who take the different between the current system travel time and the system travel time if all flow were to be assigned to the shortest paths, divided by the system travel time

Author:

markr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	gap	Gap
static double	INITIAL_GAP	initial gap to use
protected double	measuredNetworkCost	Current system cost as it stands
protected double	minimumNetworkCost	Represents the total minimum cost possible

Fields inherited from class org.goplanit.gap.GapFunction

LINK_BASED_RELATIVE_GAP, NORM_BASED_GAP, stopCriterion

Constructor Summary

Constructors

Constructor	Description
LinkBasedRelativeDualityGapFunction(LinkBasedRelativeDualityGapFunction other, boolean deepCopy)	Copy constructor
LinkBasedRelativeDualityGapFunction(IdGroupingToken idToken, StopCriterion stopCriterion)	Constructor

Method Summary

Modifier and Type	Method	Description
double	computeGap()	Compute the gap and return it
LinkBasedRelativeDualityGapFunction	deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
double	getGap()	Returns the last computed gap
double	getMeasuredNetworkCost()	Return the measured cost
void	increaseConvexityBound(double value)	Increase convexity bound cost, i.e.
void	increaseMeasuredCost(double value)	Increase system cost, i.e.
void	reset()	Reset the gap function
LinkBasedRelativeDualityGapFunction	shallowClone()	Create a shallow copy of this entity

Methods inherited from class org.goplanit.gap.GapFunction

collectSettingsAsKeyValueMap, getStopCriterion, hasConverged

Methods inherited from class org.goplanit.component.PlanitComponent

equals, getComponentType, getExternalId, getId, getIdGroupingToken, getKnownSupportedEventTypes, getXmlId, hashCode, onPlanitComponentEvent, setExternalId, setXmlId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.utils.event.EventListener

hasKnownSupportedEventTypes

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble

appendExternalId, appendExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, hasExternalId, hasXmlId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble

compareTo, idEquals, idHashCode

Field Detail

measuredNetworkCost

protected double measuredNetworkCost

Current system cost as it stands

minimumNetworkCost

protected double minimumNetworkCost

Represents the total minimum cost possible

gap

protected double gap

Gap

INITIAL_GAP

public static double INITIAL_GAP

initial gap to use

Constructor Detail

LinkBasedRelativeDualityGapFunction

public LinkBasedRelativeDualityGapFunction(IdGroupingToken idToken,
                                           StopCriterion stopCriterion)

Constructor

Parameters:

idToken - to use for the generation of its id

stopCriterion - StopCriterion object being used

LinkBasedRelativeDualityGapFunction

public LinkBasedRelativeDualityGapFunction(LinkBasedRelativeDualityGapFunction other,
                                           boolean deepCopy)

Copy constructor

Parameters:

other - to copy

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

Method Detail

getMeasuredNetworkCost

public double getMeasuredNetworkCost()

Return the measured cost

Returns:

the measured cost

increaseMeasuredCost

public void increaseMeasuredCost(double value)

Increase system cost, i.e. compute it exogenously

Parameters:

value - increase

increaseConvexityBound

public void increaseConvexityBound(double value)

Increase convexity bound cost, i.e. compute it exogenously

Parameters:

value - the increase

reset

public void reset()

Reset the gap function

Specified by:

reset in class GapFunction

computeGap

public double computeGap()

Compute the gap and return it

Specified by:

computeGap in class GapFunction

Returns:

the gap for the current iteration

getGap

public double getGap()

Returns the last computed gap

Specified by:

getGap in class GapFunction

Returns:

latest gap

shallowClone

public LinkBasedRelativeDualityGapFunction shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in class GapFunction

Returns:

shallow copy of entity

deepClone

public LinkBasedRelativeDualityGapFunction deepClone()

deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in class GapFunction

Returns:

deep copy of entity