mergeron 2025.739439.6__py3-none-any.whl → 2025.739439.9__py3-none-any.whl

mergeron/__init__.py

@@ -15,7 +15,7 @@ from ruamel import yaml
 
 _PKG_NAME: str = Path(__file__).parent.name
 
-VERSION = "2025.739439.6"
+VERSION = "2025.739439.9"
 
 __version__ = VERSION
 

mergeron/core/__init__.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from collections.abc import Callable, Mapping
+from collections.abc import Mapping
 from decimal import Decimal
 from types import MappingProxyType
 from typing import Any
@@ -40,15 +40,6 @@ class GuidelinesBoundary:
     """Area under the boundary."""
 
 
-@frozen
-class GuidelinesBoundaryCallable:
-    """A function to generate Guidelines boundary points, along with area and knot."""
-
-    boundary_function: Callable[[ArrayDouble], ArrayDouble]
-    area: float
-    s_naught: float = 0
-
-
 @frozen
 class INVTableData:
     """Represents individual table of FTC merger investigations data."""

mergeron/core/guidelines_boundary_functions.py

@@ -224,14 +224,14 @@ def diversion_share_boundary_wtd_avg(
     dps: int = 5,
 ) -> GuidelinesBoundary:
     R"""
-    Share combinations on the share-weighted average diversion ratio boundary.
+    Share combinations on the share-weighted average diversion share boundary.
 
     Parameters
     ----------
     _delta_star
-        Diversion share (:math:`\overline{d} / \overline{r}`)
+        Diversion share, :math:`\overline{d} / \overline{r}` or :math:`\overline{g} / (m^* \cdot \overline{r})`.
     _r_val
-        recapture ratio
+        Recapture ratio.
     agg_method
         Whether "arithmetic mean", "geometric mean", or "distance".
     weighting
@@ -424,7 +424,7 @@ def diversion_share_boundary_xact_avg(
     dps: int = 5,
 ) -> GuidelinesBoundary:
     R"""
-    Share combinations for the exact average diversion/share-ratio boundary.
+    Share combinations for the exact average diversion share boundary.
 
     Notes
     -----
@@ -462,9 +462,9 @@ def diversion_share_boundary_xact_avg(
     Parameters
     ----------
     _delta_star
-        Diversion share (:math:`\overline{d} / \overline{r}`).
+        Diversion share, :math:`\overline{d} / \overline{r}` or :math:`\overline{g} / (m^* \cdot \overline{r})`.
     _r_val
-        Recapture ratio
+        Recapture ratio.
     recapture_form
         Whether recapture-ratio is MNL-consistent ("inside-out") or has fixed
         value for both merging firms ("proportional").
@@ -591,7 +591,7 @@ def diversion_share_boundary_min(
     Parameters
     ----------
     _delta_star
-        Diversion share (:math:`\overline{d} / \overline{r}`).
+        Diversion share, :math:`\overline{d} / \overline{r}` or :math:`\overline{g} / (m^* \cdot \overline{r})`.
     _r_val
         Recapture ratio.
     recapture_form
@@ -635,7 +635,7 @@ def diversion_share_boundary_max(
     Parameters
     ----------
     _delta_star
-        Diversion share (:math:`\overline{d} / \overline{r}`).
+        Diversion share, :math:`\overline{d} / \overline{r}` or :math:`\overline{g} / (m^* \cdot \overline{r})`.
     _
         Placeholder for recapture ratio included for consistency with other
         share-ratio boundary functions.
@@ -704,9 +704,9 @@ def lerp[LerpT: (float, MPFloat, ArrayDouble, ArrayBIGINT)](
     Parameters
     ----------
     _x1, _x2
-        bounds :math:`x_1, x_2` to interpolate between.
+        Interpolation bounds :math:`x_1, x_2`.
     _r
-        interpolation weight :math:`r` assigned to :math:`x_2`
+        Interpolation weight :math:`r` assigned to :math:`x_2`
 
     Returns
     -------
@@ -728,14 +728,15 @@ def lerp[LerpT: (float, MPFloat, ArrayDouble, ArrayBIGINT)](
 
 
     """
-    if not 0 <= _r <= 1:
-        raise ValueError("Specified interpolation weight must lie in [0, 1].")
-    elif _r == 0:
-        return _x1
-    elif _r == 1:
-        return _x2
-    else:
-        return fma(_x2, _r, fma(_x1, -_r, _x1))
+    match _r:
+        case 0:
+            return _x1
+        case 1:
+            return _x2
+        case _:
+            if not 0 <= _r <= 1:
+                raise ValueError("Specified interpolation weight must lie in [0, 1].")
+            return fma(_x2, _r, fma(_x1, -_r, _x1))
 
 
 def round_cust(

mergeron/perks/__init__.py

@@ -0,0 +1,20 @@
+"""Constants, types, objects and functions used within this sub-package."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+
+from attrs import frozen
+
+from .. import VERSION, ArrayDouble  # noqa: TID252
+
+__version__ = VERSION
+
+
+@frozen
+class GuidelinesBoundaryCallable:
+    """A function to generate Guidelines boundary points, along with area and knot."""
+
+    boundary_function: Callable[[ArrayDouble], ArrayDouble]
+    area: float
+    s_naught: float = 0

mergeron/{core → perks}/guidelines_boundary_functions_extra.py

@@ -6,17 +6,19 @@ and may provide improved precision than core functions, but tend to have
 poor performance
 
 """
+from __future__ import annotations
 
 from typing import Literal
 
 import numpy as np
 from mpmath import mp, mpf  # type: ignore
-from scipy.spatial.distance import minkowski as distance_function  # type: ignore
+from scipy.spatial.distance import minkowski  # type: ignore
 from sympy import lambdify, simplify, solve, symbols  # type: ignore
 
 from .. import DEFAULT_REC_RATIO, VERSION  # noqa: TID252
-from . import GuidelinesBoundary, GuidelinesBoundaryCallable, MPFloat
-from . import guidelines_boundary_functions as gbf
+from ..core import GuidelinesBoundary, MPFloat  # noqa: TID252
+from ..core import guidelines_boundary_functions as gbf  # noqa: TID252
+from . import GuidelinesBoundaryCallable
 
 __version__ = VERSION
 
@@ -108,9 +110,9 @@ def diversion_share_boundary_qdtr_wtd_avg(
     Parameters
     ----------
     _delta_star
-        corollary to GUPPI bound (:math:`\overline{g} / (m^* \cdot \overline{r})`)
+        Diversion share, :math:`\overline{d} / \overline{r}` or :math:`\overline{g} / (m^* \cdot \overline{r})`.
     _r_val
-        recapture ratio
+        Recapture ratio.
     weighting
         Whether "own-share" or "cross-product-share" (or None for simple, unweighted average)
     recapture_form
@@ -229,9 +231,9 @@ def diversion_share_boundary_distance(
     Parameters
     ----------
     _delta_star
-        corollary to GUPPI bound (:math:`\overline{g} / (m^* \cdot \overline{r})`)
+        Diversion share, :math:`\overline{d} / \overline{r}` or :math:`\overline{g} / (m^* \cdot \overline{r})`.
     _r_val
-        recapture ratio
+        Recapture ratio.
     agg_method
         Whether "arithmetic mean" or "distance".
     weighting
@@ -290,11 +292,11 @@ def diversion_share_boundary_distance(
 
             match agg_method:
                 case "arithmetic mean":
-                    delta_test = distance_function(
+                    delta_test = minkowski(
                         (de_1, de_2), (0.0, 0.0), p=1, w=weights_i
                     )
                 case "distance":
-                    delta_test = distance_function(
+                    delta_test = minkowski(
                         (de_1, de_2), (0.0, 0.0), p=2, w=weights_i
                     )
 
@@ -409,9 +411,9 @@ def diversion_share_boundary_xact_avg_mp(
     Parameters
     ----------
     _delta_star
-        Diversion share (:math:`\overline{d} / \overline{r}`).
+        Diversion share, :math:`\overline{d} / \overline{r}` or :math:`\overline{g} / (m^* \cdot \overline{r})`.
     _r_val
-        Recapture ratio
+        Recapture ratio.
     recapture_form
         Whether recapture-ratio is MNL-consistent ("inside-out") or has fixed
         value for both merging firms ("proportional").
@@ -529,14 +531,14 @@ def _diversion_share_boundary_wtd_avg_autoroot(
     dps: int = 5,
 ) -> GuidelinesBoundary:
     R"""
-    Share combinations on the share-weighted average diversion ratio boundary.
+    Share combinations on the share-weighted average diversion share boundary.
 
     Parameters
     ----------
     _delta_star
-        Diversion share (:math:`\overline{d} / \overline{r}`)
+        Diversion share, :math:`\overline{d} / \overline{r}` or :math:`\overline{g} / (m^* \cdot \overline{r})`.
     _r_val
-        recapture ratio
+        Recapture ratio.
     agg_method
         Whether "arithmetic mean", "geometric mean", or "distance".
     weighting

{mergeron-2025.739439.6.dist-info → mergeron-2025.739439.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mergeron
-Version: 2025.739439.6
+Version: 2025.739439.9
 Summary: Python for analyzing merger enforcement policy
 License: MIT
 Keywords: merger enforcement policy,merger guidelines,merger screening,enforcement presumptions,concentration standards,diversion ratio,upward pricing pressure,GUPPI

{mergeron-2025.739439.6.dist-info → mergeron-2025.739439.9.dist-info}/RECORD

@@ -1,10 +1,9 @@
-mergeron/__init__.py,sha256=N0U945_z3ITfbb9y0ygeHHdFdDUmi0L8oA3fYRpvRrc,6751
-mergeron/core/__init__.py,sha256=4Y_q-Qu7gXENVKHS-lNebn5mPZDy9oPHFwUV7fAW9Nw,3269
+mergeron/__init__.py,sha256=DeLtckn3pFKaczwoOCicY0GMa4UcfCXFi7mqmDQss2A,6751
+mergeron/core/__init__.py,sha256=zJcc50CAwm0oNKwk4p-P7oRwVfB_Fp4u0Do5dUeUXfI,3027
 mergeron/core/empirical_margin_distribution.py,sha256=61U-KLB563BPWM5zWyWp82c4PhcsAG-IKI0WWYGjBKg,11740
 mergeron/core/ftc_merger_investigations_data.py,sha256=oM4cs2PnyeSwyV1LOE_EYCUEzCKPm7lnCGxLIc6JQY8,28820
 mergeron/core/guidelines_boundaries.py,sha256=PvSOLB6KlXu9KX6NdpStuRluP6nrZqUzSHT6usa5600,15630
-mergeron/core/guidelines_boundary_functions.py,sha256=4HnNp1t6R99qszo3XCshL_hWXzsX4UCohPjzWWobGx0,30527
-mergeron/core/guidelines_boundary_functions_extra.py,sha256=g4V4-vxX8g6X-lXUVyU4-yPj5LTjCoRDPQUlbb2bBHY,22078
+mergeron/core/guidelines_boundary_functions.py,sha256=nStdhnxtvWJJ0jOR-5mPydDE3KMFf6rrfrT3IQUjjGY,30759
 mergeron/core/pseudorandom_numbers.py,sha256=-mPveXjJJ446NrBMAmWIa2jI6j0Px0xcCJTGEEsn3bo,10149
 mergeron/data/__init__.py,sha256=SAFkR23RBM0zwGam2TeWmw08oHAKmU2YF-Nygj73ies,1845
 mergeron/data/damodaran_margin_data_serialized.zip,sha256=Wc1v9buSrYTWWAravG8W9nPbgsU07zMtSAR2RvMQU5s,623482
@@ -14,7 +13,9 @@ mergeron/gen/data_generation.py,sha256=pdQl_uBENCjVt2aPtAcus2md4Qx-j5rOWGJJAzdnl
 mergeron/gen/data_generation_functions.py,sha256=hXUq5D2CIUkM4_NdGXiOb4XATYwIUeUcCGadzQGDqLw,26126
 mergeron/gen/enforcement_stats.py,sha256=etTax-sBSn8DveF-IxuBJDdX0XSBD6oFU9vaZe6cYks,14387
 mergeron/gen/upp_tests.py,sha256=gRJISQ2jGmIDmFOvaTIkvYooI4mK-QbgkfgL46RrRio,7445
+mergeron/perks/__init__.py,sha256=gGRIuRc7I6OuWLzwSiSZSIE0PEoxAy2DRFWg0VVLlbE,484
+mergeron/perks/guidelines_boundary_functions_extra.py,sha256=lbqjmeLjrqXBm7dEmhiMcqzlv89cDlmyrG3TDzUFSEY,22296
 mergeron/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-mergeron-2025.739439.6.dist-info/METADATA,sha256=-rd7oQdokempRxB-VX-YVVK9xgmmkvnJMIQgqsdspCg,4219
-mergeron-2025.739439.6.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-mergeron-2025.739439.6.dist-info/RECORD,,
+mergeron-2025.739439.9.dist-info/METADATA,sha256=v2HgFq-_idlJy6FYqRHvg4RwBHYFAUHiibwzERYiZ7M,4219
+mergeron-2025.739439.9.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+mergeron-2025.739439.9.dist-info/RECORD,,