nextroute 1.8.1__cp38-cp38-macosx_14_0_arm64.whl → 1.12.3__cp38-cp38-macosx_14_0_arm64.whl

nextroute/__about__.py

@@ -1,3 +1,3 @@
 # © 2019-present nextmv.io inc
 
-__version__ = "v1.8.1"
+__version__ = "v1.12.3"

nextroute/options.py

@@ -16,6 +16,8 @@ from nextroute.base_model import BaseModel
 _DURATIONS_ARGS = [
     "-check.duration",
     "-solve.duration",
+    "-solve.plateau.duration",
+    "-solve.plateau.delay",
 ]
 
 # Arguments that require a string enum.
@@ -79,16 +81,20 @@ class Options(BaseModel):
     MODEL_OBJECTIVES_CAPACITIES: str = ""
     """
     Capacity objective, provide triple for each resource
-    `name:default;factor:1.0;offset;0.0`.
+    `name=default;factor=1.0;offset=0.0`.
     """
     MODEL_OBJECTIVES_CLUSTER: float = 0.0
     """Factor to weigh the cluster objective."""
+    MODEL_OBJECTIVES_DISTANCE: float = 0.0
+    """Factor to weigh the distance objective."""
     MODEL_OBJECTIVES_EARLYARRIVALPENALTY: float = 1.0
     """Factor to weigh the early arrival objective."""
     MODEL_OBJECTIVES_LATEARRIVALPENALTY: float = 1.0
     """Factor to weigh the late arrival objective."""
     MODEL_OBJECTIVES_MINSTOPS: float = 1.0
     """Factor to weigh the min stops objective."""
+    MODEL_OBJECTIVES_STOPBALANCE: float = 0.0
+    """Factor to weigh the stop balance objective."""
     MODEL_OBJECTIVES_TRAVELDURATION: float = 0.0
     """Factor to weigh the travel duration objective."""
     MODEL_OBJECTIVES_UNPLANNEDPENALTY: float = 1.0
@@ -105,6 +111,8 @@ class Options(BaseModel):
     """Ignore the initial solution."""
     MODEL_PROPERTIES_DISABLE_STOPDURATIONMULTIPLIERS: bool = False
     """Ignore the stop duration multipliers defined on vehicles."""
+    MODEL_PROPERTIES_MAXIMUMTIMEHORIZON: int = 15552000
+    """Maximum time horizon for the model in seconds."""
     MODEL_VALIDATE_DISABLE_RESOURCES: bool = False
     """Disable the resources validation."""
     MODEL_VALIDATE_DISABLE_STARTTIME: bool = False
