Add shape query method to Quantity.

Author: mjziebarth

README.md

@@ -172,6 +172,11 @@ This software is licensed under the European Public License (EUPL) version 1.2 o
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [0.2.0] - 2024-08-04
+#### Added
+- Add `shape` method for `Quantity`, which allows to query the (array-) shape
+  of the underlying data.
+
 ### [0.1.0] - 2024-05-05
 #### Added
 - Add `zeros_like` generator function for `Quantity` (Cython only)

cyantities/quantity.pyx

@@ -552,6 +552,15 @@ cdef class Quantity:
         return False
 
 
+    def shape(self) -> int | tuple[int,...]:
+        """
+        Return this quantity's shape.
+        """
+        if self._is_scalar:
+            return 1
+        return self._val_object.shape
+
+
     def unit(self) -> Unit:
         return generate_from_cpp(self._unit)
 

meson.build

@@ -1,5 +1,5 @@
 project('cyantities', 'cpp', 'cython',
-        version : '0.1.0', default_options : ['optimization=3'])
+        version : '0.2.0', default_options : ['optimization=3'])
 
 
 #

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "Cyantities"
-version = "0.1.0"
+version = "0.2.0"
 authors = [
     {name = "Malte J. Ziebarth", email = "mjz.science@fmvkb.de"},
 ]

testing/test_quantities.py

@@ -30,6 +30,10 @@ def test_quantity():
     q1 = Quantity(np.array([1.0, 2.0, 3.0]), 'm')
     q3 = Quantity(2.0, "kg")
 
+    # Shapes:
+    assert q0.shape() == q3.shape() == 1
+    assert q1.shape() == (3,)
+
     # Multiplication:
     q2 = q0 * q1
     assert q2.unit() == Unit("m^2")
@@ -38,6 +42,7 @@ def test_quantity():
 
     # Division:
     q4 = q0 / q1
+    assert q4.shape() == (3,)
     assert q4.unit() == Unit("1")
     assert (q4 * Unit("m")).unit() == Unit("m")
     assert np.all(q4 == Quantity(1.0 / np.array([1.0, 2.0, 3.0]), "1"))