dycw-utilities 0.159.2__tar.gz → 0.159.3__tar.gz

{dycw_utilities-0.159.2 → dycw_utilities-0.159.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.159.2
+Version: 0.159.3
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.159.2 → dycw_utilities-0.159.3}/pyproject.toml

@@ -227,7 +227,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.159.2"
+version = "0.159.3"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -259,7 +259,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.159.2"
+current_version = "0.159.3"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.159.2 → dycw_utilities-0.159.3}/src/tests/test_polars.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import datetime as dt
 import enum
 import itertools
+import math
 from dataclasses import dataclass, field
 from enum import auto
 from itertools import chain, repeat
@@ -1828,6 +1829,18 @@ class TestIntegers:
         assert series.is_between(0, high, closed="left").all()
 
 
+class TestIsClose:
+    @given(values=pairs(float64s()), rel_tol=floats(0.0, 1.0), abs_tol=floats(0.0, 1.0))
+    def test_main(
+        self, *, values: tuple[float, float], rel_tol: float, abs_tol: float
+    ) -> None:
+        x, y = values
+        x_sr, y_sr = [Series(values=[i], dtype=Float64) for i in values]
+        result = utilities.polars.is_close(x_sr, y_sr, rel_tol=rel_tol, abs_tol=abs_tol)
+        expected = math.isclose(x, y, rel_tol=rel_tol, abs_tol=abs_tol)
+        assert result.item() is expected
+
+
 class TestIsNearEvent:
     df: ClassVar[DataFrame] = DataFrame(
         data=[

{dycw_utilities-0.159.2 → dycw_utilities-0.159.3}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.159.2"
+__version__ = "0.159.3"

{dycw_utilities-0.159.2 → dycw_utilities-0.159.3}/src/utilities/polars.py

@@ -36,6 +36,7 @@ from polars import (
     datetime_range,
     int_range,
     lit,
+    max_horizontal,
     struct,
     sum_horizontal,
     when,
@@ -1641,6 +1642,42 @@ def integers(
 ##
 
 
+@overload
+def is_close(
+    x: ExprLike, y: ExprLike, /, *, rel_tol: float = 1e-9, abs_tol: float = 0
+) -> Expr: ...
+@overload
+def is_close(
+    x: Series, y: Series, /, *, rel_tol: float = 1e-9, abs_tol: float = 0
+) -> Series: ...
+@overload
+def is_close(
+    x: IntoExprColumn,
+    y: IntoExprColumn,
+    /,
+    *,
+    rel_tol: float = 1e-9,
+    abs_tol: float = 0,
+) -> ExprOrSeries: ...
+def is_close(
+    x: IntoExprColumn,
+    y: IntoExprColumn,
+    /,
+    *,
+    rel_tol: float = 1e-9,
+    abs_tol: float = 0,
+) -> ExprOrSeries:
+    """Check if two columns are close."""
+    x, y = map(ensure_expr_or_series, [x, y])
+    result = (x - y).abs() <= max_horizontal(
+        rel_tol * max_horizontal(x.abs(), y.abs()), abs_tol
+    )
+    return try_reify_expr(result, x, y)
+
+
+##
+
+
 @overload
 def is_near_event(
     *exprs: ExprLike, before: int = 0, after: int = 0, **named_exprs: ExprLike
@@ -2603,6 +2640,7 @@ __all__ = [
     "insert_before",
     "insert_between",
     "integers",
+    "is_close",
     "is_false",
     "is_near_event",
     "is_true",

{dycw_utilities-0.159.2 → dycw_utilities-0.159.3}/src/utilities/types.py

@@ -79,6 +79,9 @@ type MaybeCoro[T] = T | Coro[T]
 
 
 # collections.abc
+type SupportsFloatOrIndex = SupportsFloat | SupportsIndex
+
+
 @runtime_checkable
 class SupportsKeysAndGetItem(Protocol[_T, _T_co]):
     def keys(self) -> Iterable[_T]: ...  # pragma: no cover
@@ -328,6 +331,7 @@ __all__ = [
     "SupportsBytes",
     "SupportsComplex",
     "SupportsFloat",
+    "SupportsFloatOrIndex",
     "SupportsGT",
     "SupportsInt",
     "SupportsInt",