fix __array_ufunc_ and support for scalers (#66)

Author: NoureldinYosri

test/test_value_array.py

@@ -268,3 +268,21 @@ def test_invalid_unit_raises_error() -> None:
 def test_format() -> None:
     u = tu.GHz * np.random.random(10)
     assert f'{u}' == str(u)
+
+
+def test_ufunc() -> None:
+    x = np.float64(0.42)
+    y = tu.GHz * np.arange(4)[1:]
+
+    assert np.multiply(x, y).allclose(np.multiply(y, x))  # type: ignore[union-attr]
+    assert np.divide(x, y).allclose(np.divide(np.int64(1), np.divide(y, x)))  # type: ignore[union-attr]
+
+    with pytest.raises(UnitMismatchError):
+        _ = np.add(x, y)
+    with pytest.raises(UnitMismatchError):
+        _ = np.add(y, x)
+
+    with pytest.raises(UnitMismatchError):
+        _ = np.subtract(x, y)
+    with pytest.raises(UnitMismatchError):
+        _ = np.subtract(y, x)

test_perf/test_value_performance.py

@@ -74,7 +74,7 @@ def test_perf_repr(a: Value) -> str:
     return repr(a)
 
 
-@perf_goal(avg_nanos=600)
+@perf_goal(avg_nanos=800)
 def test_perf_parse_atom() -> Value:
     return Value(1, 'kilogram')
 

tunits/core/cython/derived_unit_data.pyx

@@ -78,7 +78,9 @@ __SI_DERIVED_UNITS = [
     DerivedUnitData('lx', 'lux', 'lm/m^2', use_prefixes=True),
     DerivedUnitData('Bq', 'becquerel', 'Hz', use_prefixes=True),
     DerivedUnitData('l', 'liter', 'm^3', exp10=-3, use_prefixes=True),
-    DerivedUnitData('phi0', 'magnetic_flux_quantum', 'J*s/C', value=2.067833831170082e-15, use_prefixes=True),
+    DerivedUnitData(
+        'phi0', 'magnetic_flux_quantum', 'J*s/C', value=2.067833831170082e-15, use_prefixes=True
+    ),
     DerivedUnitData('eV', 'electron_volt', 'N*m', value=1.602176634e-19, use_prefixes=False),
 ]
 
@@ -117,7 +119,7 @@ __OTHER_UNITS = [
     DerivedUnitData('psi', 'pounds_per_square_inch', 'Pa', 6894.75729317),
     DerivedUnitData('bar', 'barometric_pressure', 'Pa', 1e5),
     DerivedUnitData('atm', 'atmospheric_pressure', 'Pa', 101325.0),
-    DerivedUnitData('torr', 'mm_of_mercury', 'Pa', 101325.0/760),
+    DerivedUnitData('torr', 'mm_of_mercury', 'Pa', 101325.0 / 760),
 ]
 
 # Units that aren't technically exact, but close enough for our purposes.

tunits/core/cython/with_unit.pyx

@@ -199,7 +199,7 @@ cdef class WithUnit:
             if unit_val is None:
                 raise ValueError("Bad WithUnit scaling value: " + repr(value))
 
-        if isinstance(value, (int, float, np.ndarray)):
+        if isinstance(value, (numbers.Number, np.ndarray)):
             self.value = unit_val.value * value
             self.conv = unit_val.conv
             self.base_units = unit_val.base_units
@@ -259,7 +259,7 @@ cdef class WithUnit:
     def __mul__(left, b) -> 'WithUnit':
         cdef WithUnit right
         try:
-            if isinstance(b, (int, float)):
+            if isinstance(b, numbers.Number):
                 return left.__with_value(left.value * b)
             right = _in_WithUnit(b)
             if left._is_dimensionless() and right._is_dimensionless():
@@ -279,7 +279,7 @@ cdef class WithUnit:
             return NotImplemented
     def __rmul__(self, b):
         try:
-            if isinstance(b, (int, float)):
+            if isinstance(b, numbers.Number):
                 return self.__with_value(self.value * b)
             return self * b
         except NotTUnitsLikeError:
@@ -288,7 +288,7 @@ cdef class WithUnit:
     def __truediv__(a, b):
         cdef WithUnit left, right
         try:
-            if isinstance(b, (int, float)):
+            if isinstance(b, numbers.Number):
                 return a.__with_value(a.value / b)
             left = _in_WithUnit(a)
             right = _in_WithUnit(b)
@@ -322,7 +322,7 @@ cdef class WithUnit:
         cdef WithUnit left, right
         cdef double c
         try:
-            if isinstance(b, (int, float)):
+            if isinstance(b, numbers.Number):
                 return a.value//b, _in_WithUnit(a.value % b)
             left = _in_WithUnit(a)
             right = _in_WithUnit(b)
@@ -388,12 +388,6 @@ cdef class WithUnit:
     def imag(WithUnit self):
         return self.__with_value(self.value.imag)
 
-#    def round(WithUnit self, unit):
-#        try:
-#            return self.in_units_of(unit, True)
-#        except NotTUnitsLikeError:
-#            return NotImplemented
-
     def __int__(self):
         if self.base_units.unit_count != 0:
             raise UnitMismatchError(
@@ -673,22 +667,6 @@ cdef class WithUnit:
     def conjugate(self) -> 'WithUnit':
         return self.__with_value(self.value.conjugate())
 
-#    def floor(self, u):
-#        cdef WithUnit converted
-#        try:
-#            converted = self.in_units_of(u, False)
-#            return converted.__with_value(floor(converted.value))
-#        except NotTUnitsLikeError:
-#            return NotImplemented
-    
-#    def ceil(self, u):
-#        cdef WithUnit converted
-#        try:
-#            converted = self.in_units_of(u, False)
-#            return converted.__with_value(ceil(converted.value))
-#        except NotTUnitsLikeError:
-#            return NotImplemented
-
     def sign(self) -> int | np.ndarray:
         return np.sign(self.value_in_base_units())
 

tunits/core/cython/with_unit_value_array.pyx

@@ -95,32 +95,15 @@ class ValueArray(WithUnit):
 
     def __array_ufunc__(self, ufunc, method, *inputs, **kwargs):
         if method == "__call__":
+            is_value = isinstance(inputs[0], ValueArray)
             if ufunc == np.add:
-                return inputs[0] + inputs[1]
+                return inputs[0].__add__(inputs[1]) if is_value else inputs[1].__radd__(inputs[0])
             if ufunc == np.subtract:
-                return inputs[0] - inputs[1]
+                return inputs[0].__sub__(inputs[1]) if is_value else inputs[1].__rsub__(inputs[0])
             if ufunc == np.multiply:
-                if not isinstance(inputs[0], np.ndarray) and not isinstance(inputs[1], np.ndarray):
-                    return inputs[0] * inputs[1]
-                elif isinstance(inputs[0], np.ndarray):
-                    return inputs[1] * inputs[0]
-                elif isinstance(inputs[1], np.ndarray):
-                    return inputs[0] * inputs[1]
-                else:
-                    raise NotImplementedError(
-                        f"multiply not implemented for types {type(inputs[0])}, {type(inputs[1])}"
-                    )
+                return inputs[0].__mul__(inputs[1]) if is_value else inputs[1].__rmul__(inputs[0])
             if ufunc == np.divide:
-                if not isinstance(inputs[0], np.ndarray) and not isinstance(inputs[1], np.ndarray):
-                    return inputs[0] / inputs[1]
-                elif isinstance(inputs[0], np.ndarray):
-                    return inputs[1].__rtruediv__(inputs[0])
-                elif isinstance(inputs[1], np.ndarray):
-                    return inputs[0] / inputs[1]
-                else:
-                    raise NotImplementedError(
-                        f"divide not implemented for types {type(inputs[0])}, {type(inputs[1])}"
-                    )
+                return inputs[0].__truediv__(inputs[1]) if is_value else inputs[1].__rtruediv__(inputs[0])
             if ufunc == np.power:
                 return inputs[0] ** inputs[1]
             if ufunc in [np.positive, np.negative, np.abs, np.fabs, np.conj]: