job-shop-lib 1.1.3__py3-none-any.whl → 1.2.0__py3-none-any.whl

job_shop_lib/__init__.py

@@ -19,7 +19,7 @@ from job_shop_lib._schedule import Schedule
 from job_shop_lib._base_solver import BaseSolver, Solver
 
 
-__version__ = "1.1.3"
+__version__ = "1.2.0"
 
 __all__ = [
     "Operation",

job_shop_lib/dispatching/__init__.py

@@ -24,6 +24,7 @@ Problem step-by-step.
     get_matrix_setup_time_calculator
     get_breakdown_calculator
     get_job_dependent_setup_calculator
+    get_arrival_calculator
 
 Dispatching refers to the decision-making process of selecting which job
 should be processed next on a particular machine when that machine becomes
@@ -53,6 +54,7 @@ from ._start_time_calculators import (
     get_breakdown_calculator,
     get_job_dependent_setup_calculator,
     get_matrix_setup_time_calculator,
+    get_arrival_calculator,
 )
 from ._dispatcher_observer_config import DispatcherObserverConfig
 from ._factories import (
@@ -84,4 +86,5 @@ __all__ = [
     "get_matrix_setup_time_calculator",
     "get_breakdown_calculator",
     "get_job_dependent_setup_calculator",
+    "get_arrival_calculator",
 ]

job_shop_lib/dispatching/_start_time_calculators.py

@@ -193,3 +193,52 @@ def get_job_dependent_setup_calculator(
         return default_start + setup_time
 
     return calculator
+
+
+def get_arrival_calculator(
+    arrival_times: Sequence[Sequence[int]] | NDArray[np.integer] | None = None,
+) -> StartTimeCalculator:
+    """Returns a start time calculator that respects operation arrival times.
+
+    This calculator uses a predefined matrix of arrival times to
+    ensure that no operation begins before its specified arrival
+    time. If the ``arrival_times`` matrix isn't provided directly,
+    the calculator attempts to retrieve it from the dispatcher's
+    instance metadata using the key ``"arrival_times_matrix"``.
+
+    Args:
+        arrival_times:
+            A 2D matrix where ``arrival_times[i][j]`` is the
+            arrival time for the operation at index ``j`` of
+            job ``i``. If ``None``, the calculator will
+            attempt to retrieve it from the dispatcher metadata.
+
+    Returns:
+        A start time calculator function that uses the arrival times.
+
+    Example:
+        >>> arrival_calc = get_arrival_calculator([[0, 2], [1, 0]])
+        >>> dispatcher = Dispatcher(
+        ...     instance, start_time_calculator=arrival_calc
+        ... )
+    """
+
+    def calculator(
+        dispatcher: Dispatcher, operation: Operation, machine_id: int
+    ) -> int:
+        default_start_time = no_setup_time_calculator(
+            dispatcher, operation, machine_id
+        )
+        arrival_matrix = arrival_times
+        if arrival_matrix is None:
+            arrival_matrix = dispatcher.instance.metadata.get(
+                "arrival_times_matrix"
+            )
+        if arrival_matrix is None:
+            return default_start_time
+        operation_arrival_time = arrival_matrix[operation.job_id][
+            operation.position_in_job
+        ]
+        return max(default_start_time, operation_arrival_time)
+
+    return calculator

job_shop_lib/generation/_instance_generator.py

@@ -1,6 +1,6 @@
 """Home of the `InstanceGenerator` class."""
 
-import abc
+from abc import ABC, abstractmethod
 
 import random
 from typing import Iterator
@@ -9,7 +9,7 @@ from job_shop_lib import JobShopInstance
 from job_shop_lib.exceptions import UninitializedAttributeError
 
 
-class InstanceGenerator(abc.ABC):
+class InstanceGenerator(ABC):
     """Common interface for all generators.
 
     The class supports both single instance generation and iteration over
@@ -75,7 +75,7 @@ class InstanceGenerator(abc.ABC):
         self._current_iteration = 0
         self._iteration_limit = iteration_limit
 
-    @abc.abstractmethod
+    @abstractmethod
     def generate(
         self,
         num_jobs: int | None = None,

{job_shop_lib-1.1.3.dist-info → job_shop_lib-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 1.1.3
+Version: 1.2.0
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22

{job_shop_lib-1.1.3.dist-info → job_shop_lib-1.2.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-job_shop_lib/__init__.py,sha256=y-1uRgW-6xUddIIj3ksBlqxbSMJZkLZCSqBELQhL5mw,639
+job_shop_lib/__init__.py,sha256=yXJFP7NB9jntS26eZXQCVjeCM45KPFcc2FS1PbTCLm8,639
 job_shop_lib/_base_solver.py,sha256=p17XmtufNc9Y481cqZUT45pEkUmmW1HWG53dfhIBJH8,1363
 job_shop_lib/_job_shop_instance.py,sha256=FkMBy9Yb8cNEGswI9vlN3Wh4mhtEX-QuDbKvSYUOXcM,18361
 job_shop_lib/_operation.py,sha256=lwCjgXwWlgESFuV3Yh4SCVofPGCd3hJU4vnK7peREac,4235
@@ -9,14 +9,14 @@ job_shop_lib/benchmarking/_load_benchmark.py,sha256=-cgyx0Kn6uAc3KdGFSQb6eUVQjQg
 job_shop_lib/benchmarking/benchmark_instances.json,sha256=F9EvyzFwVxiKAN6rQTsrMhsKstmyUmroyWduM7a00KQ,464841
 job_shop_lib/constraint_programming/__init__.py,sha256=kKQRUxxS_nVFUdXGnf4bQOD9mqrXxZZWElS753A4YiA,454
 job_shop_lib/constraint_programming/_ortools_solver.py,sha256=oMPeA2VHoYX1ZvmygQ8kYew40ITLAQATmM4OhgVFuXM,10482
-job_shop_lib/dispatching/__init__.py,sha256=eyiCpCWIsx3LDoSOtPImjYAkI6R8t93kz56hM03WODE,2558
+job_shop_lib/dispatching/__init__.py,sha256=gbgY1_lhergmXaDa-VYVUmxMpOKzYko0ONREVAt_QPc,2643
 job_shop_lib/dispatching/_dispatcher.py,sha256=KnV_Kry3Ie81WbKhdpRQtOMsuFDNCuh5Kp2ZnelM-R8,23835
 job_shop_lib/dispatching/_dispatcher_observer_config.py,sha256=QF2d3rJWwmvutQBAkKxzQ1toJs6eMelT404LGS2z9HQ,2467
 job_shop_lib/dispatching/_factories.py,sha256=j3MhIwVXiq-B8JMit72ObvXSa2sdgWNhUD86gghL6Gg,4689
 job_shop_lib/dispatching/_history_observer.py,sha256=Vl8rQaxekUeEB-AyNxyC3c76zQakeh-rdri2iDnZvXw,610
 job_shop_lib/dispatching/_optimal_operations_observer.py,sha256=2EYxevjpeGMP3do-m0ZmtmjIjmNcxrWOSKzN_bW37gQ,4247
 job_shop_lib/dispatching/_ready_operation_filters.py,sha256=brhmhoyyoZ98wAEEfneZC-CD-aw9SerZHGMB1DpK8HY,5749
-job_shop_lib/dispatching/_start_time_calculators.py,sha256=sEtInDnFW9gsKDUEDUGQBaIjDWgCkFYvBca46j8XYfE,6408
+job_shop_lib/dispatching/_start_time_calculators.py,sha256=N4kz3c4TmXbyFsY6ctxruYK2ucnjSVXWNMhvsUWFuDg,8192
 job_shop_lib/dispatching/_unscheduled_operations_observer.py,sha256=0he-j4OlvqtXAJZD5x1nuBnUKqZUfftVx9NT3CVxPyg,2708
 job_shop_lib/dispatching/feature_observers/__init__.py,sha256=EuJLvSpJpoXUK8A4UuC2k6Mpa293ZR3oCnnvYivIBtU,2240
 job_shop_lib/dispatching/feature_observers/_composite_feature_observer.py,sha256=tpvqTLIcNmbYROSFT62LiUZ_tI4fHWL_qCULKK43BU4,6429
@@ -38,7 +38,7 @@ job_shop_lib/dispatching/rules/_utils.py,sha256=m5qw4qyfaIvVrkmv51nuhreizr98-cg8
 job_shop_lib/exceptions.py,sha256=ARzpoZJCvRIvOesCiqqFSRxkv6w9WwEXx0aBP-l2IKA,1597
 job_shop_lib/generation/__init__.py,sha256=QaWwuBfBNnOiG0OPiP_CV_flBu9dX7r2o_HwL47tREM,822
 job_shop_lib/generation/_general_instance_generator.py,sha256=b_tnyP4H_buoN7b6lKQRLvDkeZDdys0mpqS3thB5-SQ,6544
-job_shop_lib/generation/_instance_generator.py,sha256=rT7CAJuv6E0zbmRFE_MFY6iaeZB06BshsBHl2_GyPzU,4567
+job_shop_lib/generation/_instance_generator.py,sha256=doN6WySyI0k7wz3aKy_e6hj6t7WV3dNzve3YmTFShas,4584
 job_shop_lib/generation/_utils.py,sha256=TYBGt4Zjw94l6ukIjXBVAK3lmrrZXdyzyq_r1DMlL-E,3986
 job_shop_lib/graphs/__init__.py,sha256=wlYIiXTuZRE6Kx3K0RpPUoZikzoegBuN2hcdqMODtGk,2433
 job_shop_lib/graphs/_build_disjunctive_graph.py,sha256=UbUYdeQaaeEqLchcKJGHEFGl4wElfGLb1o_R-u8wqnA,5120
@@ -67,7 +67,7 @@ job_shop_lib/visualization/gantt/_plot_gantt_chart.py,sha256=_4UGUTRuIw0tLzsJD9G
 job_shop_lib/visualization/graphs/__init__.py,sha256=HUWzfgQLeklNROtjnxeJX_FIySo_baTXO6klx0zUVpQ,630
 job_shop_lib/visualization/graphs/_plot_disjunctive_graph.py,sha256=L9_ZGgvCFpGc2rTOdZESdtydFQqShjqedimIOhqZx6Y,16209
 job_shop_lib/visualization/graphs/_plot_resource_task_graph.py,sha256=nkkdZ-9_OBevw72Frecwzv1y3WyhGZ9r9lz0y9MXvZ8,13192
-job_shop_lib-1.1.3.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
-job_shop_lib-1.1.3.dist-info/METADATA,sha256=O0G7p67y75GHe-gVPEepppAQGETiswCfkaB7JmbmwnI,19130
-job_shop_lib-1.1.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-job_shop_lib-1.1.3.dist-info/RECORD,,
+job_shop_lib-1.2.0.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
+job_shop_lib-1.2.0.dist-info/METADATA,sha256=jn2o3HTpGzqzkYdagJfNM-IVheqnLQ6SEUnQQt69sYc,19130
+job_shop_lib-1.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+job_shop_lib-1.2.0.dist-info/RECORD,,