spyrrow 0.6.0__cp311-cp311-musllinux_1_2_x86_64.whl → 0.7.2__cp311-cp311-musllinux_1_2_x86_64.whl

spyrrow/__init__.pyi

@@ -1,4 +1,5 @@
-from typing import TypeAlias
+from typing import TypeAlias, Optional
+from datetime import timedelta
 
 Point: TypeAlias = tuple[float, float]
 
@@ -67,6 +68,59 @@ class StripPackingSolution:
     density: float
     placed_items: list[PlacedItem]
 
+class StripPackingConfig:
+    early_termination: bool
+    seed: int
+    exploration_time: timedelta
+    compression_time: timedelta
+    quadtree_depth: int
+    num_wokers:Optional[int]
+    min_items_separation: Optional[float]
+
+    def __init__(
+        self,
+        early_termination: bool = True,
+        quadtree_depth: int = 4,
+        min_items_separation: Optional[float] = None,
+        total_computation_time: Optional[int] = 600,
+        exploration_time: Optional[int] = None,
+        compression_time: Optional[int] = None,
+        num_wokers:Optional[int]= None,
+        seed: Optional[int] = None,
+    ) -> None:
+        """Initializes a configuration object for the strip packing algorithm.
+
+        Either `total_computation_time`, or both `exploration_time` and `compression_time`, must be provided. 
+          Providing all three or only one of the latter two raises an error.
+        If `total_computation_time` is provided, 80% of it is allocated to exploration and 20% to compression.
+        If `seed` is not provided, a random seed will be generated.
+
+        
+        Args:
+            early_termination (bool, optional): Whether to allow early termination of the algorithm. Defaults to True.
+            quadtree_depth (int, optional): Maximum depth of the quadtree used by the collision detection engine jagua-rs. 
+              Must be positive, common values are 3,4,5. Defaults to 4.
+            min_items_separation (Optional[float], optional): Minimum required distance between packed items. Defaults to None.
+            total_computation_time (Optional[int], optional): Total time budget in seconds. 
+              Used if `exploration_time` and `compression_time` are not provided. Defaults to 600.
+            exploration_time (Optional[int], optional): Time in seconds allocated to exploration. Defaults to None.
+            compression_time (Optional[int], optional): Time in seconds allocated to compression. Defaults to None.
+            num_workers (Optional[int], optional): Number of threads used by the collision detection engine during exploration.
+              When set to None, detect the number of logical CPU cores on the execution plateform. Defaults to None.
+            seed (Optional[int], optional): Optional random seed to give reproductibility. If None, a random seed is generated. Defaults to None.
+
+        Raises:
+            ValueError: If the combination of time arguments is invalid.
+
+        """
+
+    def to_json_str(self)->str:
+        """Return a string of the JSON representation of the object
+
+        Returns:
+            str
+        """
+
 class StripPackingInstance:
     name: str
     strip_height: float
@@ -87,13 +141,12 @@ class StripPackingInstance:
     def to_json_str(self) -> str:
         """Return a string of the JSON representation of the object"""
 