@@ -125,8 +133,48 @@ class Options(BaseModel):
     Maximum number of parallel runs, -1 results in using all available
     resources.
     """
+    SOLVE_PLATEAU_DELAY: float = 0.0
+    """Delay before starting to monitor for a plateau."""
+    SOLVE_PLATEAU_ABSOLUTETHRESHOLD: float = -1
+    """Absolute threshold for significant improvement."""
+    SOLVE_PLATEAU_DURATION: float = 0.0
+    """Maximum duration, in seconds, without (significant) improvement."""
+    SOLVE_PLATEAU_ITERATIONS: int = 0
+    """Maximum number of iterations without (significant) improvement."""
+    SOLVE_PLATEAU_RELATIVETHRESHOLD: float = 0.0
+    """Relative threshold for significant improvement."""
     SOLVE_RUNDETERMINISTICALLY: bool = False
     """Run the parallel solver deterministically."""
+    SOLVE_SOLVER_PLANGROUPSIZE_DELTA: int = 0
+    """Delta for the plan group size parameter."""
+    SOLVE_SOLVER_PLANGROUPSIZE_DELTAAFTERITERATIONS: int = 1000000000
+    """Delta after each iteration for the plan group size parameter."""
+    SOLVE_SOLVER_PLANGROUPSIZE_MAXVALUE: int = 2
+    """Maximum value for the plan group size parameter."""
+    SOLVE_SOLVER_PLANGROUPSIZE_MINVALUE: int = 2
+    """Minimum value for the plan group size parameter."""
+    SOLVE_SOLVER_PLANGROUPSIZE_SNAPBACKAFTERIMPROVEMENT: bool = True
+    """Snap back to start value after improvement of best solution for the plan group size parameter."""
+    SOLVE_SOLVER_PLANGROUPSIZE_STARTVALUE: int = 2
+    """Start value for the plan group size parameter."""
+    SOLVE_SOLVER_PLANGROUPSIZE_ZIGZAG: bool = True
+    """Zigzag between min and max value like a jig saw for the plan group size parameter."""
+    SOLVE_SOLVER_UNPLANUNITS_DELTA: int = 2
+    """Delta for the unplan units parameter."""
+    SOLVE_SOLVER_UNPLANUNITS_DELTAAFTERITERATIONS: int = 125
+    """Delta after each iteration for the unplan units parameter."""
+    SOLVE_SOLVER_UNPLANUNITS_MAXVALUE: int = -1
+    """Maximum value for the unplan units parameter."""
+    SOLVE_SOLVER_UNPLANUNITS_MINVALUE: int = 2
+    """Minimum value for the unplan units parameter."""
+    SOLVE_SOLVER_UNPLANUNITS_SNAPBACKAFTERIMPROVEMENT: bool = True
+    """Snap back to start value after improvement of best solution for the unplan units parameter."""
+    SOLVE_SOLVER_UNPLANUNITS_STARTVALUE: int = 2
+    """Start value for the unplan units parameter."""
+    SOLVE_SOLVER_UNPLANUNITS_ZIGZAG: bool = True
+    """Zigzag between min and max value like a jig saw for the unplan units parameter."""
+    SOLVE_SOLVER_UNPLANWEIGHTS: str = "Vehicle:3,Island:1,Location:293"
+    """Unplan heuristic weights parameter."""
     SOLVE_STARTSOLUTIONS: int = -1
     """
     Number of solutions to generate on top of those passed in; one solution

nextroute/schema/input.py

