job-shop-lib 1.1.3__py3-none-any.whl → 1.3.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.3.0"
 
 __all__ = [
     "Operation",

job_shop_lib/_schedule.py

@@ -2,12 +2,15 @@
 
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, TYPE_CHECKING
 from collections import deque
 
 from job_shop_lib import ScheduledOperation, JobShopInstance
 from job_shop_lib.exceptions import ValidationError
 
+if TYPE_CHECKING:
+    from job_shop_lib.dispatching import Dispatcher
+
 
 class Schedule:
     r"""Data structure to store a complete or partial solution for a particular
@@ -148,6 +151,7 @@ class Schedule:
     def from_job_sequences(
         instance: JobShopInstance,
         job_sequences: list[list[int]],
+        dispatcher: Dispatcher | None = None,
     ) -> Schedule:
         """Creates an active schedule from a list of job sequences.
 
@@ -163,13 +167,27 @@ class Schedule:
                 A list of lists of job ids. Each list of job ids represents the
                 order of operations on the machine. The machine that the list
                 corresponds to is determined by the index of the list.
+            dispatcher:
+                A :class:`~job_shop_lib.dispatching.Dispatcher` to use for
+                scheduling. If not provided, a new dispatcher will be
+                created.
+
+                .. note::
+                    You will need to provide a dispatcher if you want to
+                    take into account start time calculators different from
+                    the default one.
 
         Returns:
             A :class:`Schedule` object with the given job sequences.
+
+        .. seealso::
+            See :mod:`job_shop_lib.dispatching` for more information
+            about dispatchers and the start time calculators available.
         """
         from job_shop_lib.dispatching import Dispatcher
 
-        dispatcher = Dispatcher(instance)
+        if dispatcher is None:
+            dispatcher = Dispatcher(instance)
         dispatcher.reset()
         raw_solution_deques = [deque(job_ids) for job_ids in job_sequences]
 
@@ -307,3 +325,11 @@ class Schedule:
             return False
 
         return self.schedule == value.schedule
+
+    def copy(self) -> Schedule:
+        """Returns a copy of the schedule."""
+        return Schedule(
+            self.instance,
+            [machine_schedule.copy() for machine_schedule in self.schedule],
+            **self.metadata,
+        )

job_shop_lib/constraint_programming/_ortools_solver.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, Sequence
 import time
 
 from ortools.sat.python import cp_model
@@ -64,14 +64,28 @@ class ORToolsSolver(BaseSolver):
         self.solver = cp_model.CpSolver()
         self._operations_start: dict[Operation, tuple[IntVar, IntVar]] = {}
 
-    def __call__(self, instance: JobShopInstance) -> Schedule:
+    def __call__(
+        self,
+        instance: JobShopInstance,
+        arrival_times: Sequence[Sequence[int]] | None = None,
+        deadlines: Sequence[Sequence[int]] | None = None,
+    ) -> Schedule:
         """Equivalent to calling the :meth:`~ORToolsSolver.solve` method.
 
         This method is necessary because, in JobShopLib, solvers are defined
         as callables that receive an instance and return a schedule.
 
         Args:
-            instance: The job shop instance to be solved.
+            instance:
+                The job shop instance to be solved.
+            arrival_times:
+                Optional arrival times for each operation.
+                If provided, the solver will ensure that operations do not
+                start before their respective arrival times.
+            deadlines:
+                Optional deadlines for each operation.
+                If provided, the solver will ensure that operations are
+                completed before their respective deadlines.
 
         Returns:
             The best schedule found by the solver.
@@ -84,14 +98,30 @@ class ORToolsSolver(BaseSolver):
         """
         # Re-defined here since we already add metadata to the schedule in
         # the solve method.
-        return self.solve(instance)
+        return self.solve(
+            instance, arrival_times=arrival_times, deadlines=deadlines
+        )
 
-    def solve(self, instance: JobShopInstance) -> Schedule:
+    def solve(
+        self,
+        instance: JobShopInstance,
+        arrival_times: Sequence[Sequence[int]] | None = None,
+        deadlines: Sequence[Sequence[int]] | None = None,
+    ) -> Schedule:
         """Creates the variables, constraints and objective, and solves the
         problem.
 
         Args:
-            instance: The job shop instance to be solved.
+            instance:
+                The job shop instance to be solved.
+            arrival_times:
+                Optional arrival times for each operation.
+                If provided, the solver will ensure that operations do not
+                start before their respective arrival times.
+            deadlines:
+                Optional deadlines for each operation.
+                If provided, the solver will ensure that operations are
+                completed before their respective deadlines.
 
         Returns:
             The best schedule found by the solver.
@@ -107,7 +137,9 @@ class ORToolsSolver(BaseSolver):
                 If no solution could be found for the given problem within the
                 time limit.
         """
-        self._initialize_model(instance)
+        self._initialize_model(
+            instance, arrival_times=arrival_times, deadlines=deadlines
+        )
 
         start_time = time.perf_counter()
         status = self.solver.Solve(self.model)
@@ -128,7 +160,12 @@ class ORToolsSolver(BaseSolver):
         }
         return self._create_schedule(instance, metadata)
 
-    def _initialize_model(self, instance: JobShopInstance):
+    def _initialize_model(
+        self,
+        instance: JobShopInstance,
+        arrival_times: Sequence[Sequence[int]] | None = None,
+        deadlines: Sequence[Sequence[int]] | None = None,
+    ):
         """Initializes the model with variables, constraints and objective.
 
         The model is initialized with two variables for each operation: start
@@ -147,7 +184,9 @@ class ORToolsSolver(BaseSolver):
             self.solver.parameters.max_time_in_seconds = (
                 self.max_time_in_seconds
             )
-        self._create_variables(instance)
+        self._create_variables(
+            instance, arrival_times=arrival_times, deadlines=deadlines
+        )
         self._add_constraints(instance)
         self._set_objective(instance)
 
@@ -177,15 +216,35 @@ class ORToolsSolver(BaseSolver):
             instance=instance, schedule=sorted_schedule, **metadata
         )
 
