polycubetools 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

polycubetools/__init__.py

@@ -10,9 +10,10 @@ Basic framework for working with polycubes in a 3-dimensional grid.
 __author__ = "Team Polycube"
 __title__ = "polycubetools"
 __license__ = "MIT"
-__version__ = "1.1.0"
+__version__ = "1.1.1"
 
 from . import utils as utils
+from .errors import *
 from .grid import *
 from .hull import *
 from .models import *

polycubetools/errors.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+__all__ = (
+    "InvalidVolumeException",
+    "PolycubeException",
+)
+
+
+class PolycubeException(Exception):
+    """Base exception for all errors raised by this library."""
+
+    pass
+
+
+class InvalidVolumeException(PolycubeException):
+    """Exception raised when failing to compute a volume."""
+
+    pass

polycubetools/hull.py

@@ -35,6 +35,11 @@ class AbstractHull(ABC):
         """Checks if the given coordinate is inside the hull."""
         pass
 
+    @abstractmethod
+    def inside_hull(self, pos: Coordinate) -> bool:
+        """Checks if the given coordinate is inside the hull or in its inner part."""
+        pass
+
     @abstractmethod
     def in_inner_part(self, pos: Coordinate) -> bool:
         """Checks if the given coordinate is inside the inner part of the hull."""
@@ -67,6 +72,9 @@ class CoordinateHull(AbstractHull):
     def in_hull(self, pos: Coordinate) -> bool:
         return pos in self.coords
 
