Merge pull request #32 from invrs-io/ndim

add ndim property

.bumpversion.toml

@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "v0.6.4"
+current_version = "v0.7.0"
 commit = true
 commit_args = "--no-verify"
 tag = true

README.md

@@ -1,5 +1,5 @@
 # totypes - Custom types for topology optimization
-`v0.6.4`
+`v0.7.0`
 
 ## Overview
 

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 
 name = "totypes"
-version = "v0.6.4"
+version = "v0.7.0"
 description = "Custom datatypes useful in a topology optimization context"
 keywords = ["topology", "optimization", "jax", "inverse design"]
 readme = "README.md"

src/totypes/__init__.py

@@ -3,7 +3,7 @@
 Copyright (c) 2023 The INVRS-IO authors.
 """
 
-__version__ = "v0.6.4"
+__version__ = "v0.7.0"
 __author__ = "Martin F. Schubert <[email protected]>"
 
 __all__ = ["json_utils", "symmetry", "types"]

src/totypes/types.py

@@ -80,9 +80,14 @@ def __post_init__(self) -> None:
 
     @property
     def shape(self) -> Tuple[int, ...]:
-        """Returns the shape of the array."""
+        """Return the shape of the array."""
         return jnp.shape(self.array)  # type: ignore[no-any-return]
 
+    @property
+    def ndim(self) -> int:
+        """Return the number of dimensions of the array."""
+        return int(jnp.ndim(self.array))
+
 
 def _flatten_bounded_array(
     bounded_array: BoundedArray,
@@ -252,9 +257,14 @@ def __post_init__(self) -> None:
 
     @property
     def shape(self) -> Tuple[int, ...]:
-        """Returns the shape of the array."""
+        """Return the shape of the array."""
         return jnp.shape(self.array)  # type: ignore[no-any-return]
 
+    @property
+    def ndim(self) -> int:
+        """Return the number of dimensions of the array."""
+        return int(jnp.ndim(self.array))
+
 
 def _flatten_density_2d(
     density: Density2DArray,