.set_epsilon(+)

A Default Stop Criterion method
Description

Override the default upper bound epsilon that allows for algorithm termination. Or, alternatively, as long as the gap of the algorithm exceeds the provided epsilon, the algorithm is not terminated based on this criterion.

Signature

.set_epsilon(epsilon)

with

Parameter Type Unit Compulsory Description
epsilon float None YES New upper bound epsilon

Return type

None

Example 1

from planit import *

# choose to run Planit with a traditional static traffic assignment method
planit_instance = Planit()
planit_instance.project.set(TrafficAssignment.TRADITIONAL_STATIC)

# update the epsilon termination criterion to a more strict 0.00001 (compared to the default)
planit_instance.project.assignment.gap_function.stop_criterion.set_epsilon(0.00001)

See also

Traffic Assignment on what traffic assignment methods are available
Gap Function gap function implementations utilising a stop criterion

Source code

Class StopCriterionWrapper in projectwrappers.py

Last modified January 1, 0001