.get_max_iterations()

A Default Stop Criterion method

Description

Collect the current maximum number iterations before termination.

Signature

.get_max_iterations()

Return type

integer

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)

# collect the default number of maximum iterations allowed 
max_iterations = planit_instance.project.assignment.gap_function.stop_criterion.get_max_iterations()

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