mergeron 2024.739145.3__py3-none-any.whl → 2024.739145.5__py3-none-any.whl

mergeron/__init__.py

@@ -8,7 +8,7 @@ from numpy.typing import NDArray
 
 _PKG_NAME: str = Path(__file__).parent.stem
 
-VERSION = "2024.739145.3"
+VERSION = "2024.739145.5"
 
 __version__ = VERSION
 
@@ -30,7 +30,7 @@ type ArrayINT = NDArray[np.intp]
 type ArrayDouble = NDArray[np.double]
 type ArrayBIGINT = NDArray[np.int64]
 
-DEFAULT_REC_RATE = 0.85
+DEFAULT_REC_RATIO = 0.85
 
 
 @enum.unique

mergeron/core/guidelines_boundaries.py

@@ -6,6 +6,7 @@ with a canvas on which to draw boundaries for Guidelines standards.
 
 from __future__ import annotations
 
+import decimal
 from dataclasses import dataclass
 from typing import Literal
 
@@ -14,13 +15,12 @@ from attrs import Attribute, field, frozen, validators
 from mpmath import mp, mpf  # type: ignore
 
 from .. import (  # noqa: TID252
-    DEFAULT_REC_RATE,
+    DEFAULT_REC_RATIO,
     VERSION,
     ArrayDouble,
     RECForm,
     UPPAggrSelector,
 )
-from . import MPFloat
 from . import guidelines_boundary_functions as gbfn
 
 __version__ = VERSION
@@ -29,7 +29,7 @@ __version__ = VERSION
 mp.dps = 32
 mp.trap_complex = True
 
-type HMGPubYear = Literal[1992, 2004, 2010, 2023]
+type HMGPubYear = Literal[1982, 1984, 1992, 2010, 2023]
 
 
 @dataclass(frozen=True)
@@ -50,19 +50,15 @@ class GuidelinesThresholds:
 
     ΔHHI, Recapture Ratio, GUPPI, Diversion ratio, CMCR, and IPR thresholds
     constructed from concentration standards in Guidelines published in
