dycw-utilities 0.109.16__py3-none-any.whl → 0.109.17__py3-none-any.whl

{dycw_utilities-0.109.16.dist-info → dycw_utilities-0.109.17.dist-info}/METADATA

@@ -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.dist-info → dycw_utilities-0.109.17.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=4AFXsQvJMy-nibpq-XnsnHXbkRajpf73GAF_okhFQgY,61
+utilities/__init__.py,sha256=9W0BorEWmH8eCgNBXgx9zWKa3BNPPP1rlZfrx6qGCio,61
 utilities/altair.py,sha256=Gpja-flOo-Db0PIPJLJsgzAlXWoKUjPU1qY-DQ829ek,9156
 utilities/astor.py,sha256=xuDUkjq0-b6fhtwjhbnebzbqQZAjMSHR1IIS5uOodVg,777
 utilities/asyncio.py,sha256=41oQUurWMvadFK5gFnaG21hMM0Vmfn2WS6OpC0R9mas,14757
@@ -36,7 +36,7 @@ utilities/math.py,sha256=TexfvLCI12d9Sw5_W4pKVBZ3nRr3zk2iPkcEU7xdEWU,26771
 utilities/memory_profiler.py,sha256=tf2C51P2lCujPGvRt2Rfc7VEw5LDXmVPCG3z_AvBmbU,962
 utilities/modules.py,sha256=SnhsRHRUS1po_acejrINauihGQpPvVsp8RDNCei1OLQ,3173
 utilities/more_itertools.py,sha256=CPUxrMAcTwRxbzbhiqPKi3Xx9hxqI0t6gkWjutaibGk,5534
-utilities/numpy.py,sha256=-VCZZBUs9GaLxcPOHGVc_iLkVP_SEKKRL7YjV05jrS4,22961
+utilities/numpy.py,sha256=XMOaauVbssv_yrS1FdSnPExht3G4P8nAALmQsqHwp7w,25143
 utilities/operator.py,sha256=0M2yZJ0PODH47ogFEnkGMBe_cfxwZR02T_92LZVZvHo,3715
 utilities/optuna.py,sha256=loyJGWTzljgdJaoLhP09PT8Jz6o_pwBOwehY33lHkhw,1923
 utilities/orjson.py,sha256=Wj5pzG_VdgoAy14a7Luhem-BgYrRtRFvvl_POiszRd0,36930
@@ -86,7 +86,7 @@ utilities/warnings.py,sha256=yUgjnmkCRf6QhdyAXzl7u0qQFejhQG3PrjoSwxpbHrs,1819
 utilities/whenever.py,sha256=TjoTAJ1R27-rKXiXzdE4GzPidmYqm0W58XydDXp-QZM,17786
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=-DQz5a0Ikw9jfSZtL0BEQkXOMC9yGn_xiJYNCLMiqEc,1989
-dycw_utilities-0.109.16.dist-info/METADATA,sha256=u1Fl275S55bRfV6fTrMT8qHsS8_bu4aispHkIR6QNz8,13005
-dycw_utilities-0.109.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.109.16.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.109.16.dist-info/RECORD,,
+dycw_utilities-0.109.17.dist-info/METADATA,sha256=9BOdlf6JtDA2hK4ElsW-HsjxWLvub9HUqc1ds9r2CkY,13005
+dycw_utilities-0.109.17.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.109.17.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.109.17.dist-info/RECORD,,

utilities/__init__.py

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

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",
 ]