Package org.planit.assignment.algorithmb

Class AlgorithmB

java.lang.Object

org.djutils.event.EventProducer

org.planit.assignment.TrafficAssignmentComponent<NetworkLoading>

org.planit.supply.networkloading.NetworkLoading

org.planit.assignment.TrafficAssignment

org.planit.assignment.StaticTrafficAssignment

org.planit.assignment.algorithmb.AlgorithmB

All Implemented Interfaces:

Serializable, Comparable<Idable>, org.djutils.event.EventProducerInterface, Idable

public class AlgorithmB
extends StaticTrafficAssignment

Algorithm B implementation based on the work of Dial (2006). Due to a lack of explicit explanation for the implementation of the underlying algorithm, the implementation follows the main principles explained in this work but the algorithm design is likely different than the one implemented for the results discussed in the original paper.

Author:

markr

See Also:

Serialized Form

Field Summary

Fields inherited from class org.planit.assignment.TrafficAssignment

ALGORITHM_B, demands, ELTM, initialLinkSegmentCost, initialLinkSegmentCostByTimePeriod, numberOfNetworkSegments, numberOfNetworkVertices, physicalCost, smoothing, TRADITIONAL_STATIC_ASSIGNMENT, transportNetwork, virtualCost

Fields inherited from class org.planit.assignment.TrafficAssignmentComponent

id, tokenId, trafficComponentType

Fields inherited from class org.djutils.event.EventProducer

listeners

Fields inherited from interface org.djutils.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor	Description
AlgorithmB(IdGroupingToken groupId)	Constructor

Method Summary

Modifier and Type	Method	Description
OutputTypeAdapter	createOutputTypeAdapter(OutputType outputType)	Create the output type adapter for the current output type, specifically tailored towards the assignment type that we are builing
protected void	executeTimePeriod(TimePeriod timePeriod, Set<Mode> modes)	Execute the time period for the registered modes
AlgorithmBSimulationData	getIterationData()	Return the simulation data for the current iteration
int	getIterationIndex()	Collect the current iteration index of the simulation

Methods inherited from class org.planit.assignment.StaticTrafficAssignment

executeEquilibration, executeTimePeriod

Methods inherited from class org.planit.assignment.TrafficAssignment

checkForEmptyComponents, createLoggingPrefix, createTransportNetwork, disbandTransportNetwork, execute, finalizeAfterExecution, getGapFunction, getOutputManager, getPhysicalCost, getSmoothing, getTransportNetwork, getVirtualCost, initialiseBeforeExecution, setDemands, setGapFunction, setInfrastructureNetwork, setInitialLinkSegmentCost, setInitialLinkSegmentCost, setOutputManager, setPhysicalCost, setSmoothing, setVirtualCost, setZoning, verifyComponentCompatibility

Methods inherited from class org.planit.assignment.TrafficAssignmentComponent

equals, getId, getIdGroupingToken, getSourceId, getTrafficComponentType, hashCode

Methods inherited from class org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, getEventTypesWithListeners, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.planit.utils.id.Idable

compareTo, idEquals, idHashCode

Constructor Detail

AlgorithmB

public AlgorithmB(IdGroupingToken groupId)

Constructor

Parameters:

groupId - group the id generator will be using when genarting the id

Method Detail

createOutputTypeAdapter

public OutputTypeAdapter createOutputTypeAdapter(OutputType outputType)

Description copied from class: TrafficAssignment

Create the output type adapter for the current output type, specifically tailored towards the assignment type that we are builing

Specified by:

createOutputTypeAdapter in class TrafficAssignment

Parameters:

outputType - the current output type

Returns:

the output type adapter corresponding to the current traffic assignment and output type

executeTimePeriod

protected void executeTimePeriod(TimePeriod timePeriod,
                                 Set<Mode> modes)
                          throws PlanItException

Execute the time period for the registered modes

Specified by:

executeTimePeriod in class StaticTrafficAssignment

Parameters:

timePeriod - to execute

modes - to consider

Throws:

PlanItException - thrown if error

getIterationIndex

public int getIterationIndex()

Collect the current iteration index of the simulation

Specified by:

getIterationIndex in class TrafficAssignment

Returns:

current iteration index

getIterationData

public AlgorithmBSimulationData getIterationData()

Return the simulation data for the current iteration

Returns:

simulation data