-    1992, 2004, 2010, and 2023.
-
-    The 2004 Guidelines refernced here are the EU Commission
-    guidelines on assessment of horizontal mergers. These
-    guidelines also define a presumption for mergers with
-    post-merger HHI in [1000, 2000) and ΔHHI >= 250 points,
-    whi is not modeled here.
-
-    All other Guidelines modeled here are U.S. merger guidelines.
+    1982, 1984, 1992, 2010, and 2023.
 
     """
 
-    pub_year: HMGPubYear
+    pub_year: HMGPubYear = field(
+        kw_only=True,
+        default=2023,
+        validator=validators.in_([1982, 1984, 1992, 2010, 2023]),
+    )
     """
     Year of publication of the Guidelines
     """
@@ -100,9 +96,10 @@ class GuidelinesThresholds:
         # thus, here, the tentative delta safeharbor under
         # the 2023 Guidelines is 100 points
         _hhi_p, _dh_s, _dh_p = {
-            1992: (0.18, 0.005, 0.01),
+            1982: (_s1982 := (0.18, 0.005, 0.01)),
+            1984: _s1982,
+            1992: _s1982,
             2010: (0.25, 0.01, 0.02),
-            2004: (0.20, 0.015, 0.025),
             2023: (0.18, 0.01, 0.01),
         }[self.pub_year]
 
@@ -112,52 +109,41 @@ class GuidelinesThresholds:
             HMGThresholds(
                 _dh_s,
                 _fc := int(np.ceil(1 / _hhi_p)),
-                _r := gbfn.round_cust(_fc / (_fc + 1), frac=0.05),
-                _g_s := guppi_from_delta(_dh_s, m_star=1.0, r_bar=_r),
-                _dr := (1 - _r),
+                _r := float(_r_s := gbfn.round_cust(_fc / (_fc + 1), frac=0.05)),
+                _g := float(guppi_from_delta(_dh_s, m_star=1.0, r_bar=_r)),
+                _dr := float(1 - _r_s),
                 _cmcr := 0.03,  # Not strictly a Guidelines standard
-                _ipr := _g_s,  # Not strictly a Guidelines standard
+                _ipr := _g,  # Not strictly a Guidelines standard
             ),
         )
 
         object.__setattr__(
-            self,
-            "presumption",
-            HMGThresholds(
-                _dh_p,
-                _fc,
-                _r,
-                _g_p := guppi_from_delta(_dh_p, m_star=1.0, r_bar=_r),
-                _dr,
-                _cmcr,
-                _ipr := _g_p,
-            ),
+            self, "presumption", HMGThresholds(_dh_p, _fc, _r, _g, _dr, _cmcr, _ipr)
         )
 
-        # imputed_presumption is relevant for 2010 Guidelines
-        # merger to symmetry in numbers-equivalent of post-merger HHI
+        # imputed_presumption is relevant for presumptions implicating
+        # mergers *to* symmetry in numbers-equivalent of post-merger HHI
+        # as in 2010 U.S.Guidelines
         object.__setattr__(
             self,
             "imputed_presumption",
             (
                 HMGThresholds(
-                    _dh_i := 2 * (0.5 / _fc) ** 2,
+                    2 * (0.5 / _fc) ** 2,
                     _fc,
-                    _r_i := gbfn.round_cust((_fc - 1 / 2) / (_fc + 1 / 2), frac=0.05),
-                    _g_i := guppi_from_delta(_dh_p, m_star=1.0, r_bar=_r_i),
-                    1 / 2 * (1 - _r_i),
+                    float(
+                        _r_i := gbfn.round_cust(
+                            (_fc - 1 / 2) / (_fc + 1 / 2), frac=0.05
+                        )
+                    ),
+                    _g,
+                    float((1 - _r_i) / 2),
                     _cmcr,
-                    _g_i,
+                    _ipr := _g,
                 )
-                if self.pub_year in (2004, 2010)
+                if self.pub_year == 2010
                 else HMGThresholds(
-                    _dh_i := 2 * (1 / (_fc + 1)) ** 2,
-                    _fc,
-                    _r,
-                    _g_i := guppi_from_delta(_dh_p, m_star=1.0, r_bar=_r),
-                    _dr,
-                    _cmcr,
-                    _g_i,
+                    2 * (1 / (_fc + 1)) ** 2, _fc, _r, _g, _dr, _cmcr, _ipr
                 )
             ),
         )
@@ -169,10 +155,7 @@ class ConcentrationBoundary:
 
     measure_name: Literal[
         "ΔHHI", "Combined share", "Pre-merger HHI", "Post-merger HHI"
-    ] = field(
-        kw_only=False,
-        default="ΔHHI",  # pyright: ignore
-    )
+    ] = field(kw_only=False, default="ΔHHI")
 
     @measure_name.validator  # pyright: ignore
     def __mnv(
@@ -193,7 +176,7 @@ class ConcentrationBoundary:
         _instance: ConcentrationBoundary, _attribute: Attribute[float], _value: float, /
     ) -> None:
         if not 0 <= _value <= 1:
-            raise ValueError("Concentration threshold must lie between 0 and 1.")  # pyright: ignore
+            raise ValueError("Concentration threshold must lie between 0 and 1.")
 
     precision: int = field(
         kw_only=False, default=5, validator=validators.instance_of(int)
@@ -251,7 +234,9 @@ class DiversionRatioBoundary:
             )
 
     recapture_ratio: float = field(
-        kw_only=False, default=DEFAULT_REC_RATE, validator=validators.instance_of(float)
+        kw_only=False,
+        default=DEFAULT_REC_RATIO,
+        validator=validators.instance_of(float),
     )
 
     recapture_form: RECForm | None = field(kw_only=True, default=RECForm.INOUT)
@@ -337,6 +322,7 @@ class DiversionRatioBoundary:
             "recapture_form": getattr(self.recapture_form, "value", "inside-out"),
             "dps": self.precision,
         }
+
         match self.agg_method:
             case UPPAggrSelector.DIS:
                 _upp_agg_fn = gbfn.shrratio_boundary_wtd_avg
@@ -380,8 +366,8 @@ def guppi_from_delta(
     /,
     *,
     m_star: float = 1.00,
-    r_bar: float = DEFAULT_REC_RATE,
-) -> float:
+    r_bar: float = DEFAULT_REC_RATIO,
+) -> decimal.Decimal:
     """
     Translate ∆HHI bound to GUPPI bound.
 
@@ -407,13 +393,13 @@ def guppi_from_delta(
 
 
 def critical_share_ratio(
-    _guppi_bound: float = 0.075,
+    _guppi_bound: float | decimal.Decimal = 0.075,
     /,
     *,
     m_star: float = 1.00,
     r_bar: float = 1.00,
     frac: float = 1e-16,
-) -> MPFloat:
+) -> decimal.Decimal:
     """
     Corollary to GUPPI bound.
 
@@ -438,12 +424,12 @@ def critical_share_ratio(
 
 
 def share_from_guppi(
-    _guppi_bound: float = 0.065,
+    _guppi_bound: float | decimal.Decimal = 0.065,
     /,
     *,
     m_star: float = 1.00,
-    r_bar: float = DEFAULT_REC_RATE,
-) -> float:
+    r_bar: float = DEFAULT_REC_RATIO,
+) -> decimal.Decimal:
     """
     Symmetric-firm share for given GUPPI, margin, and recapture ratio.
 

