dycw-utilities 0.109.16__tar.gz → 0.109.17__tar.gz

{dycw_utilities-0.109.16 → dycw_utilities-0.109.17}/PKG-INFO

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

{dycw_utilities-0.109.16 → dycw_utilities-0.109.17}/pyproject.toml

@@ -92,7 +92,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.109.16"
+version = "0.109.17"
 
 [project.optional-dependencies]
 test = [
@@ -335,7 +335,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.109.16"
+current_version = "0.109.17"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.109.16 → dycw_utilities-0.109.17}/src/tests/test_hypothesis.py

@@ -29,7 +29,7 @@ from hypothesis.strategies import (
 from luigi import Task
 from numpy import inf, int64, isfinite, isinf, isnan, ravel, rint
 from pathvalidate import validate_filepath
-from pytest import raises
+from pytest import mark, raises
 from sqlalchemy import Column, Integer, MetaData, Table, insert, select
 from sqlalchemy.ext.asyncio import AsyncEngine
 
@@ -1033,6 +1033,7 @@ class TestTempPaths:
         assert len(set(path.iterdir())) == 0
 
     @given(path=temp_paths(), contents=sets(text_ascii(min_size=1), max_size=10))
+    @mark.flaky
     def test_writing_files(self, *, path: Path, contents: AbstractSet[str]) -> None:
         assert len(set(path.iterdir())) == 0
         as_set = set(maybe_yield_lower_case(contents))

{dycw_utilities-0.109.16 → dycw_utilities-0.109.17}/src/tests/test_numpy.py

@@ -27,7 +27,7 @@ from numpy.random import Generator
 from numpy.testing import assert_equal
 from pytest import mark, param, raises
 
-from utilities.hypothesis import float_arrays
+from utilities.hypothesis import float_arrays, pairs
 from utilities.numpy import (
     DEFAULT_RNG,
     AsIntError,
@@ -36,8 +36,13 @@ from utilities.numpy import (
     NDArrayF,
     NDArrayI,
     ShiftError,
+    SigmoidError,
+    _BoxCarLocationsError,
+    _BoxCarLowerBoundSlopeError,
+    _BoxCarUpperBoundSlopeError,
     array_indexer,
     as_int,
+    boxcar,
     discretize,
     fillna,
     filter_frequencies,
@@ -94,6 +99,7 @@ from utilities.numpy import (
     minimum,
     shift,
     shift_bool,
+    sigmoid,
 )
 
 if TYPE_CHECKING:
@@ -252,6 +258,56 @@ class TestDiscretize:
         assert_equal(result, expected)
 
 
+class TestBoxCar:
+    @given(
+        locs=pairs(floats(-10.0, 10.0), sorted=True),
+        slope_low=floats(0.1, 10.0),
+        slope_high=floats(0.1, 10.0),
+    )
+    def test_main(
+        self, *, locs: tuple[float, float], slope_low: float, slope_high: float
+    ) -> None:
+        loc_low, loc_high = locs
+        n = 1000
+        x = linspace(0, 2 * pi, n)
+        y = boxcar(
+            x,
+            loc_low=loc_low,
+            slope_low=slope_low,
+            loc_high=loc_high,
+            slope_high=slope_high,
+        )
+        assert y.shape == (n,)
+        assert is_between(y, 0.0, 1.0).all()
+
+    def test_error_locations(self) -> None:
+        n = 1000
+        x = linspace(0, 2 * pi, n)
+        with raises(
+            _BoxCarLocationsError,
+            match="Location parameters must be consistent; got 1.0 and -1.0",
+        ):
+            _ = boxcar(x, loc_low=1.0, loc_high=-1.0)
+
+    def test_error_lower_bound_slope(self) -> None:
+        n = 1000
+        x = linspace(0, 2 * pi, n)
+        with raises(
+            _BoxCarLowerBoundSlopeError,
+            match="Lower-bound slope parameter must be positive; got 0.0",
+        ):
+            _ = boxcar(x, slope_low=0.0)
+
+    def test_error_upper_bound_slope(self) -> None:
+        n = 1000
+        x = linspace(0, 2 * pi, n)
+        with raises(
+            _BoxCarUpperBoundSlopeError,
+            match="Upper-bound slope parameter must be positive; got 0.0",
+        ):
+            _ = boxcar(x, slope_high=0.0)
+
+
 class TestFillNa:
     @mark.parametrize(
         ("init", "value", "expected_v"),
@@ -1078,3 +1134,19 @@ class TestShiftBool:
             [fill_value if e is None else e for e in expected_v], dtype=bool
         )
         assert_equal(result, expected)
+
+
+class TestSigmoid:
+    @given(loc=floats(-10.0, 10.0), slope=floats(-10.0, -0.1) | floats(0.1, 10.0))
+    def test_main(self, *, loc: float, slope: float) -> None:
+        n = 1000
+        x = linspace(0, 2 * pi, n)
+        y = sigmoid(x, loc=loc, slope=slope)
+        assert y.shape == (n,)
+        assert is_between(y, 0.0, 1.0).all()
+
+    def test_error(self) -> None:
+        n = 1000
+        x = linspace(0, 2 * pi, n)
+        with raises(SigmoidError, match="Slope must be non-zero"):
+            _ = sigmoid(x, slope=0.0)

{dycw_utilities-0.109.16 → dycw_utilities-0.109.17}/src/tests/test_orjson.py

@@ -23,7 +23,7 @@ from hypothesis.strategies import (
 )
 from orjson import JSONDecodeError
 from polars import Object, String, UInt64
-from pytest import approx, raises
+from pytest import approx, mark, raises
 
 from tests.conftest import SKIPIF_CI_AND_WINDOWS
 from tests.test_operator import (
@@ -204,6 +204,7 @@ class TestGetLogRecords:
         min_log_file_line_num=integers() | none(),
         max_log_file_line_num=integers() | none(),
     )
+    @mark.flaky
     def test_filter(
         self,
         *,

{dycw_utilities-0.109.16 → dycw_utilities-0.109.17}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.109.16"
+__version__ = "0.109.17"

{dycw_utilities-0.109.16 → dycw_utilities-0.109.17}/src/utilities/numpy.py

@@ -14,6 +14,7 @@ from numpy import (
     digitize,
     dtype,
     errstate,
+    exp,
     flatnonzero,
     float64,
     floating,
@@ -133,6 +134,65 @@ class AsIntError(Exception): ...
 ##
 
 
+def boxcar(
+    array: NDArray[floating[Any]],
+    /,
+    *,
+    loc_low: float = -1.0,
+    slope_low: float = 1.0,
+    loc_high: float = 1.0,
+    slope_high: float = 1.0,
+    rtol: float | None = None,
+    atol: float | None = None,
+) -> NDArray[floating[Any]]:
+    """Construct a boxcar function."""
+    if not is_at_most(loc_low, loc_high, rtol=rtol, atol=atol):
+        raise _BoxCarLocationsError(low=loc_low, high=loc_high)
+    if not is_positive(slope_low, rtol=rtol, atol=atol):
+        raise _BoxCarLowerBoundSlopeError(slope=slope_low)
+    if not is_positive(slope_high, rtol=rtol, atol=atol):
+        raise _BoxCarUpperBoundSlopeError(slope=slope_high)
+    return (
+        sigmoid(array, loc=loc_low, slope=slope_low)
+        + sigmoid(array, loc=loc_high, slope=-slope_high)
+    ) / 2
+
+
+@dataclass(kw_only=True, slots=True)
+class BoxCarError(Exception): ...
+
+
+@dataclass(kw_only=True, slots=True)
+class _BoxCarLocationsError(BoxCarError):
+    low: float
+    high: float
+
+    @override
+    def __str__(self) -> str:
+        return f"Location parameters must be consistent; got {self.low} and {self.high}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _BoxCarLowerBoundSlopeError(BoxCarError):
+    slope: float
+
+    @override
+    def __str__(self) -> str:
+        return f"Lower-bound slope parameter must be positive; got {self.slope}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _BoxCarUpperBoundSlopeError(BoxCarError):
+    slope: float
+
+    @override
+    def __str__(self) -> str:
+        return f"Upper-bound slope parameter must be positive; got {self.slope}"
+
+
+##
+
+
 def discretize(x: NDArrayF, bins: int | Iterable[float], /) -> NDArrayF:
     """Discretize an array of floats.
 
@@ -847,6 +907,31 @@ def shift_bool(
 ##
 
 
+def sigmoid(
+    array: NDArray[floating[Any]],
+    /,
+    *,
+    loc: float = 0.0,
+    slope: float = 1.0,
+    rtol: float | None = None,
+    atol: float | None = None,
+) -> NDArray[floating[Any]]:
+    """Construct a sigmoid function."""
+    if is_zero(slope, rtol=rtol, atol=atol):
+        raise SigmoidError
+    return 1 / (1 + exp(-slope * (array - loc)))
+
+
+@dataclass(kw_only=True, slots=True)
+class SigmoidError(Exception):
+    @override
+    def __str__(self) -> str:
+        return "Slope must be non-zero"
+
+
+##
+
+
 def _is_close(
     x: Any,
     y: Any,
@@ -869,6 +954,7 @@ def _is_close(
 __all__ = [
     "DEFAULT_RNG",
     "AsIntError",
+    "BoxCarError",
     "FlatN0EmptyError",
     "FlatN0Error",
     "FlatN0MultipleError",
@@ -878,8 +964,10 @@ __all__ = [
     "NDArrayI",
     "NDArrayO",
     "ShiftError",
+    "SigmoidError",
     "array_indexer",
     "as_int",
+    "boxcar",
     "datetime64D",
     "datetime64M",
     "datetime64W",
@@ -948,4 +1036,5 @@ __all__ = [
     "maximum",
     "minimum",
     "shift_bool",
+    "sigmoid",
 ]