-    def solve(self, computation_time: int = 600) -> StripPackingSolution:
+    def solve(self, config: StripPackingConfig) -> StripPackingSolution:
         """
         The method to solve the instance.
 
         Args:
-            computation_time (int): The total computation time in seconds used to find a solution.
-              The algorithm won't exit early.Waht you input is what you get. Default is 600 s = 10 minutes.
+            config (StripPackingConfig): The configuration object to control how the instance is solved.
 
         Returns:
             a StripPackingSolution

spyrrow-0.7.2.dist-info/METADATA

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: spyrrow
+Version: 0.7.2
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+License-File: LICENSE.txt
+Author-email: Paul Durand-Lupinski <paul.durand-lupinski@reeverse-systems.com>
+Requires-Python: >=3.10
+Project-URL: documentation, https://spyrrow.readthedocs.io/
+Project-URL: source, https://github.com/PaulDL-RS/spyrrow

spyrrow-0.7.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+spyrrow-0.7.2.dist-info/METADATA,sha256=Pe7I5ZZbd4Jj4-HCfs6kiuMLnGvThviz9f-ixTd75u8,480
+spyrrow-0.7.2.dist-info/WHEEL,sha256=4AHAltwFbkmLYCovWh433RDIDonhXBV3e1-avrmXJQg,107
+spyrrow-0.7.2.dist-info/licenses/LICENSE.txt,sha256=JOcOnGFqH2ZNyuMV3DBGh5kNL_3IqaS5832hwXhZ-Js,1076
+spyrrow.libs/libgcc_s-98a1ef30.so.1,sha256=XOVRhHznCIpbSdhFoozhla-OfRqBtXftKPQ4cSMKjrs,433441
+spyrrow/__init__.py,sha256=MajlSBAliv8o8SqAqLgJARyi3egmvNIaXKTDXxvIAFY,111
+spyrrow/__init__.pyi,sha256=MLil3REeOB6pTHvHX4CHKJ6m6chBQ-vCUm4theR8wq4,6430
+spyrrow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spyrrow/spyrrow.cpython-311-x86_64-linux-musl.so,sha256=8PD7UIDhVpHUl2Dr4V9ckPSgh-zP7H6rQPjEc__vUhU,1961049
+spyrrow-0.7.2.dist-info/RECORD,,

{spyrrow-0.6.0.dist-info → spyrrow-0.7.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.8.7)
+Generator: maturin (1.9.4)
 Root-Is-Purelib: false
 Tag: cp311-cp311-musllinux_1_2_x86_64

spyrrow-0.6.0.dist-info/METADATA

@@ -1,68 +0,0 @@
-Metadata-Version: 2.4
-Name: spyrrow
-Version: 0.6.0
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-License-File: LICENSE.txt
-Author-email: Paul Durand-Lupinski <paul.durand-lupinski@reeverse-systems.com>
-License: MIT
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-Project-URL: documentation, https://spyrrow.readthedocs.io/
-Project-URL: source, https://github.com/PaulDL-RS/spyrrow
-
-# Spyrrow
-
-`spyrrow` is a Python wrapper on the Rust project [`sparrow`](https://github.com/JeroenGar/sparrow).
-It enables to solve 2D [Strip packing problems](https://en.wikipedia.org/wiki/Strip_packing_problem). 
-
-The documentation is hosted [here](https://spyrrow.readthedocs.io/). 
-
-## Installation
-
-Spyrrow is hosted on [PyPI](https://pypi.org/project/spyrrow/).
-
-You can install with the package manager of your choice, using the PyPI package index.
-
-For example, with `pip`, the default Python package:
-```bash
-pip install spyrrow
-```
-
-## Examples
-```python
-import spyrrow
-
-rectangle1 = spyrrow.Item(
-        "rectangle", [(0, 0), (1, 0), (1, 1), (0, 1), (0, 0)], demand=4, allowed_orientations=[0]
-    )
-triangle1 = spyrrow.Item(
-         "triangle",
-        [(0, 0), (1, 0), (1, 1), (0, 0)],
-        demand=6,
-        allowed_orientations=[0, 90, 180, -90],
-    )
-
-instance = spyrrow.StripPackingInstance("test", strip_height=2.001, items=[rectangle1,triangle1])
-sol:spyrrow.StripPackingSolution = instance.solve(30)
-print(sol.width)
-print(sol.density)
-print("\n")
-for pi in sol.placed_items:
-    print(pi.id)
-    print(pi.rotation)
-    print(pi.translation)
-    print("\n")
-```
-
-## Contributing
-
-Spyrrow is open to contributions.
-The first target should be to reach  Python open sources packages standards and practices. 
-Second, a easier integration with the package `shapely` is envsionned.
-
-Please use GitHub issues to request features. 
-They will be considered relative to what is already implemented in the parent library `sparrow`. 
-If necessary, they can be forwarded to it. 
-

spyrrow-0.6.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-spyrrow-0.6.0.dist-info/METADATA,sha256=hTkD2cL-edcgg30N50h0bCmFoB1y_gsrgevJWp76_iY,2156
-spyrrow-0.6.0.dist-info/WHEEL,sha256=thThzBB4gSWx3fROzxY06Sf5oNWeNLw4Ow-HdbLhZb8,107
-spyrrow-0.6.0.dist-info/licenses/LICENSE.txt,sha256=JOcOnGFqH2ZNyuMV3DBGh5kNL_3IqaS5832hwXhZ-Js,1076
-spyrrow.libs/libgcc_s-1e52349c.so.1,sha256=Ani0u_W_tB8ESsFePO4D2mn2lrgWLhyFdw6RETxBTYM,437537
-spyrrow/__init__.py,sha256=MajlSBAliv8o8SqAqLgJARyi3egmvNIaXKTDXxvIAFY,111
-spyrrow/__init__.pyi,sha256=NqgZwO1Kh-acAVTdl6Z2YVhKLcCIF6GRHy2V_oZgJNc,3885
-spyrrow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-spyrrow/spyrrow.cpython-311-x86_64-linux-musl.so,sha256=VAViFcQO04MNJZa-pVk_ENvVR7FT6SqbhFjXLaIdKbk,1858593
-spyrrow-0.6.0.dist-info/RECORD,,