mergeron/core/guidelines_boundary_functions.py

@@ -5,7 +5,7 @@ from typing import Any, Literal, TypedDict
 import numpy as np
 from mpmath import mp, mpf  # type: ignore
 
-from .. import DEFAULT_REC_RATE, VERSION, ArrayBIGINT, ArrayDouble  # noqa: TID252
+from .. import DEFAULT_REC_RATIO, VERSION, ArrayBIGINT, ArrayDouble  # noqa: TID252
 from . import MPFloat
 
 __version__ = VERSION
@@ -34,7 +34,7 @@ class GuidelinesBoundary:
     """Area under the boundary."""
 
 
-def dh_area(_dh_val: float | MPFloat = 0.01, /, *, dps: int = 9) -> float:
+def dh_area(_delta_bound: float | MPFloat = 0.01, /, *, dps: int = 9) -> float:
     R"""
     Area under the ΔHHI boundary.
 
@@ -55,7 +55,7 @@ def dh_area(_dh_val: float | MPFloat = 0.01, /, *, dps: int = 9) -> float:
 
     Parameters
     ----------
-    _dh_val
+    _delta_bound
         Change in concentration.
     dps
         Specified precision in decimal places.
@@ -66,22 +66,26 @@ def dh_area(_dh_val: float | MPFloat = 0.01, /, *, dps: int = 9) -> float:
 
     """
 
-    _dh_val = mpf(f"{_dh_val}")
-    _s_naught = (1 - mp.sqrt(1 - 2 * _dh_val)) / 2
+    _delta_bound = mpf(f"{_delta_bound}")
+    _s_naught = (1 - mp.sqrt(1 - 2 * _delta_bound)) / 2
 
     return round(
-        float(_s_naught + (_dh_val / 2) * (mp.ln(1 - _s_naught) - mp.ln(_s_naught))),
+        float(
+            _s_naught + (_delta_bound / 2) * (mp.ln(1 - _s_naught) - mp.ln(_s_naught))
+        ),
         dps,
     )
 
 
-def hhi_delta_boundary(_dh_val: float = 0.01, /, *, dps: int = 5) -> GuidelinesBoundary:
+def hhi_delta_boundary(
+    _delta_bound: float | decimal.Decimal | MPFloat = 0.01, /, *, dps: int = 5
+) -> GuidelinesBoundary:
     """
     Generate the list of share combination on the ΔHHI boundary.
 
     Parameters
     ----------
-    _dh_val:
+    _delta_bound:
         Merging-firms' ΔHHI bound.
     dps
         Number of decimal places for rounding reported shares.
@@ -92,33 +96,32 @@ def hhi_delta_boundary(_dh_val: float = 0.01, /, *, dps: int = 5) -> GuidelinesB
 
     """
 
-    _dh_val = mpf(f"{_dh_val}")
-    _s_naught = 1 / 2 * (1 - mp.sqrt(1 - 2 * _dh_val))
-    _s_mid = mp.sqrt(_dh_val / 2)
+    _delta_bound = mpf(f"{_delta_bound}")
+    _s_naught = 1 / 2 * (1 - mp.sqrt(1 - 2 * _delta_bound))
+    _s_mid = mp.sqrt(_delta_bound / 2)
 
     _dh_step_sz = mp.power(10, -6)
     _s_1 = np.array(mp.arange(_s_mid, _s_naught - mp.eps, -_dh_step_sz))
-    _s_2 = _dh_val / (2 * _s_1)
 
     # Boundary points
     _dh_half = np.vstack((
-        np.column_stack((_s_1, _s_2)).astype(np.float64),
+        np.column_stack((_s_1, _delta_bound / (2 * _s_1))).astype(np.float64),
         np.array([(mpf("0.0"), mpf("1.0"))], np.float64),
     ))
     _dh_bdry_pts = np.vstack((_dh_half[::-1], _dh_half[1:, ::-1]))
 