-    def _create_variables(self, instance: JobShopInstance):
+    def _create_variables(
+        self,
+        instance: JobShopInstance,
+        arrival_times: Sequence[Sequence[int]] | None = None,
+        deadlines: Sequence[Sequence[int]] | None = None,
+    ):
         """Creates two variables for each operation: start and end time."""
         for job in instance.jobs:
             for operation in job:
+                # Initial Naive Bounds
+                lower_bound = 0
+                upper_bound = instance.total_duration
+
+                if arrival_times is not None:
+                    lower_bound = arrival_times[operation.job_id][
+                        operation.position_in_job
+                    ]
+
+                if deadlines is not None:
+                    op_deadline = deadlines[operation.job_id][
+                        operation.position_in_job
+                    ]
+                    upper_bound = op_deadline
+
                 start_var = self.model.NewIntVar(
-                    0, instance.total_duration, f"start_{operation}"
+                    lower_bound, upper_bound, f"start_{operation}"
                 )
                 end_var = self.model.NewIntVar(
-                    0, instance.total_duration, f"end_{operation}"
+                    lower_bound, upper_bound, f"end_{operation}"
                 )
                 self._operations_start[operation] = (start_var, end_var)
                 self.model.Add(end_var == start_var + operation.duration)

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.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 1.1.3
+Version: 1.3.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.3.0.dist-info}/RECORD

@@ -1,22 +1,22 @@
-job_shop_lib/__init__.py,sha256=y-1uRgW-6xUddIIj3ksBlqxbSMJZkLZCSqBELQhL5mw,639
+job_shop_lib/__init__.py,sha256=FHzL2Kx7_4FCgaaLxzb_RdTRDQgF-CraofLgc2IdSqs,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
-job_shop_lib/_schedule.py,sha256=PX3wOv9Cw8NgjBLV3yDJW0mNl7a25nvoEV5Hdv7R_-g,11943
+job_shop_lib/_schedule.py,sha256=3PgDZ-DZmlESh5TASNHTqW_8Z7XPVSF64knvXEGRIbM,12927
 job_shop_lib/_scheduled_operation.py,sha256=czrGr87EOTlO2NPolIN5CDigeiCzvQEyra5IZPwSFZc,2801
 job_shop_lib/benchmarking/__init__.py,sha256=JPnCw5mK7sADAW0HctVKHEDRw22afp9caNh2eUS36Ys,3290
 job_shop_lib/benchmarking/_load_benchmark.py,sha256=-cgyx0Kn6uAc3KdGFSQb6eUVQjQggmpVKOH9qusNkXI,2930
 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/constraint_programming/_ortools_solver.py,sha256=LMpfpgiU2etrtyVTKVKyZW1PVMrOG2TenWzfGuEGf2I,12710
+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.3.0.dist-info/LICENSE,sha256=9mggivMGd5taAu3xbmBway-VQZMBzurBGHofFopvUsQ,1069
+job_shop_lib-1.3.0.dist-info/METADATA,sha256=oVgHOo9l8-crgD3w_uiR5zU6B0m9gxRAI0IPu7pSnpU,19130
+job_shop_lib-1.3.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+job_shop_lib-1.3.0.dist-info/RECORD,,