unitforge 0.5.12__tar.gz → 0.5.14__tar.gz

{unitforge-0.5.12 → unitforge-0.5.14}/Cargo.lock

@@ -351,7 +351,7 @@ checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512"
 
 [[package]]
 name = "unitforge"
-version = "0.5.12"
+version = "0.5.14"
 dependencies = [
  "ndarray",
  "num-traits",
@@ -367,7 +367,7 @@ dependencies = [
 
 [[package]]
 name = "unitforge_macros"
-version = "0.5.12"
+version = "0.5.14"
 dependencies = [
  "regex",
 ]

{unitforge-0.5.12 → unitforge-0.5.14}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "unitforge"
-version = "0.5.12"
+version = "0.5.14"
 edition = "2021"
 authors = ["Dr.Q team <info@askdrq.com>", "Henrik Stromberg <henrik@askdrq.com>"]
 description = "A library for unit and quantity consistent computations in Rust"
@@ -20,7 +20,7 @@ pyo3 = { version = "0.28.3", features = ["extension-module", "auto-initialize",
 numpy = { version = "0.28.0", optional = true }
 strum = { version = "0.28.0", optional = true }
 strum_macros = { version = "0.28.0", optional = true }
-unitforge_macros = { version = "0.5.12", path = "unitforge_macros" }
+unitforge_macros = { version = "0.5.14", path = "unitforge_macros" }
 
 [features]
 default = []

{unitforge-0.5.12 → unitforge-0.5.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitforge
-Version: 0.5.12
+Version: 0.5.14
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
 Classifier: License :: OSI Approved :: MIT License
@@ -72,6 +72,20 @@ f_sum = f1 + f2
 print(f_sum.to(ForceUnit.N))  # → 8.0
 ```
 
+### Comparing Quantities
+
+`==` is tolerance-based: two quantities are equal when they differ by at most `1e-9` of the larger
+magnitude. An infinity equals only itself, and NaN equals nothing. `<`, `<=`, `>` and `>=` compare
+exactly, so for nearly equal values `a == b` and `a < b` can both be true. For explicit tolerances
+use `a.close_abs(b, threshold)` (absolute, `threshold` is a quantity) or
+`a.close_rel(b, threshold)` (relative to the mean magnitude). Quantities are not hashable.
+
+```python
+a = Force(1.0, ForceUnit.N)
+b = Force(1.0 + 1e-12, ForceUnit.N)
+print(a == b, a < b)  # → True True
+```
+
 ---
 
 ## Vector and Matrix Support

{unitforge-0.5.12 → unitforge-0.5.14}/Readme.md

@@ -15,6 +15,17 @@
 - **Serialization**: Optional support for serde using `features = ["serde"]`; combine with `ndarray` for ndarray serialization support.
 - **python interface** Optional Python interface when building with flag pyo3; also available on pypi
 
+## Comparing quantities
+
+`==` is tolerance-based: two quantities are equal when they differ by at most `1e-9` of the larger
+magnitude. An infinity equals only itself, and NaN equals nothing. Ordering (`<`, `<=`, `>`, `>=`)
+compares the stored values exactly. As a consequence:
+
+- `==` is not transitive, and for nearly equal values `a == b` and `a < b` can both be true.
+- `Hash` hashes the exact stored value, so quantities that compare equal can hash differently. Do
+  not rely on hash-based collections to merge nearly equal quantities.
+- For an explicit, absolute tolerance use `a.is_close(&b, &tolerance)`.
+
 ## Contribute
 
 All contributions are welcome! Feel free to implement new quantities or define relations using `impl_macros.rs`. 🚀

{unitforge-0.5.12 → unitforge-0.5.14}/Readme_py.md

@@ -56,6 +56,20 @@ f_sum = f1 + f2
 print(f_sum.to(ForceUnit.N))  # → 8.0
 ```
 
+### Comparing Quantities
+
+`==` is tolerance-based: two quantities are equal when they differ by at most `1e-9` of the larger
+magnitude. An infinity equals only itself, and NaN equals nothing. `<`, `<=`, `>` and `>=` compare
+exactly, so for nearly equal values `a == b` and `a < b` can both be true. For explicit tolerances
+use `a.close_abs(b, threshold)` (absolute, `threshold` is a quantity) or
+`a.close_rel(b, threshold)` (relative to the mean magnitude). Quantities are not hashable.
+
+```python
+a = Force(1.0, ForceUnit.N)
+b = Force(1.0 + 1e-12, ForceUnit.N)
+print(a == b, a < b)  # → True True
+```
+
 ---
 
 ## Vector and Matrix Support

{unitforge-0.5.12 → unitforge-0.5.14}/python/unitforge/__init__.pyi

@@ -170,6 +170,7 @@ class Angle:
     def __rmul__(self, rhs: float) -> "Angle": ...
     def __repr__(self) -> str: ...
     def __str__(self) -> str: ...
+    def __rtruediv__(self, lhs: float) -> "InverseAngle": ...
     @staticmethod
     def pi() -> "Angle": ...
     @staticmethod
@@ -927,8 +928,6 @@ class Distance:
     @overload
     def __mul__(self, rhs: "ThermalConductivity") -> "ThermalConductance": ...
     @overload
-    def __mul__(self, rhs: "Velocity") -> "Time": ...
-    @overload
     def __mul__(self, rhs: "Volume") -> "AreaOfMoment": ...
     @overload
     def __mul__(self, rhs: Any) -> Any: ...
@@ -979,6 +978,7 @@ class Distance:
     def __rmul__(self, rhs: float) -> "Distance": ...
     def __repr__(self) -> str: ...
     def __str__(self) -> str: ...
+    def __rtruediv__(self, lhs: float) -> "InverseDistance": ...
     @staticmethod
     def a_0() -> "Distance": ...
     @staticmethod
@@ -1544,6 +1544,7 @@ class Frequency:
     def __rmul__(self, rhs: float) -> "Frequency": ...
     def __repr__(self) -> str: ...
     def __str__(self) -> str: ...
+    def __rtruediv__(self, lhs: float) -> "Time": ...
 
 class HeatCapacityUnit:
     J_K: ClassVar["HeatCapacityUnit"]
@@ -1685,6 +1686,7 @@ class InverseAngle:
     def __rmul__(self, rhs: float) -> "InverseAngle": ...
     def __repr__(self) -> str: ...
     def __str__(self) -> str: ...
+    def __rtruediv__(self, lhs: float) -> "Angle": ...
 
 class InverseAreaUnit:
     _msq: ClassVar["InverseAreaUnit"]
@@ -1802,6 +1804,7 @@ class InverseDistance:
     def __rmul__(self, rhs: float) -> "InverseDistance": ...
     def __repr__(self) -> str: ...
     def __str__(self) -> str: ...
+    def __rtruediv__(self, lhs: float) -> "Distance": ...
 
 class InverseStressUnit:
     _Pa: ClassVar["InverseStressUnit"]
@@ -3116,26 +3119,19 @@ class Time:
     @overload
     def __truediv__(self, rhs: float) -> "Time": ...
     @overload
-    def __truediv__(self, rhs: "Distance") -> "Velocity": ...
-    @overload
     def __truediv__(self, rhs: "Time") -> float: ...
     @overload
-    def __truediv__(self, rhs: "Velocity") -> "Distance": ...
-    @overload
     def __truediv__(self, rhs: Any) -> Any: ...
     @overload
     def __mod__(self, rhs: float) -> "Time": ...
     @overload
-    def __mod__(self, rhs: "Distance") -> "Velocity": ...
-    @overload
     def __mod__(self, rhs: "Time") -> float: ...
     @overload
-    def __mod__(self, rhs: "Velocity") -> "Distance": ...
-    @overload
     def __mod__(self, rhs: Any) -> Any: ...
     def __rmul__(self, rhs: float) -> "Time": ...
     def __repr__(self) -> str: ...
     def __str__(self) -> str: ...
+    def __rtruediv__(self, lhs: float) -> "Frequency": ...
 
 class UniversalGasConstantUnit:
     J_molK: ClassVar["UniversalGasConstantUnit"]
@@ -3209,8 +3205,6 @@ class Velocity:
     @overload
     def __mul__(self, rhs: "AngularVelocity") -> "Acceleration": ...
     @overload
-    def __mul__(self, rhs: "Distance") -> "Time": ...
-    @overload
     def __mul__(self, rhs: "Force") -> "Power": ...
     @overload
     def __mul__(self, rhs: "ForcePerVolume") -> "StressRate": ...
@@ -3359,7 +3353,7 @@ class VolumeUnit:
     incb: ClassVar["VolumeUnit"]
     ftcb: ClassVar["VolumeUnit"]
     ydcb: ClassVar["VolumeUnit"]
-    impgal: ClassVar["VolumeUnit"]
+    gal: ClassVar["VolumeUnit"]
 
 class Volume:
     def __init__(self, value: float, unit: "VolumeUnit") -> None: ...

{unitforge-0.5.12 → unitforge-0.5.14}/scripts/generate_python_stubs.py

@@ -388,8 +388,9 @@ def render_quantity_stub(
     lines.append("    def __repr__(self) -> str: ...")
     lines.append("    def __str__(self) -> str: ...")
 
-    if quantity.rtruediv_return:
-        lines.append(f'    def __rtruediv__(self, lhs: float) -> "{quantity.rtruediv_return}": ...')
+    rtruediv_return = operator_maps.div.get("f64", {}).get(q, quantity.rtruediv_return)
+    if rtruediv_return:
+        lines.append(f'    def __rtruediv__(self, lhs: float) -> "{rtruediv_return}": ...')
 
     for const_name in quantity.constants:
         lines.extend(