glob iteration specific relative gap

Author: i-am-sijia

tm2py/components/network/highway/highway_assign.py

@@ -297,13 +297,18 @@ def _get_assignment_spec(
             Emme specification for SOLA traffic assignment
 
         """
-        relative_gap = self.config.relative_gap
-        # if relative is a list, get the corresponding value for the current iteration
-        if relative_gap and isinstance(relative_gap, list):
-            if self.controller.iteration == 0:
-                relative_gap = relative_gap[0]
-            else:
-                relative_gap = relative_gap[self.controller.iteration - 1]
+        relative_gaps = self.config.relative_gaps
+        # get the corresponding relative gap for the current iteration
+        relative_gap = None
+        if relative_gaps and isinstance(relative_gaps, tuple):
+            for item in relative_gaps:
+                if item["global_iteration"] == self.controller.iteration:
+                    relative_gap = item["relative_gap"]
+                    break
+            if relative_gap is None:
+                raise ValueError(
+                    f"RelativeGapConfig: Must specifify a value for global iteration {self.controller.iteration}"
+                )
         max_iterations = self.config.max_iterations
         # NOTE: mazmazvol as background traffic in link.data1 ("ul1")
         base_spec = {

tm2py/config.py

@@ -924,7 +924,7 @@ class HighwayConfig(ConfigItem):
     Properties:
         generic_highway_mode_code: single character unique mode ID for entire
             highway network (no excluded_links)
-        relative_gap: target relative gap stopping criteria. specify a single value float
+        relative_gaps: target relative gap stopping criteria. specify a single value float
             for all global iterations or a list with values for each global iteration.
         max_iterations: maximum iterations stopping criteria
         area_type_buffer_dist_miles: used to in calculation to categorize link @areatype
@@ -1350,12 +1350,12 @@ def maz_skim_period_exists(cls, value, values):
             ), "maz_to_maz -> skim_period -> name not found in time_periods list"
         return value
 
-    @validator("highway_relative_gap")
+    @validator("highway")
     def relative_gap_length(cls, value, values):
-        """Validate highway.relative_gap is a list of the same length as global iterations."""
+        """Validate highway.relative_gaps is a list of the same length as global iterations."""
         if "end_iteration" in values:
             assert (
-                len(value) == len(values["end_iteration"]+1),
+                len(value.relative_gaps) == len(values["end_iteration"]+1),
                 "relative_gap must be the same length as end_iteration+1",
             )
         return value