spyrrow 0.5.0__cp311-cp311-musllinux_1_2_aarch64.whl → 0.7.0__cp311-cp311-musllinux_1_2_aarch64.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]
 
@@ -13,29 +14,28 @@ class Item:
         id: str,
         shape: list[Point],
         demand: int,
-        allowed_orientations: list[float],
+        allowed_orientations: list[float] | None,
     ):
         """
         An Item represents any closed 2D shape by its outer boundary.
 
         Spyrrow doesn't support hole(s) inside the shape as of yet. Therefore no Item can be nested inside another.
 
-        Continous rotation is not supported as of yet. A workaround  is to specify any integer degrees between 0 and 360
-        to the allowed_orientations list.
-
         Args:
             id (str): The Item identifier
               Needs to be unique accross all Items of a StripPackingInstance
             shape: An ordered list of (x,y) defining the shape boundary. The shape is represented as a polygon formed by this list of points.
               The origin point can be included twice as the finishing point. If not, [last point, first point] is infered to be the last straight line of the shape.
             demand: The quantity of identical Items to be placed inside the strip. Should be positive.
-            allowed_orientations: List of angles in degrees allowed. An empty list is equivalent to [0.].
+            allowed_orientations (list[float]|None): List of angles in degrees allowed.
+              An empty list is equivalent to [0.].
+              A None value means that the item is free to rotate
               The algorithmn is only very weakly sensible to the length of the list given.
 
         """
-    
-    def to_json_str(self)->str:
-        """ Return a string of the JSON representation of the object"""
+
+    def to_json_str(self) -> str:
+        """Return a string of the JSON representation of the object"""
 
 class PlacedItem:
     """
@@ -68,6 +68,61 @@ 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
@@ -85,17 +140,15 @@ class StripPackingInstance:
          Raises:
             ValueError
         """
-    def to_json_str(self)->str:
-        """ Return a string of the JSON representation of the object"""
-
+    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 config object to precise behavior of how to solve the strip packing instance.
 
         Returns:
             a StripPackingSolution

spyrrow-0.7.0.dist-info/METADATA

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: spyrrow
+Version: 0.7.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>
+Requires-Python: >=3.10
+Project-URL: documentation, https://spyrrow.readthedocs.io/
+Project-URL: source, https://github.com/PaulDL-RS/spyrrow

spyrrow-0.7.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+spyrrow-0.7.0.dist-info/METADATA,sha256=_HbJhdU3i7M7iN6o3jQYkVSYRJCi2aohSvGBA5ogvOk,480
+spyrrow-0.7.0.dist-info/WHEEL,sha256=xgMGzswzbwKwgKUg-kB8HNicNIzQYqJzMcClthXR1Y0,108
+spyrrow-0.7.0.dist-info/licenses/LICENSE.txt,sha256=JOcOnGFqH2ZNyuMV3DBGh5kNL_3IqaS5832hwXhZ-Js,1076
+spyrrow.libs/libgcc_s-e52197c3.so.1,sha256=vkPW1Auw6CH9Bjk7frmX3hry_1H9c0tRI0Ncyg71WUI,724137
+spyrrow/__init__.py,sha256=MajlSBAliv8o8SqAqLgJARyi3egmvNIaXKTDXxvIAFY,111
+spyrrow/__init__.pyi,sha256=9op4JPXX9L4-MAGMGDGIfQsc93Ch2p5CUsuT6xDUmeo,6453
+spyrrow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spyrrow/spyrrow.cpython-311-aarch64-linux-musl.so,sha256=QRR5AgSyq8Jy5dqAXtwriuBW-4UC1pa3TV9U_pyJeOQ,2034769
+spyrrow-0.7.0.dist-info/RECORD,,

{spyrrow-0.5.0.dist-info → spyrrow-0.7.0.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_aarch64

spyrrow-0.5.0.dist-info/METADATA

@@ -1,68 +0,0 @@
-Metadata-Version: 2.4
-Name: spyrrow
-Version: 0.5.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.5.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-spyrrow-0.5.0.dist-info/METADATA,sha256=EZ7iHM1m1vZwrtCdysrc_Z8jl-TFPOlZS8y7vUSWqeQ,2156
-spyrrow-0.5.0.dist-info/WHEEL,sha256=4KjY_ZR27kMkX5gtruwBG_t6p6hJa1OSoUF-wzwJLyU,108
-spyrrow-0.5.0.dist-info/licenses/LICENSE.txt,sha256=JOcOnGFqH2ZNyuMV3DBGh5kNL_3IqaS5832hwXhZ-Js,1076
-spyrrow.libs/libgcc_s-e52197c3.so.1,sha256=vkPW1Auw6CH9Bjk7frmX3hry_1H9c0tRI0Ncyg71WUI,724137
-spyrrow/__init__.py,sha256=MajlSBAliv8o8SqAqLgJARyi3egmvNIaXKTDXxvIAFY,111
-spyrrow/__init__.pyi,sha256=2r0Dy-uJY0lE4Q_-eT7E2aOx9965J4JQ9G9xwZv4zXY,3947
-spyrrow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-spyrrow/spyrrow.cpython-311-aarch64-linux-musl.so,sha256=CugvIkINoW-3vDSsYHCZVAROZNaIYSkHqJYVkdgN_f0,1903641
-spyrrow-0.5.0.dist-info/RECORD,,