+    def inside_hull(self, pos: Coordinate) -> bool:
+        return pos in self.coords or self.in_inner_part(pos)
+
     def in_inner_part(self, pos: Coordinate) -> bool:
         raise NotImplementedError(
             "Inner part is not defined for coordinate hulls (you can implement it in a subclass if needed)"
@@ -113,7 +121,14 @@ class CuboidHull(AbstractHull):
     def in_hull(self, pos: Coordinate) -> bool:
         minc, maxc = self.min_coord, self.max_coord
         px, py, pz = pos.x, pos.y, pos.z
-        return px == minc.x or px == maxc.x or py == minc.y or py == maxc.y or pz == minc.z or pz == maxc.z
+        return (
+            px == minc.x or px == maxc.x or py == minc.y or py == maxc.y or pz == minc.z or pz == maxc.z
+        ) and self.inside_hull(pos)
+
+    def inside_hull(self, pos: Coordinate) -> bool:
+        minc, maxc = self.min_coord, self.max_coord
+        px, py, pz = pos.x, pos.y, pos.z
+        return minc.x <= px <= maxc.x and minc.y <= py <= maxc.y and minc.z <= pz <= maxc.z
 
     def in_inner_part(self, pos: Coordinate) -> bool:
         minc, maxc = self.min_coord, self.max_coord

polycubetools/utils.py

@@ -5,6 +5,7 @@ import json
 import logging
 from typing import Any, TYPE_CHECKING
 
+from .errors import InvalidVolumeException
 from .models import TWENTY_SIX_NEIGHBORHOOD_DIRECTIONS, Polycube, RotatedPolycube, Coordinate
 
 if TYPE_CHECKING:
@@ -12,12 +13,10 @@ if TYPE_CHECKING:
 
 _logger = logging.getLogger(__name__)
 
-NO_VOLUME = -1
-MULTIPLE_VOLUME_COMPONENTS = -2
-ERROR_IN_ALGORITHM = -3
-
 __all__ = (
+    "collect_volume",
     "compute_volume",
+    "find_connected_component",
     "get_extreme_points",
     "is_valid_fence",
     "load_polycubes",
@@ -49,7 +48,7 @@ def _is_border_coordinate(coord: Coordinate, max_extrem_point: Coordinate, min_e
     )
 
 
-def _find_connected_component(visible_coords: set[Coordinate]) -> set[Coordinate]:
+def find_connected_component(visible_coords: set[Coordinate]) -> set[Coordinate]:
     """Finds all coordinates connected to the first coordinate in the set using 26-neighborhood."""
     start = visible_coords.pop()
     stack = [start]
@@ -86,7 +85,7 @@ def get_extreme_points(coords: set[Coordinate]) -> tuple[Coordinate, Coordinate]
     return Coordinate(x_max, y_max, z_max), Coordinate(x_min, y_min, z_min)
 
 
-def compute_volume(coords: set[Coordinate]) -> int:
+def collect_volume(coords: set[Coordinate]) -> set[Coordinate]:
     """Compute the volume from the hull formed by the coordinates"""
     max_extreme_point, min_extreme_point = get_extreme_points(coords)
     max_extreme_point = Coordinate(max_extreme_point.x + 1, max_extreme_point.y + 1, max_extreme_point.z + 1)
@@ -101,24 +100,32 @@ def compute_volume(coords: set[Coordinate]) -> int:
     }
 
     # the here popped coordinate is always outside the hull; this is because we added this outside new layer!
-    _find_connected_component(visible_coords)
+    find_connected_component(visible_coords)
 
-    # we return false because there is no second component, meaning the shape has no volume
     if not visible_coords:
         _logger.warning("No volume found! Only one component detected.")
-        return NO_VOLUME
+        return set()
 
-    volume_cubes = _find_connected_component(visible_coords)
+    volume_cubes = find_connected_component(visible_coords)
     if visible_coords:
         _logger.warning(
-            f"Found {len(volume_cubes)} as volume, but still {len(visible_coords)} unvisited cubes left. Exists another enclosed area!"
+            f"Found {len(volume_cubes)} as volume, but still {len(visible_coords)} unvisited cubes left. Another enclosed area exists!"
         )
-        return MULTIPLE_VOLUME_COMPONENTS
+        raise InvalidVolumeException("Volume has multiple components")
 
     if any(_is_border_coordinate(c, max_extreme_point, min_extreme_point) for c in volume_cubes):
         _logger.warning("Volume has been found on the border! Bug in the validation.")
-        return ERROR_IN_ALGORITHM
+        raise InvalidVolumeException("Volume has been found on the border")
+
+    return volume_cubes
 
+
+def compute_volume(coords: set[Coordinate]) -> int:
+    """
+    Ruft die Funktion collect_volume auf, um alle Punkte der Volumen-Komponente zu erhalten.
+    Die Anzahl dieser Punkte ist das Volumen.
+    """
+    volume_cubes = collect_volume(coords)
     return len(volume_cubes)
 
 

{polycubetools-1.1.0.dist-info → polycubetools-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polycubetools
-Version: 1.1.0
+Version: 1.1.1
 Summary: Basic framework for working with polycubes in a 3-dimensional grid.
 Author: Team Polycube
 Classifier: Development Status :: 3 - Alpha

polycubetools-1.1.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+polycubetools/__init__.py,sha256=SsX3s5dX-_GuxE7gFHU7hl4KV7ufB3tzmRAqOKUyOZw,394
+polycubetools/errors.py,sha256=dIb032TJFwQJkZL3HOjPbDL8Qz2l9oAsunQzCz8TOe4,339
+polycubetools/grid.py,sha256=UbUXxQ5opEAPKlPmbv7KIorUnRw41cuK7mkVoLDhqLE,7540
+polycubetools/hull.py,sha256=7D08x6Lt04Umj46E_sAebQFcFCiqIJMJ_mr_Jlw4sgU,4831
+polycubetools/models.py,sha256=5qi9WWOxYg8666x1LOkfyQoDSLf4Qzs3Z94-8N_zRLU,5128
+polycubetools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+polycubetools/solver.py,sha256=X_6dXQ9WBm4CRHXILvs2whXbxYjW-ZeChBczosKJ7vM,5918
+polycubetools/utils.py,sha256=mqlL0b60KQt7Mr8bpA8EPxKV6S_cukkOk-1k8EwFwvg,7212
+polycubetools/data/heptacubes.json,sha256=vQ9QA3J5vOtjqw9wFYYDLLhmw7oMmOYzNdmTRiMga20,15393824
+polycubetools/data/hexacubes.json,sha256=klfA_tcan_J0CFsOaQdmZgerbVIWDEN1yjW2tq31kd8,1986336
+polycubetools/data/pentacubes.json,sha256=U3lpdByY9jPlDQRcuOUxS3xQBGpPwh9MNpEeSYTq7KE,259662
+polycubetools-1.1.1.dist-info/licenses/LICENSE,sha256=dhlyH2n5C_8e4NuZqQk-CKpYSg8BaCHKep2mPLBZHiQ,1064
+polycubetools-1.1.1.dist-info/METADATA,sha256=XFCP5VjTb_yidA7CWDy77u_1UTOwXaE_-7RWHiyoOHQ,1476
+polycubetools-1.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+polycubetools-1.1.1.dist-info/top_level.txt,sha256=3pdiwnGYfuq3VSO8Y5L2wJYyU2U87PrfH5BBcBZjeKI,14
+polycubetools-1.1.1.dist-info/RECORD,,

{polycubetools-1.1.0.dist-info → polycubetools-1.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

polycubetools-1.1.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-polycubetools/__init__.py,sha256=nvdLE5imasBZJQvtr79OrJ7eCPAVSirOWbGIkin96qM,372
-polycubetools/grid.py,sha256=UbUXxQ5opEAPKlPmbv7KIorUnRw41cuK7mkVoLDhqLE,7540
-polycubetools/hull.py,sha256=tM6pipw05fAWJ3N0KXgzCpXnZbQsRljPUXAinNXOd2w,4257
-polycubetools/models.py,sha256=5qi9WWOxYg8666x1LOkfyQoDSLf4Qzs3Z94-8N_zRLU,5128
-polycubetools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-polycubetools/solver.py,sha256=X_6dXQ9WBm4CRHXILvs2whXbxYjW-ZeChBczosKJ7vM,5918
-polycubetools/utils.py,sha256=80gA7bVXO5hxLuHNbsfC_s9Wz7shBubMWyKVm52Taw8,6928
-polycubetools/data/heptacubes.json,sha256=vQ9QA3J5vOtjqw9wFYYDLLhmw7oMmOYzNdmTRiMga20,15393824
-polycubetools/data/hexacubes.json,sha256=klfA_tcan_J0CFsOaQdmZgerbVIWDEN1yjW2tq31kd8,1986336
-polycubetools/data/pentacubes.json,sha256=U3lpdByY9jPlDQRcuOUxS3xQBGpPwh9MNpEeSYTq7KE,259662
-polycubetools-1.1.0.dist-info/licenses/LICENSE,sha256=dhlyH2n5C_8e4NuZqQk-CKpYSg8BaCHKep2mPLBZHiQ,1064
-polycubetools-1.1.0.dist-info/METADATA,sha256=Pwsw00NgRNvTq-YNjAA0KC-HhkmWMG3vQ7NBhb14qtQ,1476
-polycubetools-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-polycubetools-1.1.0.dist-info/top_level.txt,sha256=3pdiwnGYfuq3VSO8Y5L2wJYyU2U87PrfH5BBcBZjeKI,14
-polycubetools-1.1.0.dist-info/RECORD,,