-    return GuidelinesBoundary(_dh_bdry_pts, dh_area(_dh_val, dps=dps))
+    return GuidelinesBoundary(_dh_bdry_pts, dh_area(_delta_bound, dps=dps))
 
 
 def hhi_pre_contrib_boundary(
-    _hhi_contrib: float = 0.03125, /, *, dps: int = 5
+    _hhi_bound: float | decimal.Decimal | MPFloat = 0.03125, /, *, dps: int = 5
 ) -> GuidelinesBoundary:
     """
     Share combinations on the premerger HHI contribution boundary.
 
     Parameters
     ----------
-    _hhi_contrib:
+    _hhi_bound:
         Merging-firms' pre-merger HHI contribution bound.
     dps
         Number of decimal places for rounding reported shares.
@@ -128,23 +131,23 @@ def hhi_pre_contrib_boundary(
         Array of share-pairs, area under boundary.
 
     """
-    _hhi_contrib = mpf(f"{_hhi_contrib}")
-    _s_mid = mp.sqrt(_hhi_contrib / 2)
+    _hhi_bound = mpf(f"{_hhi_bound}")
+    _s_mid = mp.sqrt(_hhi_bound / 2)
 
     _bdry_step_sz = mp.power(10, -dps)
     # Range-limit is 0 less a step, which is -1 * step-size
     _s_1 = np.array(mp.arange(_s_mid, -_bdry_step_sz, -_bdry_step_sz))
-    _s_2 = np.sqrt(_hhi_contrib - _s_1**2)
+    _s_2 = np.sqrt(_hhi_bound - _s_1**2)
     _bdry_pts_mid = np.column_stack((_s_1, _s_2)).astype(np.float64)
 
     return GuidelinesBoundary(
         np.vstack((_bdry_pts_mid[::-1], _bdry_pts_mid[1:, ::-1])),
-        round(float(mp.pi * _hhi_contrib / 4), dps),
+        round(float(mp.pi * _hhi_bound / 4), dps),
     )
 
 
 def combined_share_boundary(
-    _s_intcpt: float = 0.0625, /, *, dps: int = 10
+    _s_intcpt: float | decimal.Decimal | MPFloat = 0.0625, /, *, dps: int = 10
 ) -> GuidelinesBoundary:
     """
     Share combinations on the merging-firms' combined share boundary.
@@ -168,18 +171,14 @@ def combined_share_boundary(
     _s_intcpt = mpf(f"{_s_intcpt}")
     _s_mid = _s_intcpt / 2
 
-    _s1_pts = (0, _s_mid, _s_intcpt)
+    _s1_pts = np.array([0, _s_mid, _s_intcpt], np.float64)
     return GuidelinesBoundary(
-        np.column_stack((
-            np.array(_s1_pts, np.float64),
-            np.array(_s1_pts[::-1], np.float64),
-        )),
-        round(float(_s_intcpt * _s_mid), dps),
+        np.column_stack((_s1_pts, _s1_pts[::-1])), round(float(_s_intcpt * _s_mid), dps)
     )
 
 
 def hhi_post_contrib_boundary(
-    _hhi_contrib: float = 0.800, /, *, dps: int = 10
+    _hhi_bound: float | decimal.Decimal | MPFloat = 0.800, /, *, dps: int = 10
 ) -> GuidelinesBoundary:
     """
     Share combinations on the postmerger HHI contribution boundary.
