job-shop-lib 0.5.1__tar.gz → 1.0.0a2__tar.gz

{job_shop_lib-0.5.1 → job_shop_lib-1.0.0a2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: job-shop-lib
-Version: 0.5.1
+Version: 1.0.0a2
 Summary: An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP)
 License: MIT
 Author: Pabloo22
@@ -12,7 +12,8 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Provides-Extra: pygraphviz
-Requires-Dist: imageio (>=2,<3)
+Requires-Dist: gymnasium (>=0.29.1,<0.30.0)
+Requires-Dist: imageio[ffmpeg] (>=2.34.1,<3.0.0)
 Requires-Dist: matplotlib (>=3,<4)
 Requires-Dist: networkx (>=3,<4)
 Requires-Dist: numpy (>=1.26.4,<2.0.0)
@@ -23,9 +24,9 @@ Description-Content-Type: text/markdown
 
 <div align="center">
 
-<img src="images/logo_with_transparent_background.png" height="150px">
+<img src="docs/source/images/jslib_minimalist_logo_no_background_fixed.png" height="150px">
 
-<h1>Job Shop Library</h1>
+<h1>JobShopLib</h1>
 
 [![Tests](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml/badge.svg)](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml)
 ![Python versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
@@ -34,25 +35,57 @@ Description-Content-Type: text/markdown
 
 </div>
 
-An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
+JobShopLib is a Python package for creating, solving, and visualizing Job Shop Scheduling Problems (JSSP).
 
-It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools.
+It follows a modular design, allowing users to easily extend the library with new solvers, dispatching rules, visualization functions, etc.
 
-See the [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
 
-## Installation
+## Installation :package:
 
-You can install the library from PyPI:
+<!-- start installation -->
+
+JobShopLib is distributed on [PyPI](https://pypi.org/project/job-shop-lib/) and it supports Python 3.10+.
+
+You can install the latest version using `pip`:
 
 ```bash
 pip install job-shop-lib
 ```
 
-## Quick Start :rocket:
+<!-- end installation -->
+
+<!-- key features -->
+
+## Key Features :star:
+
+- **Data Structures**: Easily create, manage, and manipulate job shop instances and solutions with user-friendly data structures. See [Getting Started](docs/source/examples/00-Getting-Started.ipynb) and [How Solutions are Represented](docs/source/examples/01-How-Solutions-are-Represented.ipynb).
+
+- **Benchmark Instances**: Load well-known benchmark instances directly from the library without manual downloading. See [Load Benchmark Instances](docs/source/examples/05-Load-Benchmark-Instances.ipynb).
+
+- **Random Instance Generation**: Create random instances with customizable sizes and properties or augment existing ones. See [`generation`](job_shop_lib/generation) package.
+
+- **Multiple Solvers**:
+  - **Constraint Programming Solver**: OR-Tools' CP-SAT solver. See [Solving the Problem](docs/source/examples/02-Solving-the-Problem.ipynb).
+
+  - **Dispatching Rule Solvers**: Use any of the available dispatching rules or create custom ones. See [Dispatching Rules](docs/source/examples/03-Dispatching-Rules.ipynb).
+
+- **Gantt Charts**: Visualize final schedules and how are they created iteratively by dispatching rule solvers or sequences of scheduling decisions with GIFs or videos. See [Save Gif](docs/source/examples/06-Save-Gif.ipynb).
+
+- **Graph Representations**:
+  - **Disjunctive Graphs**: Represent and visualize instances as disjunctive graphs. See [Disjunctive Graph](docs/source/examples/04-Disjunctive-Graph.ipynb).
+  - **Agent-Task Graphs**: Encode instances as agent-task graphs (introduced in [ScheduleNet paper](https://arxiv.org/abs/2106.03051)). See [Agent-Task Graph](docs/source/examples/07-Agent-Task-Graph.ipynb).
+  - Build your own custom graphs with the `JobShopGraph` class.
+
+- **Gymnasium Environments**: Two environments for solving the problem with Graph Neural Networks (GNNs) or any other method, and Reinforcement Learning (RL). See [SingleJobShopGraphEnv](docs/source/examples/09-SingleJobShopGraphEnv.ipynb) and [MultiJobShopGraphEnv](examples/10-MultiJobShopGraphEnv.ipynb).
+
+<!-- end key features -->
+
+## Some Examples :rocket:
 
 ### Create a Job Shop Instance
 
-You can create a Job Shop Instance by defining the jobs and operations. An operation is defined by the machine(s) it is processed on and the duration (processing time).
+You can create a `JobShopInstance` by defining the jobs and operations. An operation is defined by the machine(s) it is processed on and the duration (processing time).
 
 ```python
 from job_shop_lib import JobShopInstance, Operation
@@ -83,7 +116,7 @@ from job_shop_lib.benchmarking import load_benchmark_instance
 ft06 = load_benchmark_instance("ft06")
 ```
 
-The module `benchmarks` contains functions to load the instances from the file and return them as `JobShopInstance` objects without having to download them
+The module `benchmarking` contains functions to load the instances from the file and return them as `JobShopInstance` objects without having to download them
 manually.
 
 The contributions to this benchmark dataset are as follows:
@@ -115,12 +148,12 @@ https://github.com/thomasWeise/jsspInstancesAndResults
 
 ### Generate a Random Instance
 
-You can also generate a random instance with the `BasicGenerator` class.
+You can also generate a random instance with the `GeneralInstanceGenerator` class.
 
 ```python
-from job_shop_lib.generators import BasicGenerator
+from job_shop_lib.generation import GeneralInstanceGenerator
 
-generator = BasicGenerator(
+generator = GeneralInstanceGenerator(
     duration_range=(5, 10), seed=42, num_jobs=5, num_machines=5
 )
 random_instance = generator.generate()
@@ -129,7 +162,7 @@ random_instance = generator.generate()
 This class can also work as an iterator to generate multiple instances:
 
 ```python
-generator = BasicGenerator(iteration_limit=100, seed=42)
+generator = GeneralInstanceGenerator(iteration_limit=100, seed=42)
 instances = []
 for instance in generator:
     instances.append(instance)
@@ -145,7 +178,7 @@ Every solver is a `Callable` that receives a `JobShopInstance` and returns a `Sc
 ```python
 import matplotlib.pyplot as plt
 
-from job_shop_lib.cp_sat import ORToolsSolver
+from job_shop_lib.constraint_programming import ORToolsSolver
 from job_shop_lib.visualization import plot_gantt_chart
 
 solver = ORToolsSolver(max_time_in_seconds=10)
@@ -154,7 +187,7 @@ ft06_schedule = solver(ft06)
 fig, ax = plot_gantt_chart(ft06_schedule)
 plt.show()
 ```
-![Example Gannt Chart](images/ft06_solution.png)
+![Example Gannt Chart](docs/source/images/ft06_solution.png)
 
 ### Solve an Instance with a Dispatching Rule Solver
 
@@ -190,7 +223,7 @@ create_gif(
 )
 ```
 
-![Example Gif](examples/ft06_optimized.gif)
+![Example Gif](docs/source/examples/output/ft06_optimized.gif)
 
 The dashed red line represents the current time step, which is computed as the earliest time when the next operation can start.
 
@@ -217,11 +250,11 @@ fig = plot_disjunctive_graph(instance)
 plt.show()
 ```
 
-![Example Disjunctive Graph](images/example_disjunctive_graph.png)
+![Example Disjunctive Graph](docs/source/images/example_disjunctive_graph.png)
 
 
-> [!WARNING]
-> This plot function requires having the optional dependency [PyGraphViz](https://pygraphviz.github.io/) installed.
+> [!TIP]
+> Installing the optional dependency [PyGraphViz](https://pygraphviz.github.io/) is recommended.
 
 The `JobShopGraph` class provides easy access to the nodes, for example, to get all the nodes of a specific type:
 
@@ -276,7 +309,7 @@ plt.show()
 ```
 
 <div align="center">
-<img src="examples/agent_task_graph.png" width="300">
+<img src="docs/source/images/agent_task_graph.png" width="300">
 </div>
 <br>
 
@@ -286,43 +319,34 @@ For more details, check the [examples](examples) folder.
 
 ## Installation for development
 
-### With Poetry
+<!-- start installation development -->
 
 1. Clone the repository.
 
-2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
-```bash
-pip install poetry==1.7
-```
-3. Create the virtual environment:
 ```bash
-poetry shell
+git clone https://github.com/Pabloo22/job_shop_lib.git
+cd job_shop_lib
 ```
-4. Install dependencies:
+
+2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
+
 ```bash
-poetry install --with notebooks --with test --with lint --all-extras
+pip install poetry
 ```
-or equivalently:
+
+3. Install dependencies:
 ```bash
 make poetry_install_all 
 ```
 
-### With PyPI
-
-If you don't want to use Poetry, you can install the library directly from the source code:
-
-```bash
-git clone https://github.com/Pabloo22/job_shop_lib.git
-cd job_shop_lib
-pip install -e .
-```
+<!-- end installation development -->
 
-## License
+## License :scroll:
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 
-## References
+## References :books:
 
  - J. Adams, E. Balas, and D. Zawack, "The shifting bottleneck procedure
      for job shop scheduling," Management Science, vol. 34, no. 3,

{job_shop_lib-0.5.1 → job_shop_lib-1.0.0a2}/README.md

@@ -1,8 +1,8 @@
 <div align="center">
 
-<img src="images/logo_with_transparent_background.png" height="150px">
+<img src="docs/source/images/jslib_minimalist_logo_no_background_fixed.png" height="150px">
 
-<h1>Job Shop Library</h1>
+<h1>JobShopLib</h1>
 
 [![Tests](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml/badge.svg)](https://github.com/Pabloo22/job_shop_lib/actions/workflows/tests.yaml)
 ![Python versions](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)
@@ -11,25 +11,57 @@
 
 </div>
 
-An easy-to-use and modular Python library for the Job Shop Scheduling Problem (JSSP) with a special focus on graph representations.
+JobShopLib is a Python package for creating, solving, and visualizing Job Shop Scheduling Problems (JSSP).
 
-It provides intuitive data structures to represent instances and solutions, as well as solvers and visualization tools.
+It follows a modular design, allowing users to easily extend the library with new solvers, dispatching rules, visualization functions, etc.
 
-See the [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
+See [this](https://colab.research.google.com/drive/1XV_Rvq1F2ns6DFG8uNj66q_rcowwTZ4H?usp=sharing) Google Colab notebook for a quick start guide! 
 
-## Installation
+## Installation :package:
 
-You can install the library from PyPI:
+<!-- start installation -->
+
+JobShopLib is distributed on [PyPI](https://pypi.org/project/job-shop-lib/) and it supports Python 3.10+.
+
+You can install the latest version using `pip`:
 
 ```bash
 pip install job-shop-lib
 ```
 
-## Quick Start :rocket:
+<!-- end installation -->
+
+<!-- key features -->
+
+## Key Features :star:
+
+- **Data Structures**: Easily create, manage, and manipulate job shop instances and solutions with user-friendly data structures. See [Getting Started](docs/source/examples/00-Getting-Started.ipynb) and [How Solutions are Represented](docs/source/examples/01-How-Solutions-are-Represented.ipynb).
+
+- **Benchmark Instances**: Load well-known benchmark instances directly from the library without manual downloading. See [Load Benchmark Instances](docs/source/examples/05-Load-Benchmark-Instances.ipynb).
+
+- **Random Instance Generation**: Create random instances with customizable sizes and properties or augment existing ones. See [`generation`](job_shop_lib/generation) package.
+
+- **Multiple Solvers**:
+  - **Constraint Programming Solver**: OR-Tools' CP-SAT solver. See [Solving the Problem](docs/source/examples/02-Solving-the-Problem.ipynb).
+
+  - **Dispatching Rule Solvers**: Use any of the available dispatching rules or create custom ones. See [Dispatching Rules](docs/source/examples/03-Dispatching-Rules.ipynb).
+
+- **Gantt Charts**: Visualize final schedules and how are they created iteratively by dispatching rule solvers or sequences of scheduling decisions with GIFs or videos. See [Save Gif](docs/source/examples/06-Save-Gif.ipynb).
+
+- **Graph Representations**:
+  - **Disjunctive Graphs**: Represent and visualize instances as disjunctive graphs. See [Disjunctive Graph](docs/source/examples/04-Disjunctive-Graph.ipynb).
+  - **Agent-Task Graphs**: Encode instances as agent-task graphs (introduced in [ScheduleNet paper](https://arxiv.org/abs/2106.03051)). See [Agent-Task Graph](docs/source/examples/07-Agent-Task-Graph.ipynb).
+  - Build your own custom graphs with the `JobShopGraph` class.
+
+- **Gymnasium Environments**: Two environments for solving the problem with Graph Neural Networks (GNNs) or any other method, and Reinforcement Learning (RL). See [SingleJobShopGraphEnv](docs/source/examples/09-SingleJobShopGraphEnv.ipynb) and [MultiJobShopGraphEnv](examples/10-MultiJobShopGraphEnv.ipynb).
+
+<!-- end key features -->
+
+## Some Examples :rocket:
 
 ### Create a Job Shop Instance
 
-You can create a Job Shop Instance by defining the jobs and operations. An operation is defined by the machine(s) it is processed on and the duration (processing time).
+You can create a `JobShopInstance` by defining the jobs and operations. An operation is defined by the machine(s) it is processed on and the duration (processing time).
 
 ```python
 from job_shop_lib import JobShopInstance, Operation
@@ -60,7 +92,7 @@ from job_shop_lib.benchmarking import load_benchmark_instance
 ft06 = load_benchmark_instance("ft06")
 ```
 
-The module `benchmarks` contains functions to load the instances from the file and return them as `JobShopInstance` objects without having to download them
+The module `benchmarking` contains functions to load the instances from the file and return them as `JobShopInstance` objects without having to download them
 manually.
 
 The contributions to this benchmark dataset are as follows:
@@ -92,12 +124,12 @@ https://github.com/thomasWeise/jsspInstancesAndResults
 
 ### Generate a Random Instance
 
-You can also generate a random instance with the `BasicGenerator` class.
+You can also generate a random instance with the `GeneralInstanceGenerator` class.
 
 ```python
-from job_shop_lib.generators import BasicGenerator
+from job_shop_lib.generation import GeneralInstanceGenerator
 
-generator = BasicGenerator(
+generator = GeneralInstanceGenerator(
     duration_range=(5, 10), seed=42, num_jobs=5, num_machines=5
 )
 random_instance = generator.generate()
@@ -106,7 +138,7 @@ random_instance = generator.generate()
 This class can also work as an iterator to generate multiple instances:
 
 ```python
-generator = BasicGenerator(iteration_limit=100, seed=42)
+generator = GeneralInstanceGenerator(iteration_limit=100, seed=42)
 instances = []
 for instance in generator:
     instances.append(instance)
@@ -122,7 +154,7 @@ Every solver is a `Callable` that receives a `JobShopInstance` and returns a `Sc
 ```python
 import matplotlib.pyplot as plt
 
-from job_shop_lib.cp_sat import ORToolsSolver
+from job_shop_lib.constraint_programming import ORToolsSolver
 from job_shop_lib.visualization import plot_gantt_chart
 
 solver = ORToolsSolver(max_time_in_seconds=10)
@@ -131,7 +163,7 @@ ft06_schedule = solver(ft06)
 fig, ax = plot_gantt_chart(ft06_schedule)
 plt.show()
 ```
-![Example Gannt Chart](images/ft06_solution.png)
+![Example Gannt Chart](docs/source/images/ft06_solution.png)
 
 ### Solve an Instance with a Dispatching Rule Solver
 
@@ -167,7 +199,7 @@ create_gif(
 )
 ```
 
-![Example Gif](examples/ft06_optimized.gif)
+![Example Gif](docs/source/examples/output/ft06_optimized.gif)
 
 The dashed red line represents the current time step, which is computed as the earliest time when the next operation can start.
 
@@ -194,11 +226,11 @@ fig = plot_disjunctive_graph(instance)
 plt.show()
 ```
 
-![Example Disjunctive Graph](images/example_disjunctive_graph.png)
+![Example Disjunctive Graph](docs/source/images/example_disjunctive_graph.png)
 
 
-> [!WARNING]
-> This plot function requires having the optional dependency [PyGraphViz](https://pygraphviz.github.io/) installed.
+> [!TIP]
+> Installing the optional dependency [PyGraphViz](https://pygraphviz.github.io/) is recommended.
 
 The `JobShopGraph` class provides easy access to the nodes, for example, to get all the nodes of a specific type:
 
@@ -253,7 +285,7 @@ plt.show()
 ```
 
 <div align="center">
-<img src="examples/agent_task_graph.png" width="300">
+<img src="docs/source/images/agent_task_graph.png" width="300">
 </div>
 <br>
 
@@ -263,43 +295,34 @@ For more details, check the [examples](examples) folder.
 
 ## Installation for development
 
-### With Poetry
+<!-- start installation development -->
 
 1. Clone the repository.
 
-2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
-```bash
-pip install poetry==1.7
-```
-3. Create the virtual environment:
 ```bash
-poetry shell
+git clone https://github.com/Pabloo22/job_shop_lib.git
+cd job_shop_lib
 ```
-4. Install dependencies:
+
+2. Install [poetry](https://python-poetry.org/docs/) if you don't have it already:
+
 ```bash
-poetry install --with notebooks --with test --with lint --all-extras
+pip install poetry
 ```
-or equivalently:
+
+3. Install dependencies:
 ```bash
 make poetry_install_all 
 ```
 
-### With PyPI
-
-If you don't want to use Poetry, you can install the library directly from the source code:
-
-```bash
-git clone https://github.com/Pabloo22/job_shop_lib.git
-cd job_shop_lib
-pip install -e .
-```
+<!-- end installation development -->
 
-## License
+## License :scroll:
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
 
-## References
+## References :books:
 
  - J. Adams, E. Balas, and D. Zawack, "The shifting bottleneck procedure
      for job shop scheduling," Management Science, vol. 34, no. 3,

job_shop_lib-1.0.0a2/job_shop_lib/__init__.py

@@ -0,0 +1,29 @@
+"""Contains the main data structures and base classes.
+
+.. autosummary::
+    :nosignatures:
+
+    Operation
+    JobShopInstance
+    ScheduledOperation
+    Schedule
+    Solver
+    BaseSolver
+
+"""
+
+from job_shop_lib._operation import Operation
+from job_shop_lib._job_shop_instance import JobShopInstance
+from job_shop_lib._scheduled_operation import ScheduledOperation
+from job_shop_lib._schedule import Schedule
+from job_shop_lib._base_solver import BaseSolver, Solver
+
+
+__all__ = [
+    "Operation",
+    "JobShopInstance",
+    "ScheduledOperation",
+    "Schedule",
+    "Solver",
+    "BaseSolver",
+]

job_shop_lib-0.5.1/job_shop_lib/base_solver.py → job_shop_lib-1.0.0a2/job_shop_lib/_base_solver.py

@@ -33,5 +33,5 @@ class BaseSolver(abc.ABC):
         schedule = self.solve(instance)
         elapsed_time = time_start - time.perf_counter()
         schedule.metadata["elapsed_time"] = elapsed_time
-        schedule.metadata["solved_by"] = f"{self.__class__.__name__}"
+        schedule.metadata["solved_by"] = self.__class__.__name__
         return schedule

job_shop_lib-0.5.1/job_shop_lib/job_shop_instance.py → job_shop_lib-1.0.0a2/job_shop_lib/_job_shop_instance.py

@@ -7,6 +7,7 @@ import functools
 from typing import Any
 
 import numpy as np
+from numpy.typing import NDArray
 
 from job_shop_lib import Operation
 
@@ -267,7 +268,7 @@ class JobShopInstance:
         ]
 
     @functools.cached_property
-    def durations_matrix_array(self) -> np.ndarray:
+    def durations_matrix_array(self) -> NDArray[np.float32]:
         """Returns the duration matrix of the instance as a numpy array.
 
         The returned array has shape (num_jobs, max_num_operations_per_job).
@@ -284,7 +285,7 @@ class JobShopInstance:
         return self._fill_matrix_with_nans_2d(duration_matrix)
 
     @functools.cached_property
-    def machines_matrix_array(self) -> np.ndarray:
+    def machines_matrix_array(self) -> NDArray[np.float32]:
         """Returns the machines matrix of the instance as a numpy array.
 
         The returned array has shape (num_jobs, max_num_operations_per_job,
@@ -409,7 +410,9 @@ class JobShopInstance:
         return sum(self.job_durations)
 
     @staticmethod
-    def _fill_matrix_with_nans_2d(matrix: list[list[int]]) -> np.ndarray:
+    def _fill_matrix_with_nans_2d(
+        matrix: list[list[int]],
+    ) -> NDArray[np.float32]:
         """Fills a matrix with np.nan values.
 
         Args:
@@ -429,7 +432,9 @@ class JobShopInstance:
         return squared_matrix
 
     @staticmethod
-    def _fill_matrix_with_nans_3d(matrix: list[list[list[int]]]) -> np.ndarray:
+    def _fill_matrix_with_nans_3d(
+        matrix: list[list[list[int]]],
+    ) -> NDArray[np.float32]:
         """Fills a 3D matrix with np.nan values.
 
         Args:

job_shop_lib-1.0.0a2/job_shop_lib/_operation.py

@@ -0,0 +1,99 @@
+"""Home of the `Operation` class."""
+
+from __future__ import annotations
+
+from job_shop_lib.exceptions import UninitializedAttributeError
+
+
+class Operation:
+    """Stores machine and duration information for a job operation.
+
+    An operation is a task that must be performed on a machine. It is part of a
+    job and has a duration that represents the time it takes to complete the
+    task.
+
+    Tip:
+        To use custom attributes, such as due dates or priorities, subclass
+        this class and add the desired attributes.
+
+    Note:
+        To increase performance, some solvers such as the CP-SAT solver use
+        only integers to represent the operation's attributes. Should a
+        problem involve operations with non-integer durations, it would be
+        necessary to multiply all durations by a sufficiently large integer so
+        that every duration is an integer.
+
+    Args:
+        machines:
+            A list of machine ids that can perform the operation. If
+            only one machine can perform the operation, it can be passed as
+            an integer.
+        duration:
+            The time it takes to perform the operation.
+    """
+
+    __slots__ = {
+        "machines": (
+            "A list of machine ids that can perform the operation. If "
+            "only one machine can perform the operation, it can be passed as "
+            "an integer."
+        ),
+        "duration": (
+            "The time it takes to perform the operation. Often referred"
+            " to as the processing time."
+        ),
+        "job_id": "The id of the job the operation belongs to.",
+        "position_in_job": "The index of the operation in the job.",
+        "operation_id": (
+            "The id of the operation. This is unique within a "
+            ":class:`JobShopInstance`."
+        ),
+    }
+
+    def __init__(self, machines: int | list[int], duration: int):
+        self.machines = [machines] if isinstance(machines, int) else machines
+        self.duration = duration
+
+        # Defined outside the class by the JobShopInstance class:
+        self.job_id: int = -1
+        self.position_in_job: int = -1
+        self.operation_id: int = -1
+
+    @property
+    def machine_id(self) -> int:
+        """Returns the id of the machine associated with the operation.
+
+        Raises:
+            UninitializedAttributeError: If the operation has multiple machines
+            in its list.
+        """
+        if len(self.machines) > 1:
+            raise UninitializedAttributeError(
+                "Operation has multiple machines."
+            )
+        return self.machines[0]
+
+    def is_initialized(self) -> bool:
+        """Returns whether the operation has been initialized."""
+        return (
+            self.job_id == -1
+            or self.position_in_job == -1
+            or self.operation_id == -1
+        )
+
+    def __hash__(self) -> int:
+        return hash(self.operation_id)
+
+    def __eq__(self, value: object) -> bool:
+        if not isinstance(value, Operation):
+            return False
+        return self.__slots__ == value.__slots__
+
+    def __repr__(self) -> str:
+        machines = (
+            self.machines[0] if len(self.machines) == 1 else self.machines
+        )
+        return (
+            f"O(m={machines}, d={self.duration}, "
+            f"j={self.job_id}, p={self.position_in_job})"
+        )