spyrrow 0.4.0__cp312-cp312-macosx_10_12_x86_64.whl → 0.6.0__cp312-cp312-macosx_10_12_x86_64.whl

spyrrow/__init__.pyi

@@ -3,52 +3,51 @@ from typing import TypeAlias
 Point: TypeAlias = tuple[float, float]
 
 class Item:
-    id: int
+    id: str
     demand: int
     shape: list[Point]
     allowed_orientations: list[float]
 
     def __init__(
         self,
-        id: int,
+        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: The Item identifier for a given StripPackingInstance.
-              Best autoincremented as the instance verifies that all ids are presents starting from 0.
+            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:
     """
     An object representing where a copy of an Item was placed inside the strip.
 
     Attributes:
-        id (int): The Item identifier for a given StripPackingInstance.
-        translation (tuple[float,float]): the translation vector in the X-Y axis
-        rotation (float): The roation angle in degrees, assuming that the original Item was defined with 0° as its rotation angle.
+        id (str): The Item identifier referencing the items of the StripPackingInstance
+        rotation (float): The rotation angle in degrees, assuming that the original Item was defined with 0° as its rotation angle.
+          Use the origin (0.0,0.0) as the rotation point.
+        translation (tuple[float,float]): the translation vector in the X-Y axis. To apply after the rotation
     """
 
-    id: int
-    shape: list[Point]
+    id: str
     translation: Point
     rotation: float
 
@@ -82,14 +81,11 @@ class StripPackingInstance:
               An empty string '' can be used, if the user doesn't have a use for this name.
             strip_height (float): the fixed height of the strip. The unit should be compatible with the Item
             items (list[Item]): The Items which defines the instances. All Items should be defined with the same scale ( same length unit).
-              Items ids should be an increasing series starting at 0 until len(items)-1.
-
          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:
         """

{spyrrow-0.4.0.dist-info → spyrrow-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spyrrow
-Version: 0.4.0
+Version: 0.6.0
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -35,10 +35,10 @@ pip install spyrrow
 import spyrrow
 
 rectangle1 = spyrrow.Item(
-        0, [(0, 0), (1, 0), (1, 1), (0, 1), (0, 0)], demand=4, allowed_orientations=[0]
+        "rectangle", [(0, 0), (1, 0), (1, 1), (0, 1), (0, 0)], demand=4, allowed_orientations=[0]
     )
 triangle1 = spyrrow.Item(
-        1,
+         "triangle",
         [(0, 0), (1, 0), (1, 1), (0, 0)],
         demand=6,
         allowed_orientations=[0, 90, 180, -90],

spyrrow-0.6.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+spyrrow-0.6.0.dist-info/METADATA,sha256=hTkD2cL-edcgg30N50h0bCmFoB1y_gsrgevJWp76_iY,2156
+spyrrow-0.6.0.dist-info/WHEEL,sha256=l1vhwtWCYEW2jwRYHpKxbN3fl_lgdUpY7Hrp_A4sC3c,106
+spyrrow-0.6.0.dist-info/licenses/LICENSE.txt,sha256=JOcOnGFqH2ZNyuMV3DBGh5kNL_3IqaS5832hwXhZ-Js,1076
+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-312-darwin.so,sha256=SIYjbzfBPEulJolj0meGSUl2aDwt7JqM50djxJBSl2Q,1672460
+spyrrow-0.6.0.dist-info/RECORD,,

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

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.8.6)
+Generator: maturin (1.8.7)
 Root-Is-Purelib: false
 Tag: cp312-cp312-macosx_10_12_x86_64

spyrrow-0.4.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-spyrrow-0.4.0.dist-info/METADATA,sha256=xISpeyAxcBngcjpXGDIIwv7I3AfHo56GUUpwojWvk5A,2136
-spyrrow-0.4.0.dist-info/WHEEL,sha256=-QUWT7MMKZfETa5uozyIszqXlQtot_9l3DcmgGHlHAg,106
-spyrrow-0.4.0.dist-info/licenses/LICENSE.txt,sha256=JOcOnGFqH2ZNyuMV3DBGh5kNL_3IqaS5832hwXhZ-Js,1076
-spyrrow/__init__.py,sha256=MajlSBAliv8o8SqAqLgJARyi3egmvNIaXKTDXxvIAFY,111
-spyrrow/__init__.pyi,sha256=MZXI5_RK5wSwDwPSZIV-m75mgi_ZW35MQuPQVpAiFHc,4010
-spyrrow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-spyrrow/spyrrow.cpython-312-darwin.so,sha256=x88It7rZxdpnT8RuqbNj4jl5Ev2_dDcyH8QZN_PU_O4,1424300
-spyrrow-0.4.0.dist-info/RECORD,,