@@ -189,7 +188,7 @@ def hhi_post_contrib_boundary(
 
     Parameters
     ----------
-    _hhi_contrib:
+    _hhi_bound:
         Merging-firms' pre-merger HHI contribution bound.
     dps
         Number of decimal places for rounding reported shares.
@@ -199,12 +198,17 @@ def hhi_post_contrib_boundary(
         Array of share-pairs, area under boundary.
 
     """
-    return combined_share_boundary(np.sqrt(_hhi_contrib), dps=dps)
+    return combined_share_boundary(
+        _hhi_bound.sqrt()
+        if isinstance(_hhi_bound, decimal.Decimal | mpf)
+        else np.sqrt(_hhi_bound),
+        dps=dps,
+    )
 
 
 def shrratio_boundary_wtd_avg(
-    _delta_star: float = 0.075,
-    _r_val: float = DEFAULT_REC_RATE,
+    _delta_star: float | decimal.Decimal | MPFloat = 0.075,
+    _r_val: float = DEFAULT_REC_RATIO,
     /,
     *,
     agg_method: Literal[
@@ -305,7 +309,7 @@ def shrratio_boundary_wtd_avg(
     _s_mid = mp.fdiv(_delta_star, 1 + _delta_star)
 
     # initial conditions
-    _gbdry_points: list[tuple[MPFloat, MPFloat]] | ArrayDouble = [(_s_mid, _s_mid)]
+    _gbdry_points = [(_s_mid, _s_mid)]
     _s_1_pre, _s_2_pre = _s_mid, _s_mid
     _s_2_oddval, _s_2_oddsum, _s_2_evnsum = True, 0.0, 0.0
 
@@ -401,18 +405,18 @@ def shrratio_boundary_wtd_avg(
         _gbdry_area_total = float(2 * _gbd_prtlarea - mp.power(_s_mid, "2"))
 
     _gbdry_points.append((mpf("0.0"), _s_intcpt))
-    _gbdry_points = np.array(_gbdry_points).astype(np.float64)
+    _gbdry_array = np.array(_gbdry_points).astype(np.float64)
 
     # Points defining boundary to point-of-symmetry
     return GuidelinesBoundary(
-        np.vstack((_gbdry_points[::-1], _gbdry_points[1:, ::-1])),
+        np.vstack((_gbdry_array[::-1], _gbdry_array[1:, ::-1])),
         round(float(_gbdry_area_total), dps),
     )
 
 
 def shrratio_boundary_xact_avg(
-    _delta_star: float = 0.075,
-    _r_val: float = DEFAULT_REC_RATE,
+    _delta_star: float | decimal.Decimal | MPFloat = 0.075,
+    _r_val: float = DEFAULT_REC_RATIO,
     /,
     *,
     recapture_form: Literal["inside-out", "proportional"] = "inside-out",
@@ -566,8 +570,8 @@ def shrratio_boundary_xact_avg(
 
 
 def shrratio_boundary_xact_avg_mp(
-    _delta_star: float = 0.075,
-    _r_val: float = DEFAULT_REC_RATE,
+    _delta_star: float | decimal.Decimal | MPFloat = 0.075,
+    _r_val: float = DEFAULT_REC_RATIO,
     /,
     *,
     recapture_form: Literal["inside-out", "proportional"] = "inside-out",
@@ -721,8 +725,8 @@ def shrratio_boundary_xact_avg_mp(
 
 
 def shrratio_boundary_min(
-    _delta_star: float = 0.075,
-    _r_val: float = DEFAULT_REC_RATE,
+    _delta_star: float | decimal.Decimal | MPFloat = 0.075,
+    _r_val: float = DEFAULT_REC_RATIO,
     /,
     *,
     recapture_form: str = "inside-out",
@@ -788,7 +792,11 @@ def shrratio_boundary_min(
 
 
 def shrratio_boundary_max(
-    _delta_star: float = 0.075, _r_val: float = DEFAULT_REC_RATE, /, *, dps: int = 10
+    _delta_star: float | decimal.Decimal | MPFloat = 0.075,
+    _r_val: float = DEFAULT_REC_RATIO,
+    /,
+    *,
+    dps: int = 10,
 ) -> GuidelinesBoundary:
     """
     Share combinations on the minimum GUPPI boundary with symmetric
@@ -851,7 +859,9 @@ def _shrratio_boundary_intcpt(
                 ),
                 2 * mpf(f"{_r_val}"),
             )
-        case None if agg_method == "arithmetic mean" and recapture_form == "proportional":
+        case None if (
+            agg_method == "arithmetic mean" and recapture_form == "proportional"
+        ):
             _s_intcpt = mp.fsub(_delta_star + 1 / 2, mp.fabs(_delta_star - 1 / 2))
         case _:
             _s_intcpt = _s_2_pre
@@ -859,12 +869,9 @@ def _shrratio_boundary_intcpt(
     return _s_intcpt
 
 
-def lerp(
-    _x1: int | float | MPFloat | ArrayDouble | ArrayBIGINT = 3,
-    _x2: int | float | MPFloat | ArrayDouble | ArrayBIGINT = 1,
-    _r: float | MPFloat = 0.25,
-    /,
-) -> float | MPFloat | ArrayDouble:
+def lerp[LerpT: (float, MPFloat, ArrayDouble, ArrayBIGINT)](
+    _x1: LerpT, _x2: LerpT, _r: float = 0.25, /
+) -> LerpT:
     """
     From the function of the same name in the C++ standard [2]_
 
@@ -901,19 +908,17 @@ def lerp(
         return _x1
     elif _r == 1:
         return _x2
-    elif _r == 0.5:
-        return 1 / 2 * (_x1 + _x2)
     else:
-        return _r * _x2 + (1 - _r) * _x1
+        return _r * _x2 + (1 - _r) * _x1  # pyright: ignore
 
 
 def round_cust(
-    _num: float = 0.060215,
+    _num: float | decimal.Decimal | MPFloat = 0.060215,
     /,
     *,
     frac: float = 0.005,
     rounding_mode: str = "ROUND_HALF_UP",
-) -> float:
+) -> decimal.Decimal:
     """
     Custom rounding, to the nearest 0.5% by default.
 
@@ -955,12 +960,12 @@ def round_cust(
     ):
         raise ValueError(
             f"Value, {f'"{rounding_mode}"'} is invalid for rounding_mode."
-            "Documentation for the, \"decimal\" built-in lists valid rounding modes."
+            'Documentation for the, "decimal" built-in lists valid rounding modes.'
         )
 
     _n, _f, _e = (decimal.Decimal(f"{_g}") for _g in [_num, frac, 1])
 
-    return float(_f * (_n / _f).quantize(_e, rounding=rounding_mode))
+    return _f * (_n / _f).quantize(_e, rounding=rounding_mode)
 
 
 def boundary_plot(*, mktshares_plot_flag: bool = True) -> tuple[Any, ...]:

mergeron/core/guidelines_boundary_functions_extra.py

@@ -16,7 +16,7 @@ from mpmath import mp, mpf  # type: ignore
 from scipy.spatial.distance import minkowski as distance_function  # type: ignore
 from sympy import lambdify, simplify, solve, symbols  # type: ignore
 
-from .. import DEFAULT_REC_RATE, VERSION, ArrayDouble  # noqa: TID252
+from .. import DEFAULT_REC_RATIO, VERSION, ArrayDouble  # noqa: TID252
 from . import guidelines_boundary_functions as gbfn
 
 __version__ = VERSION
@@ -101,7 +101,7 @@ def hhi_delta_boundary_qdtr(_dh_val: float = 0.01, /) -> GuidelinesBoundaryCalla
 
 def shrratio_boundary_qdtr_wtd_avg(
     _delta_star: float = 0.075,
-    _r_val: float = DEFAULT_REC_RATE,
+    _r_val: float = DEFAULT_REC_RATIO,
     /,
     *,
     weighting: Literal["own-share", "cross-product-share"] | None = "own-share",
@@ -220,7 +220,7 @@ def shrratio_boundary_qdtr_wtd_avg(
 
 def shrratio_boundary_distance(
     _delta_star: float = 0.075,
-    _r_val: float = DEFAULT_REC_RATE,
+    _r_val: float = DEFAULT_REC_RATIO,
     /,
     *,
     agg_method: Literal["arithmetic mean", "distance"] = "arithmetic mean",

mergeron/gen/__init__.py

@@ -15,7 +15,7 @@ from attrs import Attribute, cmp_using, field, frozen, validators
 from numpy.random import SeedSequence
 
 from .. import (  # noqa: TID252
-    DEFAULT_REC_RATE,
+    DEFAULT_REC_RATIO,
     VERSION,
     ArrayBIGINT,
     ArrayBoolean,
@@ -183,7 +183,7 @@ class ShareSpec:
     recapture_form: RECForm = field(default=RECForm.INOUT)
     """See :class:`mergeron.RECForm`"""
 
-    recapture_ratio: float | None = field(default=DEFAULT_REC_RATE)
+    recapture_ratio: float | None = field(default=DEFAULT_REC_RATIO)
     """A value between 0 and 1.
 
     :code:`None` if market share specification requires direct generation of
@@ -194,8 +194,7 @@ class ShareSpec:
     in published merger guidelines. Accordingly, the recapture ratio rounded to
     the nearest 5% is:
 
-    * 0.85, **7-to-6 merger from symmetry**; US Guidelines, 1992, 2023
-    * 0.80, **6-to-5 merger to symmetry**; EU Guidelines for horizontal mergers, 2004
+    * 0.85, **7-to-6 merger from symmetry**; US Guidelines, 1982, 1984, 1992, 2023
     * 0.80, 5-to-4 merger from symmetry
     * 0.80, **5-to-4 merger to symmetry**; US Guidelines, 2010
 

mergeron/gen/data_generation.py

@@ -13,7 +13,7 @@ from attrs import Attribute, define, field, validators
 from joblib import Parallel, cpu_count, delayed  # type: ignore
 from numpy.random import SeedSequence
 
-from .. import DEFAULT_REC_RATE, VERSION, RECForm  # noqa: TID252  # noqa
+from .. import DEFAULT_REC_RATIO, VERSION, RECForm  # noqa: TID252  # noqa
 from ..core import guidelines_boundaries as gbl  # noqa: TID252
 from ..core.guidelines_boundaries import HMGThresholds  # noqa: TID252
 from . import (
@@ -74,7 +74,7 @@ class MarketSample:
     share_spec: ShareSpec = field(
         kw_only=True,
         default=ShareSpec(
-            SHRDistribution.UNI, None, None, RECForm.INOUT, DEFAULT_REC_RATE
+            SHRDistribution.UNI, None, None, RECForm.INOUT, DEFAULT_REC_RATIO
         ),
         validator=validators.instance_of(ShareSpec),
     )

mergeron/gen/data_generation_functions.py

@@ -11,7 +11,7 @@ import numpy as np
 from attrs import evolve
 from numpy.random import SeedSequence
 
-from .. import DEFAULT_REC_RATE, VERSION, ArrayDouble, RECForm  # noqa: TID252
+from .. import DEFAULT_REC_RATIO, VERSION, ArrayDouble, RECForm  # noqa: TID252
 from ..core.empirical_margin_distribution import mgn_data_resampler  # noqa: TID252
 from ..core.pseudorandom_numbers import (  # noqa: TID252
     DEFAULT_DIST_PARMS,
@@ -100,7 +100,7 @@ def gen_share_data(
 
     # If recapture_form == "inside-out", recalculate _aggregate_purchase_prob
     _frmshr_array = _mkt_share_sample.mktshr_array[:, :2]
-    _r_bar = _share_spec.recapture_ratio or DEFAULT_REC_RATE
+    _r_bar = _share_spec.recapture_ratio or DEFAULT_REC_RATIO
     if _recapture_form == RECForm.INOUT:
         _mkt_share_sample = ShareDataSample(
             _mkt_share_sample.mktshr_array,
@@ -266,7 +266,7 @@ def gen_market_shares_dirichlet_multimarket(
     else:
 
         def _gen_dir_alphas(_fcv: int) -> ArrayDouble:
-            return np.array(_dir_alphas_full[:_fcv], dtype=np.float64)  # type: ignore
+            return np.array(_dir_alphas_full[:_fcv], dtype=np.float64)
 
     _fcounts = prng(_fcount_rng_seed_seq).choice(
         _fcount_keys, size=(_s_size, 1), p=_choice_wts
@@ -604,8 +604,7 @@ def gen_margin_price_data(
             del _price_array_here
         case _:
             raise ValueError(
-                f"Specitication of price distribution"
-                f' "{_price_spec.value}" is invalid.'
+                f'Specification of price distribution, "{_price_spec.value}" is invalid.'
             )
     if _price_spec != PriceSpec.CSY:
         _margin_data = _gen_margin_data(

mergeron/gen/upp_tests.py

@@ -373,7 +373,7 @@ def save_array_to_hdf5(
     *,
     saved_array_name_suffix: str | None = None,
 ) -> None:
-    _h5_array_name = f"{_array_name}_{saved_array_name_suffix or ""}".rstrip("_")
+    _h5_array_name = f"{_array_name}_{saved_array_name_suffix or ''}".rstrip("_")
 
     with suppress(ptb.NoSuchNodeError):
         _h5_file.remove_node(_h5_group, name=_array_name)

{mergeron-2024.739145.3.dist-info → mergeron-2024.739145.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergeron
-Version: 2024.739145.3
+Version: 2024.739145.5
 Summary: Merger Policy Analysis using Python
 License: MIT
 Keywords: merger policy analysis,merger guidelines,merger screening,policy presumptions,concentration standards,upward pricing pressure,GUPPI
@@ -16,6 +16,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Dist: aenum (>=3.1.15,<4.0.0)

{mergeron-2024.739145.3.dist-info → mergeron-2024.739145.5.dist-info}/RECORD

@@ -1,11 +1,10 @@
-mergeron/License.txt,sha256=7iX-y0EyjkbVJKJLS4ZKzuuE1wd0lryfsD_IytLG8lQ,1246
-mergeron/__init__.py,sha256=ZEg7CbRUEZAhsZG0G_wV-Hodno70_tZh9RN1hZ5sO6Q,1476
+mergeron/__init__.py,sha256=AC6G15BvvMrueNoem4otWbhncZEtc8FnLfDcm2LoNOE,1477
 mergeron/core/__init__.py,sha256=jPGd0okmvNOdWnTu4biR4hqnL29IERaY4Olv8mS02ko,188
 mergeron/core/empirical_margin_distribution.py,sha256=iU72c6rPwqduH8GlvES1na2uvw5qXq0IQfsTWnL_ueQ,8726
 mergeron/core/ftc_merger_investigations_data.py,sha256=_Qno1_oWcHmDd60j8YX6BLUSLeAn-DU6KpvMOcbCIaE,28728
-mergeron/core/guidelines_boundaries.py,sha256=sFC4kRjH4ndINluwxBBftBWcn5g4Vfq2ezhzzbpnlGE,15765
-mergeron/core/guidelines_boundary_functions.py,sha256=6Kiugn8w-byaBvow5b4kJJtA6SuXO-oOkCrRUtD06zQ,34626
-mergeron/core/guidelines_boundary_functions_extra.py,sha256=AZKkLPjiMtBaQIKj1bFs5xgV9xSntlHkf-pc7j4OkVk,11289
+mergeron/core/guidelines_boundaries.py,sha256=uKRIwTrGXKf8CbabjjqRcMO4wGvtAUrd2MrMICzgNvg,15336
+mergeron/core/guidelines_boundary_functions.py,sha256=SoTamDsKrThqDfoNTHeGp2ntiwhzscWmkAbIWrBtUq4,34885
+mergeron/core/guidelines_boundary_functions_extra.py,sha256=ytTWxYk7FkGLQubkQXrniwP_2ZlYssp4rmOxy4_7480,11292
 mergeron/core/pseudorandom_numbers.py,sha256=ps5H3n7jC5iJq_ulrmGvTAFmMeNXq-7IPWQQog7q5TY,9225
 mergeron/data/__init__.py,sha256=KtjBlZOl7jwBCAUhrTJB9PdrN39YLYytNiSUSM_gRmA,62
 mergeron/data/damodaran_margin_data.xls,sha256=Qggl1p5nkOMJI8YUXhkwXQRz-OhRSqBTzz57N0JQyYA,79360
@@ -13,12 +12,12 @@ mergeron/data/damodaran_margin_data_dict.msgpack,sha256=sr6s4L69kposEpzGI7jpPb4U
 mergeron/data/ftc_invdata.msgpack,sha256=WBFHgi7Ld4R-h2zL2Zc3TOIlKqVrbVFMH1LoI4-T-M0,264664
 mergeron/demo/__init__.py,sha256=KtjBlZOl7jwBCAUhrTJB9PdrN39YLYytNiSUSM_gRmA,62
 mergeron/demo/visualize_empirical_margin_distribution.py,sha256=_1SWKqFJNqKV_yA3v2tmzl8Th3CC3SXpb6VGiwGGuN0,2373
-mergeron/gen/__init__.py,sha256=hrOACw-loPDXiPTP-5wjpu7cW6T5ade6eVW-CtNGEXg,17287
-mergeron/gen/data_generation.py,sha256=wyrSfoDf3F5RVAqfzOv27R9x97_4Ciz6OmXH_w8PHbA,16870
-mergeron/gen/data_generation_functions.py,sha256=Lr9co1qylkmAyu8OPUVwYpE3KvxU-97glqmJ04E-LTA,28977
+mergeron/gen/__init__.py,sha256=6A1HVewEEwLo4JtZZ61ShzhU2phEeNfTxmTPlpi5LXY,17215
+mergeron/gen/data_generation.py,sha256=nzCWVJBXYxloR6J6MamFM0MUbDzguhARCAEksYkX1Dw,16872
+mergeron/gen/data_generation_functions.py,sha256=QmM89KzDP-8hz4ibjWDiEn_KVulgUN_be19j-P9LdWU,28944
 mergeron/gen/enforcement_stats.py,sha256=ZjrV_VkFMF0D1myc-fj-W99M1EhJMA9-nCfyE5g9e54,10890
-mergeron/gen/upp_tests.py,sha256=VWxGVi6DQrGxcQsaNtXNB2qDu-WYm9DuY851fHW3j-o,12548
+mergeron/gen/upp_tests.py,sha256=vv9gBHQzabYxgcOBofTPHuNael8SbUAMfNW9c2H2C84,12548
 mergeron/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-mergeron-2024.739145.3.dist-info/METADATA,sha256=16hzR2LygxlFSoEAat6HJgiTthxbYhzsKBxHAtKtZN8,14432
-mergeron-2024.739145.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-mergeron-2024.739145.3.dist-info/RECORD,,
+mergeron-2024.739145.5.dist-info/METADATA,sha256=_Ywnp2xKUSmbtRB4pTG3N4VrHaKOXSI-9lKU0gIB4HE,14483
+mergeron-2024.739145.5.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+mergeron-2024.739145.5.dist-info/RECORD,,

{mergeron-2024.739145.3.dist-info → mergeron-2024.739145.5.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 1.9.1
 Root-Is-Purelib: true
 Tag: py3-none-any

mergeron/License.txt

@@ -1,16 +0,0 @@
-mergeron
-========
-
-Copyright 2017-2024 S. Murthy Kambhampaty
-
-MIT License
------------
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-Exceptions
-----------
-Modules provided in the mergeron.ext subpackage are redistributed under the license published within each module.