.gap_function

Traditional static traffic assignment property

Description

The .gap_function property allows access to the chosen gap function assuming it has been set. The gap function is used to identify how close the assignment is to the chosen equilibrium criteria.

In traditional static assignment, the equilibrium condition is deterministic user equilibrium (DUE) based on Wardrop’s first principle. Any non-zero gap reflects the dissimilarity of the current iteration’s result from this equilibrium condition.

Each gap function has a (default) stop criterion associated with it, that in turn can be configured to determine the conditions under which you accept the results to be close enough to equilibrium for the simulation to terminate.

Return type

Gap function implementation

Example 1

from planit import *

# prep
planit_instance = PLANit()
planit_instance.set(TrafficAssignment.TRADITIONAL_STATIC)

#
# <other configuration>
#

# collect the stop criterion used by the gap function and configure it
planit_instance.gap_function.stop_criteration.<call a method>


#
# <other configuration>
#

See also

Gap function implementations
Link Based Relative Gap function implementation (default for traditional static assignment)

Source code

Class GapFunctionWrapper in Wrappers.py

Last modified January 1, 0001