@@ -4,7 +4,8 @@
 Defines the input class.
 """
 
-from typing import Any, List, Optional
+from datetime import datetime
+from typing import Any, List, Optional, Union
 
 from nextroute.base_model import BaseModel
 from nextroute.schema.stop import AlternateStop, Stop, StopDefaults
@@ -30,6 +31,30 @@ class DurationGroup(BaseModel):
     """Stop IDs contained in the group."""
 
 
+class MatrixTimeFrame(BaseModel):
+    """Represents a time-dependent duration matrix or scaling factor."""
+
+    start_time: datetime
+    """Start time of the time frame."""
+    end_time: datetime
+    """End time of the time frame."""
+    matrix: Optional[List[List[float]]] = None
+    """Duration matrix for the time frame."""
+    scaling_factor: Optional[float] = None
+    """Scaling factor for the time frame."""
+
+
+class TimeDependentMatrix(BaseModel):
+    """Represents time-dependent duration matrices."""
+
+    vehicle_ids: Optional[List[str]] = None
+    """Vehicle IDs for which the duration matrix is defined."""
+    default_matrix: List[List[float]]
+    """Default duration matrix."""
+    matrix_time_frames: Optional[List[MatrixTimeFrame]] = None
+    """Time-dependent duration matrices."""
+
+
 class Input(BaseModel):
     """Input schema for Nextroute."""
 
@@ -46,10 +71,16 @@ class Input(BaseModel):
     """Default values for vehicles and stops."""
     distance_matrix: Optional[List[List[float]]] = None
     """Matrix of travel distances in meters between stops."""
-    duratrion_groups: Optional[List[DurationGroup]] = None
+    duration_groups: Optional[List[DurationGroup]] = None
     """Duration in seconds added when approaching the group."""
-    duration_matrix: Optional[List[List[float]]] = None
-    """Matrix of travel durations in seconds between stops."""
+    duration_matrix: Optional[
+        Union[
+            List[List[float]],
+            TimeDependentMatrix,
+            List[TimeDependentMatrix],
+        ]
+    ] = None
+    """Matrix of travel durations in seconds between stops as a single matrix or duration matrices."""
     options: Optional[Any] = None
     """Arbitrary options."""
     stop_groups: Optional[List[List[str]]] = None

{nextroute-1.8.1.dist-info → nextroute-1.12.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nextroute
-Version: 1.8.1
+Version: 1.12.3
 Summary: Nextroute is an engine for solving Vehicle Routing Problems (VRPs).
 Author-email: Nextmv <tech@nextmv.io>
 Maintainer-email: Nextmv <tech@nextmv.io>
@@ -104,6 +104,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -197,7 +198,7 @@ file.
 
 For further information on how to get started, features, deployment, etc.,
 please refer to the [official
-documentation](https://www.nextmv.io/docs/vehicle-routing).
+documentation](https://www.nextmv.io/docs/vehicle-routing/get-started).
 
 ### Go
 

{nextroute-1.8.1.dist-info → nextroute-1.12.3.dist-info}/RECORD

@@ -1,14 +1,14 @@
-nextroute/__about__.py,sha256=QAWPbTk3M2yG_B_CwMV54PyoO6pTiEWmLXI54Z4A3-o,56
+nextroute/__about__.py,sha256=H71OIfyHAXJOiG4wuGcoP506V3in6aScHaOMWCJknuM,57
 nextroute/__init__.py,sha256=wBHS73T_Mm2MfcEx4chZCI1QMbV-a1D7bw7megFLgb4,529
 nextroute/base_model.py,sha256=Jl205oJZvndkY8rIomZD2k5YhlGgRBn_2I1BKwQ8Vkk,541
-nextroute/options.py,sha256=a6tiIWWmLSgGjQKVA2ASPMzDEQl9G6Dx6jp4lbRy_kQ,7541
+nextroute/options.py,sha256=tZcTLIjsx-6fq9Q9Y-Z8syKbPqGyR3GV6vfpWvVmzLQ,10280
 nextroute/solve.py,sha256=It1kDEdFk_AXX-gEUjvQbc7C-0ma9bEPRbnC_bHMsUU,4192
 nextroute/version.py,sha256=aA_wmIifNRCzxBigX4cSz1Y2CdXvuBNIiY7Nem5UqRA,325
-nextroute/bin/nextroute.exe,sha256=grmSufPLzfqURqNgZlpm_Oz8tdbjJugGKkTreORA8Pw,13300144
+nextroute/bin/nextroute.exe,sha256=UrjmdA8fjj-s06wT5a6eI85RORVDbtEzB8JdK527r7c,14994304
 nextroute/check/__init__.py,sha256=Hrw5LUqdMeaBEsoIrJmWDhmAKAzGuzDnoBExwNWJvlU,1303
 nextroute/check/schema.py,sha256=hBC0Usw4_rEJHsWDxDtIi0-d6byXt8f9eYqBE9hqiCc,5853
 nextroute/schema/__init__.py,sha256=KSlnpJQMnCDq5IXyiltt9CiafcxUH40B3FdE1fc5wdI,1167
-nextroute/schema/input.py,sha256=8_-xi-P2t-A6mObLscKavT-Ro0td9VECp2pZOQ1dWmo,1863
+nextroute/schema/input.py,sha256=uidXX_hpv1KpiIUCc_XhiiQf69vxiav9DsXfiLtpD2s,2856
 nextroute/schema/location.py,sha256=hihllMU3IXxQHugGC4Wn_TzDPr5zm4xqVqRsKanwrmA,301
 nextroute/schema/output.py,sha256=rJv_PpP0X0MdLTRa2tbDsLLbGhTRi43hGmMNmzvNZEw,4810
 nextroute/schema/statistics.py,sha256=lNlb1mcpR6xWQclG-fkDMnFoy-sEKpXKk80zU1TKrpQ,3600
@@ -18,9 +18,9 @@ tests/schema/__init__.py,sha256=MRZbyX5fYnxsXV0YP6lf32c5YYMo3NsEFqPwdwf5W18,32
 tests/schema/test_input.py,sha256=kNIlUFqCkvvQieuJIo7-6C_NB9PZqZ72NpGwUWtDZcA,1851
 tests/schema/test_output.py,sha256=i0VreVBXamC-Pk-z7X3W9APjmjfG8iOPAt2jxP4hDQA,11579
 tests/solve_golden/__init__.py,sha256=MRZbyX5fYnxsXV0YP6lf32c5YYMo3NsEFqPwdwf5W18,32
-tests/solve_golden/main.py,sha256=N8QTju8Iq2ip6XVn1PxcoaVY1N-GzOJUhDH31blV2Ro,1545
-nextroute-1.8.1.dist-info/LICENSE,sha256=ElKAl6B15yj4LTFL_Dh1hje431kMHut2urxo5nheRWs,4107
-nextroute-1.8.1.dist-info/METADATA,sha256=9RAaN9vgMdqBvslv1hPfGbbDdT7TdoYnGk2CUgQIEhY,15526
-nextroute-1.8.1.dist-info/WHEEL,sha256=fPG3h-vfL70uR7eF-JqKg0bPUCORdIAQuRpuVxflUVo,108
-nextroute-1.8.1.dist-info/top_level.txt,sha256=KNsuo1j7tr-QvBFS_ELmo68OmJ-orEZiOXqstGLJDXA,16
-nextroute-1.8.1.dist-info/RECORD,,
+tests/solve_golden/main.py,sha256=VScx0kPD8ihGR5bSIpLrPTIxRh7mkk9YQ9g0eg8XZMc,1738
+nextroute-1.12.3.dist-info/LICENSE,sha256=ElKAl6B15yj4LTFL_Dh1hje431kMHut2urxo5nheRWs,4107
+nextroute-1.12.3.dist-info/METADATA,sha256=tB7ipov9kgEDYAuBkcA9595NCSBnlR37Kmfj6simJeo,15590
+nextroute-1.12.3.dist-info/WHEEL,sha256=7oHrrmTB-AnaDl8j1Eeuo7QImBG4q2CMfROfSJb1CuE,107
+nextroute-1.12.3.dist-info/top_level.txt,sha256=KNsuo1j7tr-QvBFS_ELmo68OmJ-orEZiOXqstGLJDXA,16
+nextroute-1.12.3.dist-info/RECORD,,

{nextroute-1.8.1.dist-info → nextroute-1.12.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.44.0)
+Generator: setuptools (75.3.2)
 Root-Is-Purelib: false
 Tag: cp38-cp38-macosx_14_0_arm64
 

tests/solve_golden/main.py

@@ -1,8 +1,6 @@
 # This script is copied to the `src` root so that the `nextroute` import is
 # resolved. It is fed an input via stdin and is meant to write the output to
 # stdout.
-from typing import Any, Dict
-
 import nextmv
 
 import nextroute
@@ -16,8 +14,8 @@ def main() -> None:
         nextmv.Parameter("output", str, "", "Path to output file. Default is stdout.", False),
     ]
 
-    nextroute_options = nextroute.Options()
-    for name, default_value in nextroute_options.to_dict().items():
+    default_options = nextroute.Options()
+    for name, default_value in default_options.to_dict().items():
         parameters.append(nextmv.Parameter(name.lower(), type(default_value), default_value, name, False))
 
     options = nextmv.Options(*parameters)
@@ -28,18 +26,24 @@ def main() -> None:
     nextmv.log(f"  - stops: {len(input.data.get('stops', []))}")
     nextmv.log(f"  - vehicles: {len(input.data.get('vehicles', []))}")
 
-    output = solve(input, options)
+    model = DecisionModel()
+    output = model.solve(input)
     nextmv.write_local(output, path=options.output)
 
 
-def solve(input: nextmv.Input, options: nextmv.Options) -> Dict[str, Any]:
-    """Solves the given problem and returns the solution."""
+class DecisionModel(nextmv.Model):
+    def solve(self, input: nextmv.Input) -> nextmv.Output:
+        """Solves the given problem and returns the solution."""
 
-    nextroute_input = nextroute.schema.Input.from_dict(input.data)
-    nextroute_options = nextroute.Options.extract_from_dict(options.to_dict())
-    nextroute_output = nextroute.solve(nextroute_input, nextroute_options)
+        nextroute_input = nextroute.schema.Input.from_dict(input.data)
+        nextroute_options = nextroute.Options.extract_from_dict(input.options.to_dict())
+        nextroute_output = nextroute.solve(nextroute_input, nextroute_options)
 
-    return nextroute_output.to_dict()
+        return nextmv.Output(
+            options=input.options,
+            solution=nextroute_output.solutions[0].to_dict(),
+            statistics=nextroute_output.statistics.to_dict(),
+        )
 
 
 if __name__ == "__main__":