mergeron 2024.738949.0__py3-none-any.whl → 2024.738949.5__py3-none-any.whl

mergeron/core/damodaran_margin_data.py

@@ -32,13 +32,8 @@ price-cost margins fall in the interval :math:`[0, 1]`.
 
 """
 
-from importlib.metadata import version
-
-from .. import _PKG_NAME, DATA_DIR  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
 from collections.abc import Mapping
+from importlib.metadata import version
 from pathlib import Path
 from types import MappingProxyType
 
@@ -51,6 +46,11 @@ from requests_toolbelt.downloadutils import stream  # type: ignore
 from scipy import stats  # type: ignore
 from xlrd import open_workbook  # type: ignore
 
+from .. import _PKG_NAME, DATA_DIR  # noqa: TID252
+
+__version__ = version(_PKG_NAME)
+
+
 MGNDATA_ARCHIVE_PATH = DATA_DIR / "damodaran_margin_data_dict.msgpack"
 
 

mergeron/core/excel_helper.py

@@ -8,14 +8,9 @@ Includes a flexible system of defining cell formats.
 
 from __future__ import annotations
 
-from importlib.metadata import version
-
-from .. import _PKG_NAME  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
 import enum
 from collections.abc import Mapping, Sequence
+from importlib.metadata import version
 from types import MappingProxyType
 from typing import Any
 
@@ -23,6 +18,10 @@ import numpy as np
 import numpy.typing as npt
 import xlsxwriter  # type: ignore
 
+from .. import _PKG_NAME  # noqa: TID252
+
+__version__ = version(_PKG_NAME)
+
 
 @enum.unique
 class CFmtParent(dict[str, Any], enum.ReprEnum):
@@ -233,7 +232,7 @@ def xl_fmt(
     if isinstance(_cell_fmt, tuple):
         ensure_cell_format_spec_tuple(_cell_fmt)
         for _cf in _cell_fmt:
-            _cell_fmt_dict |= _cf.value
+            _cell_fmt_dict = _cell_fmt_dict | _cf.value
     elif isinstance(_cell_fmt, CFmt):
         _cell_fmt_dict = _cell_fmt.value
     else:

mergeron/core/ftc_merger_investigations_data.py

@@ -8,13 +8,8 @@ We drop reported row and column totals from source data for reducing stored data
 
 """
 
-from importlib.metadata import version
-
-from .. import _PKG_NAME, DATA_DIR  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
 from collections.abc import Mapping, Sequence
+from importlib.metadata import version
 from operator import itemgetter
 from pathlib import Path
 from types import MappingProxyType
@@ -30,6 +25,10 @@ from bs4 import BeautifulSoup
 from numpy.testing import assert_array_equal
 from numpy.typing import NDArray
 
+from .. import _PKG_NAME, DATA_DIR  # noqa: TID252
+
+__version__ = version(_PKG_NAME)
+
 m.patch()
 
 FTCDATA_DIR = DATA_DIR / "FTCData"

mergeron/core/guidelines_boundaries.py

@@ -4,14 +4,10 @@ with a canvas on which to draw boundaries for Guidelines standards.
 
 """
 
-from importlib.metadata import version
-
-from .. import _PKG_NAME  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
 import decimal
+from collections.abc import Callable
 from dataclasses import dataclass
+from importlib.metadata import version
 from typing import Any, Literal, TypeAlias
 
 import numpy as np
@@ -19,6 +15,12 @@ from attrs import define, field
 from mpmath import mp, mpf  # type: ignore
 from numpy.typing import NDArray
 from scipy.spatial.distance import minkowski as distance_function
+from sympy import lambdify, simplify, solve, symbols
+
+from .. import _PKG_NAME  # noqa: TID252
+
+__version__ = version(_PKG_NAME)
+
 
 mp.prec = 80
 mp.trap_complex = True
@@ -32,6 +34,13 @@ class GuidelinesBoundary:
     area: float
 
 
+@dataclass(slots=True, frozen=True)
+class GuidelinesBoundaryCallable:
+    boundary_function: Callable[[NDArray[np.float64]], NDArray[np.float64]]
+    area: float
+    s_naught: float = 0
+
+
 @define(slots=True, frozen=True)
 class HMGThresholds:
     delta: float
@@ -278,7 +287,12 @@ def gbd_from_dsf(
 
 
 def critical_shrratio(
-    _gbd: float = 0.06, /, *, m_star: float = 1.00, r_bar: float = 0.80
+    _gbd: float = 0.06,
+    /,
+    *,
+    m_star: float = 1.00,
+    r_bar: float = 0.80,
+    frac: float = 1e-16,
 ) -> mpf:
     """
     Corollary to GUPPI bound.
@@ -298,7 +312,7 @@ def critical_shrratio(
         for given margin and recapture rate.
 
     """
-    return mpf(f"{_gbd}") / mp.fmul(f"{m_star}", f"{r_bar}")
+    return round_cust(mpf(f"{_gbd}") / mp.fmul(f"{m_star}", f"{r_bar}"), frac=frac)
 
 
 def shr_from_gbd(
@@ -371,18 +385,18 @@ def boundary_plot(*, mktshares_plot_flag: bool = True) -> tuple[Any, ...]:
             r"\setsansfont{Fira Sans Light}",
             R"\setmonofont[Scale=MatchLowercase,]{Fira Mono}",
             R"\defaultfontfeatures[\rmfamily]{",
-            R"	Ligatures={TeX, Common},",
-            R"	Numbers={Proportional, Lining},",
-            R"	}",
+            R"  Ligatures={TeX, Common},",
+            R"  Numbers={Proportional, Lining},",
+            R"  }",
             R"\defaultfontfeatures[\sffamily]{",
-            R"	Ligatures={TeX, Common},",
-            R"	Numbers={Monospaced, Lining},",
-            R"	LetterSpace=0.50,",
-            R"	}",
+            R"  Ligatures={TeX, Common},",
+            R"  Numbers={Monospaced, Lining},",
+            R"  LetterSpace=0.50,",
+            R"  }",
             R"\usepackage[",
-            R"	activate={true, nocompatibility},",
-            R"	tracking=true,",
-            R"	]{microtype}",
+            R"  activate={true, nocompatibility},",
+            R"  tracking=true,",
+            R"  ]{microtype}",
         ]),
     })
 
@@ -589,19 +603,16 @@ def delta_hhi_boundary(
     _s1_zero = 1 / 2 * (1 - mp.sqrt(1 - 2 * _dh_val))
     _s1_one = 1 - _s1_zero
 
-    _s_mid = mp.sqrt(_dh_val / 2)
-
     _dh_step_sz = mp.power(10, -6)
-    _s_1 = np.array(mp.arange(_s_mid, _s1_zero, -_dh_step_sz))
+    _s_1 = np.array(mp.arange(_s1_zero, _s1_one + _dh_step_sz, _dh_step_sz))
     _s_2 = _dh_val / (2 * _s_1)
 
     # Boundary points
-    _dh_half = np.row_stack((
-        np.column_stack((_s_1, _s_2)),
-        np.array([(_s1_zero, _s1_one)]),
+    _dh_bdry_pts = np.row_stack((
         np.array([(mpf("0.0"), mpf("1.0"))]),
+        np.column_stack((_s_1, _s_2)),
+        np.array([(mpf("1.0"), mpf("0.0"))]),
     ))
-    _dh_bdry_pts = np.row_stack((np.flip(_dh_half, 0), np.flip(_dh_half[1:], 1)))
 
     _s_1_pts, _s_2_pts = np.split(_dh_bdry_pts, 2, axis=1)
     return GuidelinesBoundary(
@@ -613,6 +624,42 @@ def delta_hhi_boundary(
     )
 
 
+def delta_hhi_boundary_qdtr(_dh_val: float = 0.01) -> GuidelinesBoundaryCallable:
+    """
+    Generate the list of share combination on the ΔHHI boundary.
+
+    Parameters
+    ----------
+    _dh_val:
+        Merging-firms' ΔHHI bound.
+    dh_dps
+        Number of decimal places for rounding reported shares.
+
+    Returns
+    -------
+        Callable to generate array of share-pairs, area under boundary.
+
+    """
+
+    _dh_val = mpf(f"{_dh_val}")
+
+    _s_1, _s_2 = symbols("s_1, s_2", positive=True)
+
+    _hhi_eqn = _s_2 - 0.01 / (2 * _s_1)
+
+    _hhi_bdry = solve(_hhi_eqn, _s_2)[0]
+    _s_nought = float(solve(_hhi_eqn.subs({_s_2: 1 - _s_1}), _s_1)[0])
+
+    _hhi_bdry_area = 2 * (
+        _s_nought
+        + mp.quad(lambdify(_s_1, _hhi_bdry, "mpmath"), (_s_nought, 1 - _s_nought))
+    )
+
+    return GuidelinesBoundaryCallable(
+        lambdify(_s_1, _hhi_bdry, "numpy"), _hhi_bdry_area, _s_nought
+    )
+
+
 def combined_share_boundary(
     _s_intcpt: float = 0.0625, /, *, bdry_dps: int = 10
 ) -> GuidelinesBoundary:
@@ -801,6 +848,130 @@ def shrratio_boundary_min(
     )
 
 
+def shrratio_boundary_qdtr_wtd_avg(
+    _delta_star: float = 0.075,
+    _r_val: float = 0.80,
+    /,
+    *,
+    wgtng_policy: Literal["own-share", "cross-product-share"] | None = "own-share",
+    recapture_spec: Literal["inside-out", "proportional"] = "inside-out",
+) -> GuidelinesBoundaryCallable:
+    """
+    Share combinations for the share-weighted average GUPPI boundary with symmetric
+    merging-firm margins.
+
+    Parameters
+    ----------
+    _delta_star
+        corollary to GUPPI bound (:math:`\\overline{g} / (m^* \\cdot \\overline{r})`)
+    _r_val
+        recapture ratio
+    wgtng_policy
+        Whether "own-share" or "cross-product-share" (or None for simple, unweighted average)
+    recapture_spec
+        Whether recapture-ratio is MNL-consistent ("inside-out") or has fixed
+        value for both merging firms ("proportional").
+
+    Returns
+    -------
+        Array of share-pairs, area under boundary.
+
+    """
+
+    if _delta_star > 1:
+        raise ValueError(
+            "Margin-adjusted benchmark share ratio, `_delta_star` cannot exceed 1."
+        )
+
+    _delta_star = mpf(f"{_delta_star}")
+    _s_mid = _delta_star / (1 + _delta_star)
+    _s_naught = 0
+
+    _s_1, _s_2 = symbols("s_1:3", positive=True)
+
+    match wgtng_policy:
+        case "own-share":
+            _bdry_eqn = (
+                _s_1 * _s_2 / (1 - _s_1)
+                + _s_2
+                * _s_1
+                / (
+                    (1 - (_r_val * _s_2 + (1 - _r_val) * _s_1))
+                    if recapture_spec == "inside-out"
+                    else (1 - _s_2)
+                )
+                - (_s_1 + _s_2) * _delta_star
+            )
+
+            _bdry_func = solve(_bdry_eqn, _s_2)[0]
+            _s_naught = (
+                float(solve(simplify(_bdry_eqn.subs({_s_2: 1 - _s_1})), _s_1)[0])
+                if recapture_spec == "inside-out"
+                else 0
+            )
+            _bdry_area = float(
+                2
+                * (
+                    _s_naught
+                    + mp.quad(lambdify(_s_1, _bdry_func, "mpmath"), (_s_naught, _s_mid))
+                )
+                - (_s_mid**2 + _s_naught**2)
+            )
+
+        case "cross-product-share":
+            mp.trap_complex = False
+            _d_star = symbols("d", positive=True)
+            _bdry_eqn = (
+                _s_2 * _s_2 / (1 - _s_1)
+                + _s_1
+                * _s_1
+                / (
+                    (1 - (_r_val * _s_2 + (1 - _r_val) * _s_1))
+                    if recapture_spec == "inside-out"
+                    else (1 - _s_2)
+                )
+                - (_s_1 + _s_2) * _d_star
+            )
+
+            _bdry_func = solve(_bdry_eqn, _s_2)[1]
+            _bdry_area = float(
+                2
+                * (
+                    mp.quad(
+                        lambdify(
+                            _s_1, _bdry_func.subs({_d_star: _delta_star}), "mpmath"
+                        ),
+                        (0, _s_mid),
+                    )
+                ).real
+                - _s_mid**2
+            )
+
+        case _:
+            _bdry_eqn = (
+                1 / 2 * _s_2 / (1 - _s_1)
+                + 1
+                / 2
+                * _s_1
+                / (
+                    (1 - (_r_val * _s_2 + (1 - _r_val) * _s_1))
+                    if recapture_spec == "inside-out"
+                    else (1 - _s_2)
+                )
+                - _delta_star
+            )
+
+            _bdry_func = solve(_bdry_eqn, _s_2)[0]
+            _bdry_area = float(
+                2 * (mp.quad(lambdify(_s_1, _bdry_func, "mpmath"), (0, _s_mid)))
+                - _s_mid**2
+            )
+
+    return GuidelinesBoundaryCallable(
+        lambdify(_s_1, _bdry_func, "numpy"), _bdry_area, _s_naught
+    )
+
+
 def shrratio_boundary_wtd_avg(
     _delta_star: float = 0.075,
     _r_val: float = 0.80,
@@ -815,16 +986,36 @@ def shrratio_boundary_wtd_avg(
     Share combinations for the share-weighted average GUPPI boundary with symmetric
     merging-firm margins.
 
+    Parameters
+    ----------
+    _delta_star
+        corollary to GUPPI bound (:math:`\\overline{g} / (m^* \\cdot \\overline{r})`)
+    _r_val
+        recapture ratio
+    avg_method
+        Whether "arithmetic", "geometric", or "distance".
+    wgtng_policy
+        Whether "own-share" or "cross-product-share"  (or None for simple, unweighted average).
+    recapture_spec
+        Whether recapture-ratio is MNL-consistent ("inside-out") or has fixed
+        value for both merging firms ("proportional").
+    gbd_dps
+        Number of decimal places for rounding returned shares and area.
+
+    Returns
+    -------
+        Array of share-pairs, area under boundary.
+
     Notes
     -----
     An analytical expression for the share-weighted arithmetic mean boundary
     is derived and plotted from y-intercept to the ray of symmetry as follows::
 
         from sympy import plot as symplot, solve, symbols
-        s_1, s_2, delta_star = symbols("s_1 s_2 \\delta^*")
+        s_1, s_2 = symbols("s_1 s_2", positive=True)
 
         g_val, r_val, m_val = 0.06, 0.80, 0.30
-        d_hat = g_val / (r_val * m_val)
+        delta_star = g_val / (r_val * m_val)
 
         # recapture_spec == "inside-out"
         oswag = solve(
@@ -834,7 +1025,7 @@ def shrratio_boundary_wtd_avg(
             s_2
         )[0]
         symplot(
-            oswag.subs({delta_star: d_hat}),
+            oswag,
             (s_1, 0., d_hat / (1 + d_hat)),
             ylabel=s_2
         )
@@ -846,7 +1037,7 @@ def shrratio_boundary_wtd_avg(
             s_2
         )[1]
         symplot(
-            cpwag.subs({delta_star: d_hat}),
+            cpwag,
             (s_1, 0., d_hat / (1 + d_hat)),
             ylabel=s_2
         )
@@ -859,7 +1050,7 @@ def shrratio_boundary_wtd_avg(
              s_2
         )[0]
         symplot(
-            oswag.subs({delta_star: d_hat}),
+            oswag,
             (s_1, 0., d_hat / (1 + d_hat)),
             ylabel=s_2
         )
@@ -871,30 +1062,11 @@ def shrratio_boundary_wtd_avg(
              s_2
         )[1]
         symplot(
-            cpswag.subs({delta_star: d_hat}),
+            cpswag,
             (s_1, 0.0, d_hat / (1 + d_hat)),
             ylabel=s_2
         )
 
-    Parameters
-    ----------
-    _delta_star
-        corollary to GUPPI bound (:math:`\\overline{g} / (m^* \\cdot \\overline{r})`)
-    _r_val
-        recapture ratio
-    avg_method
-        Whether "arithmetic", "geometric", or "distance".
-    wgtng_policy
-        Whether "own-share" or "cross-product-share".
-    recapture_spec
-        Whether recapture-ratio is MNL-consistent ("inside-out") or has fixed
-        value for both merging firms ("proportional").
-    gbd_dps
-        Number of decimal places for rounding returned shares and area.
-
-    Returns
-    -------
-        Array of share-pairs, area under boundary.
 
     """
 
@@ -921,7 +1093,7 @@ def shrratio_boundary_wtd_avg(
         _s_2 = _s_2_pre * (1 + _theta)
 
         if (_s_1 + _s_2) > mpf("0.99875"):
-            # 1: # We lose accuracy at 3-9s and up
+            # Loss of accuracy at 3-9s and up
             break
 
         while True:
@@ -948,10 +1120,11 @@ def shrratio_boundary_wtd_avg(
                 case _:
                     _delta_test = lerp(_de_1, _de_2, _r)
 
-            if wgtng_policy == "cross-product-share":
-                _test_flag, _incr_decr = (_delta_test > _delta_star, -1)
-            else:
-                _test_flag, _incr_decr = (_delta_test < _delta_star, 1)
+            _test_flag, _incr_decr = (
+                (_delta_test > _delta_star, -1)
+                if wgtng_policy == "cross-product-share"
+                else (_delta_test < _delta_star, 1)
+            )
 
             if _test_flag:
                 _s_2 += _incr_decr * _gbd_step_sz
@@ -970,31 +1143,41 @@ def shrratio_boundary_wtd_avg(
         _s_2_pre = _s_2
         _s_1_pre = _s_1
 
-    _gbd_prtlarea = _gbd_step_sz * (
-        (4 * _s_2_oddsum + 2 * _s_2_evnsum + _s_mid + _delta_star) / 3
-        if wgtng_policy == "cross-product-share"
-        else (
-            (4 * _s_2_oddsum + 2 * _s_2_evnsum + _s_mid + _s_2_pre) / 3
-            + _s_1_pre * (1 + _s_2_pre) / 2
-        )
+    if _s_2_oddval:
+        _s_2_evnsum -= _s_2_pre
+    else:
+        _s_2_oddsum -= _s_1_pre
+
+    _s_intcpt = _shrratio_boundary_intcpt(
+        _s_1_pre,
+        _delta_star,
+        _r_val,
+        recapture_spec=recapture_spec,
+        avg_method=avg_method,
+        wgtng_policy=wgtng_policy,
     )
 
-    # Area under boundary
-    _gbdry_area_total = 2 * _gbd_prtlarea - mp.power(_s_mid, 2)
+    if wgtng_policy == "own-share":
+        _gbd_prtlarea = (
+            _gbd_step_sz * (4 * _s_2_oddsum + 2 * _s_2_evnsum + _s_mid + _s_2_pre) / 3
+        )
+        # Area under boundary
+        _gbdry_area_total = float(
+            2 * (_s_1_pre + _gbd_prtlarea)
+            - (mp.power(_s_mid, "2") + mp.power(_s_1_pre, "2"))
+        )
 
-    match wgtng_policy:
-        case "cross-product-share":
-            _s_intcpt = _delta_star
-        case "own-product-share":
-            _s_intcpt = mpf("1.0")
-        case None if avg_method == "distance":
-            _s_intcpt = _delta_star * mp.sqrt("2")
-        case _:
-            _s_intcpt = _s_2_pre
+    else:
+        _gbd_prtlarea = (
+            _gbd_step_sz * (4 * _s_2_oddsum + 2 * _s_2_evnsum + _s_mid + _s_intcpt) / 3
+        )
+        # Area under boundary
+        _gbdry_area_total = float(2 * _gbd_prtlarea - mp.power(_s_mid, "2"))
 
     _gbdry_points = np.row_stack((_gbdry_points, (mpf("0.0"), _s_intcpt))).astype(
         np.float64
     )
+
     # Points defining boundary to point-of-symmetry
     return GuidelinesBoundary(
         np.row_stack((np.flip(_gbdry_points, 0), np.flip(_gbdry_points[1:], 1))),
@@ -1281,10 +1464,10 @@ def shrratio_boundary_avg(
     _s_intcpt = _s_2
 
     _gbd_prtlarea = 2 * _gbd_step_sz * (
-        mp.fmul(4 / 3, _s_2_oddsum)
-        + mp.fmul(2 / 3, _s_2_evnsum)
-        + mp.fmul(1 / 3, _s_mid + _s_intcpt)
-    ) - mp.power(_s_mid, 2)
+        mp.fmul(4, _s_2_oddsum)
+        + mp.fmul(2, _s_2_evnsum)
+        + mp.fmul(1, _s_mid + _s_intcpt)
+    ) / 3 - mp.power(_s_mid, 2)
 
     _gbdry_points = np.array(_gbdry_points, np.float64)
     return GuidelinesBoundary(
@@ -1310,8 +1493,8 @@ def shrratio_boundary_distance(
     Reimplements the arithmetic-averages and distance estimations from function,
     `shrratio_boundary_wtd_avg`but uses the Minkowski-distance function,
     `scipy.spatial.distance.minkowski` for all aggregators. This reimplementation
-    is primarifly useful for testing the output of `shrratio_boundary_wtd_avg`
-    as it tests considerably slower.
+    is useful for testing the output of `shrratio_boundary_wtd_avg`
+    but runs considerably slower.
 
     Parameters
     ----------
@@ -1392,10 +1575,11 @@ def shrratio_boundary_distance(
                         (_de_1, _de_2), (0.0, 0.0), p=2, w=_weights_i
                     )
 
-            if wgtng_policy == "cross-product-share":
-                _test_flag, _incr_decr = (_delta_test > _delta_star, -1)
-            else:
-                _test_flag, _incr_decr = (_delta_test < _delta_star, 1)
+            _test_flag, _incr_decr = (
+                (_delta_test > _delta_star, -1)
+                if wgtng_policy == "cross-product-share"
+                else (_delta_test < _delta_star, 1)
+            )
 
             if _test_flag:
                 _s_2 += _incr_decr * _gbd_step_sz
@@ -1414,22 +1598,60 @@ def shrratio_boundary_distance(
         _s_2_pre = _s_2
         _s_1_pre = _s_1
 
-    _gbd_prtlarea = _gbd_step_sz * (
-        (4 * _s_2_oddsum + 2 * _s_2_evnsum + _s_mid + _delta_star) / 3
-        if wgtng_policy == "cross-product-share"
-        else (
-            (4 * _s_2_oddsum + 2 * _s_2_evnsum + _s_mid + _s_2_pre) / 3
-            + _s_1_pre * (1 + _s_2_pre) / 2
+    if _s_2_oddval:
+        _s_2_evnsum -= _s_2_pre
+    else:
+        _s_2_oddsum -= _s_1_pre
+
+    _s_intcpt = _shrratio_boundary_intcpt(
+        _s_1_pre,
+        _delta_star,
+        _r_val,
+        recapture_spec=recapture_spec,
+        avg_method=avg_method,
+        wgtng_policy=wgtng_policy,
+    )
+
+    if wgtng_policy == "own-share":
+        _gbd_prtlarea = (
+            _gbd_step_sz * (4 * _s_2_oddsum + 2 * _s_2_evnsum + _s_mid + _s_2_pre) / 3
+        )
+        # Area under boundary
+        _gbdry_area_total = 2 * (_s_1_pre + _gbd_prtlarea) - (
+            mp.power(_s_mid, "2") + mp.power(_s_1_pre, "2")
+        )
+
+    else:
+        _gbd_prtlarea = (
+            _gbd_step_sz * (4 * _s_2_oddsum + 2 * _s_2_evnsum + _s_mid + _s_intcpt) / 3
         )
+        # Area under boundary
+        _gbdry_area_total = 2 * _gbd_prtlarea - mp.power(_s_mid, "2")
+
+    _gbdry_points = np.row_stack((_gbdry_points, (mpf("0.0"), _s_intcpt))).astype(
+        np.float64
+    )
+    # Points defining boundary to point-of-symmetry
+    return GuidelinesBoundary(
+        np.row_stack((np.flip(_gbdry_points, 0), np.flip(_gbdry_points[1:], 1))),
+        round(float(_gbdry_area_total), gbd_dps),
     )
 
-    # Area under boundary
-    _gbdry_area_total = 2 * _gbd_prtlarea - mp.power(_s_mid, 2)
 
+def _shrratio_boundary_intcpt(
+    _s_2_pre: float,
+    _delta_star: mpf,
+    _r_val: mpf,
+    /,
+    *,
+    recapture_spec: Literal["inside-out", "proportional"],
+    avg_method: Literal["arithmetic", "geometric", "distance"],
+    wgtng_policy: Literal["cross-product-share", "own-share"] | None,
+) -> float:
     match wgtng_policy:
         case "cross-product-share":
             _s_intcpt = _delta_star
-        case "own-product-share":
+        case "own-share":
             _s_intcpt = mpf("1.0")
         case None if avg_method == "distance":
             _s_intcpt = _delta_star * mp.sqrt("2")
@@ -1445,11 +1667,4 @@ def shrratio_boundary_distance(
         case _:
             _s_intcpt = _s_2_pre
 
-    _gbdry_points = np.row_stack((_gbdry_points, (mpf("0.0"), _s_intcpt))).astype(
-        np.float64
-    )
-    # Points defining boundary to point-of-symmetry
-    return GuidelinesBoundary(
-        np.row_stack((np.flip(_gbdry_points, 0), np.flip(_gbdry_points[1:], 1))),
-        round(float(_gbdry_area_total), gbd_dps),
-    )
+    return _s_intcpt

mergeron/core/proportions_tests.py

@@ -7,14 +7,9 @@ Functions to estimate confidence intervals for
 
 from __future__ import annotations
 
+from collections.abc import Sequence
 from dataclasses import dataclass
 from importlib.metadata import version
-
-from .. import _PKG_NAME  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
-from collections.abc import Sequence
 from typing import Literal, TypeVar
 
 import numpy as np
@@ -22,6 +17,11 @@ from numpy.typing import NBitBase, NDArray
 from scipy.optimize import OptimizeResult, root  # type: ignore
 from scipy.stats import beta, chi2, norm  # type: ignore
 
+from .. import _PKG_NAME  # noqa: TID252
+
+__version__ = version(_PKG_NAME)
+
+
 TI = TypeVar("TI", bound=NBitBase)
 
 

mergeron/core/pseudorandom_numbers.py

@@ -6,14 +6,9 @@ https://github.com/numpy/numpy/issues/16313.
 
 """
 
-from importlib.metadata import version
-
-from .. import _PKG_NAME  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
 import concurrent.futures
 from collections.abc import Sequence
+from importlib.metadata import version
 from multiprocessing import cpu_count
 from typing import Literal, TypeVar
 
@@ -21,6 +16,11 @@ import numpy as np
 from numpy.random import PCG64DXSM, Generator, SeedSequence
 from numpy.typing import NBitBase, NDArray
 
+from .. import _PKG_NAME  # noqa: TID252
+
+__version__ = version(_PKG_NAME)
+
+
 TF = TypeVar("TF", bound=NBitBase)
 TI = TypeVar("TI", bound=NBitBase)
 

mergeron/examples/concentration_as_diversion.py

@@ -27,14 +27,15 @@ from pathlib import Path
 from typing import Any, Literal
 
 import matplotlib.axes as mpa
-from joblib import Parallel, cpu_count, delayed
-from numpy import pi
-from xlsxwriter import Workbook
-
 import mergeron.core.excel_helper as xlh
 import mergeron.core.guidelines_boundaries as gbl
 import mergeron.ext.tol_colors as ptcolor
+import mergeron.gen.investigations_stats as isl
+from jinja2 import FileSystemLoader
+from joblib import Parallel, cpu_count, delayed
 from mergeron import DATA_DIR
+from numpy import pi
+from xlsxwriter import Workbook
 
 PROG_PATH = Path(__file__)
 
@@ -79,6 +80,13 @@ BDRY_SPECS_DICT: Mapping[str, Mapping[str, Any]] = {
         "func_str": R"s_M",
         "func": gbl.combined_share_boundary,
     },
+    "SAG Average Div Ratio": {
+        "title_str": "Aggregated-diversion-ratio boundary, simple average",
+        "sheet_name": "SAG, average",
+        "func_str": R"(d_{12} + d_{21}) / 2",
+        "func": gbl.shrratio_boundary_wtd_avg,
+        "func_kwargs": {"wgtng_policy": None, "recapture_spec": RECAPTURE_SPEC},
+    },
     "SAG Div Ratio Distance": {
         "title_str": "Aggregated-diversion-ratio boundary, distance",
         "sheet_name": "SAG, distance",
@@ -90,13 +98,6 @@ BDRY_SPECS_DICT: Mapping[str, Mapping[str, Any]] = {
             "avg_method": "distance",
         },
     },
-    "SAG Average Div Ratio": {
-        "title_str": "Aggregated-diversion-ratio boundary, simple average",
-        "sheet_name": "SAG, average",
-        "func_str": R"(d_{12} + d_{21}) / 2",
-        "func": gbl.shrratio_boundary_xact_avg,
-        "func_kwargs": {"recapture_spec": RECAPTURE_SPEC},
-    },
     "CPSWAG Premerger HHI-contribution": {
         "title_str": "Premerger HHI-contribution boundary",
         "sheet_name": "CPSWAG, HHI-contrib-pre",
@@ -133,7 +134,7 @@ BDRY_SPECS_DICT: Mapping[str, Mapping[str, Any]] = {
 }
 
 
-def tabulate_boundary_stats(_gpubyr: Literal[1992, 2010, 2023], /) -> None:
+def tabulate_boundary_stats(_gpubyr: gbl.HMGPubYear, /) -> None:
     """
     Parameters
     ----------
@@ -142,15 +143,17 @@ def tabulate_boundary_stats(_gpubyr: Literal[1992, 2010, 2023], /) -> None:
         are drawn
 
     """
+    _invres_rate_table_content = isl.StatsContainer()
+
     gso = gbl.GuidelinesThresholds(_gpubyr)
     _dhhi_val, _r_val, _g_val = (
         getattr(gso.presumption, _f) for _f in ("delta", "rec", "guppi")
     )
 
     _dhhi_seq = (
-        (0.01, 0.02, 0.03125, 0.05, _dhhi_val)
+        (0.005, 0.01, 0.02, gso.imputed_presumption.delta, 0.08)
         if _gpubyr == 2010
-        else (0.005, 0.01, 0.02, 0.03125, _dhhi_val)
+        else (0.005, 0.01, 0.02, gso.imputed_presumption.delta, 0.08)
     )
 
     _bdry_approx_data_dict = {
@@ -166,7 +169,7 @@ def tabulate_boundary_stats(_gpubyr: Literal[1992, 2010, 2023], /) -> None:
                 ),
             )
             for _k in BDRY_SPECS_DICT
-            if not _k.endswith("Distance")
+            # if not _k.endswith("Distance")
         }
     }
     _bdry_approx_data_dict |= {
@@ -176,32 +179,46 @@ def tabulate_boundary_stats(_gpubyr: Literal[1992, 2010, 2023], /) -> None:
     }
 
     _bdry_data = Parallel(n_jobs=-1)(
-        delayed(_dhhi_stats)(_dhhi_val, _r_val, _g_val) for _dhhi_val in _dhhi_seq
+        delayed(_dhhi_stats)(_dhhi_val, _r_val) for _dhhi_val in _dhhi_seq
     )
     _bdry_approx_data_dict |= dict(_bdry_data)
 
-    print(" & ".join(_k for _k in _bdry_approx_data_dict), R" \\")
+    _data_str = ""
+    _data_str = "{} \\\\ \n".format(
+        " & ".join(
+            _k.replace("Criterion", R"{\text{} \\ Criterion}")  # \phantom{Criterion}
+            for _k in _bdry_approx_data_dict
+        )
+    )
     for _sk in _bdry_approx_data_dict["Criterion"]:
-        print(
-            " & ".join(
-                _bdry_approx_data_dict[_k][_sk] for _k in _bdry_approx_data_dict
-            ),
-            R"\\",
+        _data_str += "{} \\\\ \n".format(
+            " & ".join(_bdry_approx_data_dict[_k][_sk] for _k in _bdry_approx_data_dict)
         )
+    print(_data_str)
+
+    _invres_rate_table_content.data_str = _data_str
+
+    _j2_env = isl.latex_jinja_env
+    _j2_env.loader = FileSystemLoader(str(PROG_PATH.parent / "templates"))
+    _j2_templ = _j2_env.get_template(
+        "concentration_as_diversion_intrinsic_enforcement_rates.tex.jinja2"
+    )
+    PROG_PATH.parents[1].joinpath(
+        f"{PROG_PATH.stem}_intrinsic_enforcement_rates_{_gpubyr}.tex"
+    ).write_text(_j2_templ.render(tmpl_data=_invres_rate_table_content))
 
 
-def _dhhi_stats(
-    _dhhi_val: float, _r_val: float, _g_val: float
-) -> tuple[str, dict[str, str]]:
+def _dhhi_stats(_dhhi_val: float, _r_val: float) -> tuple[str, dict[str, str]]:
     _dhhi_val = round(_dhhi_val, 5)
 
-    _r_val = round(_r_val, 4)
-    _s_mid = sqrt(_dhhi_val / 2)
+    _divr_val = gbl.gbd_from_dsf(_dhhi_val, r_bar=_r_val)
+    _delta_val = gbl.critical_shrratio(_divr_val, r_bar=_r_val)
+    # _s_mid = sqrt(_dhhi_val / 2)
 
-    _delta_val = _s_mid / (1 - _s_mid)
-    if _dhhi_val * 1e4 in (50, 100, 200):
-        _delta_val = gbl.round_cust(_r_val * _delta_val) / _r_val
-    _divr_val = _r_val * _delta_val
+    # _delta_val = _s_mid / (1 - _s_mid)
+    # if _dhhi_val * 1e4 in (50, 100, 200):
+    #     _delta_val = gbl.critical_shrratio()(_r_val * _delta_val) / _r_val
+    # _divr_val = _r_val * _delta_val
 
     print(
         "Processing data for ΔHHI = {0:.{1}f} points;".format(
@@ -238,15 +255,16 @@ def _bdry_stats_col(
             return _bdry_spec, f"{_hhi_m_pre_prob:6.5f}"
         case _ if "Div Ratio" in _bdry_spec:
             _gbd_func = BDRY_SPECS_DICT[_bdry_spec]["func"]
-            _, _within_bdry_area = _gbd_func(
+            _within_bdry_area = _gbd_func(
                 _delta_val, _r_val, **BDRY_SPECS_DICT[_bdry_spec].get("func_kwargs", {})
-            )
+            ).area
             _within_bdry_prob = 2 * _within_bdry_area
-            _within_conc_bdry_prob = (
-                _hhi_m_pre_prob
-                if _bdry_spec.startswith("CPSWAG")
-                else (_cs_prob if _bdry_spec.startswith("SAG") else _dhhi_prob)
-            )
+            if _bdry_spec.startswith("CPSWAG"):
+                _within_conc_bdry_prob = _hhi_m_pre_prob
+            elif _bdry_spec.startswith("SAG"):
+                _within_conc_bdry_prob = _cs_prob
+            else:
+                _within_conc_bdry_prob = _dhhi_prob
 
             return _bdry_spec, R"{{ {:6.5f} \\ {:.2f}\% }}".format(
                 _within_bdry_prob,
@@ -257,7 +275,7 @@ def _bdry_stats_col(
 
 
 def plot_and_save_boundary_coords(
-    _gpubyr: Literal[1992, 2010, 2023],
+    _gpubyr: gbl.HMGPubYear,
     _xl_book: Workbook,
     /,
     layout: Literal["collected", "distributed"] = "collected",
@@ -599,8 +617,9 @@ def boundary_data_to_worksheet(
 
 
 if __name__ == "__main__":
-    for gpubyr in [1992, 2010, 2023][2:]:
-        # tabulate_boundary_stats(gpubyr)
+    gpubyrs: list[gbl.HMGPubYear] = [1992, 2010, 2023]
+    for gpubyr in gpubyrs[2:][:1]:
+        tabulate_boundary_stats(gpubyr)
 
         # Initiliaze workbook for saving boundary coordinates
         with Workbook(

mergeron/gen/_data_generation_functions_nonpublic.py

@@ -5,17 +5,13 @@ Non-public functions called in data_generation.py
 from __future__ import annotations
 
 from importlib.metadata import version
-
-from .. import _PKG_NAME  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
 from typing import Literal
 
 import numpy as np
 from numpy.random import SeedSequence
 from numpy.typing import NDArray
 
+from .. import _PKG_NAME  # noqa: TID252
 from ..core.damodaran_margin_data import resample_mgn_data  # noqa: TID252
 from ..core.pseudorandom_numbers import (  # noqa: TID252
     DIST_PARMS_DEFAULT,
@@ -37,6 +33,8 @@ from . import (
     SSZConstants,
 )
 
+__version__ = version(_PKG_NAME)
+
 
 def _gen_share_data(
     _mkt_sample_spec: MarketSampleSpec,

mergeron/gen/data_generation.py

@@ -7,15 +7,12 @@ from __future__ import annotations
 
 from importlib.metadata import version
 
-from .. import _PKG_NAME  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
 import attrs
 import numpy as np
 from numpy.random import SeedSequence
 from numpy.typing import NDArray
 
+from .. import _PKG_NAME  # noqa: TID252
 from . import (
     EMPTY_ARRAY_DEFAULT,
     TF,
@@ -35,6 +32,8 @@ from ._data_generation_functions_nonpublic import (
     _gen_share_data,
 )
 
+__version__ = version(_PKG_NAME)
+
 
 def gen_market_sample(
     _mkt_sample_spec: MarketSampleSpec,

mergeron/gen/investigations_stats.py

@@ -3,16 +3,10 @@ Routines to format and print summary data on merger enforcement patterns.
 
 """
 
-import subprocess
-from importlib.metadata import version
-
-from .. import _PKG_NAME, DATA_DIR  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
-
 import enum
+import subprocess
 from collections.abc import Mapping, Sequence
+from importlib.metadata import version
 from pathlib import Path
 from types import SimpleNamespace
 
@@ -22,10 +16,13 @@ from jinja2 import Environment, FileSystemLoader, Template, select_autoescape
 from numpy.typing import NDArray
 from scipy.interpolate import interp1d  # type: ignore
 
+from .. import _PKG_NAME, DATA_DIR  # noqa: TID252
 from ..core import ftc_merger_investigations_data as fid  # noqa: TID252
 from ..core.proportions_tests import propn_ci  # noqa: TID252
 from . import TF, TI, INVResolution
 
+__version__ = version(_PKG_NAME)
+
 
 @enum.unique
 class INDGRPConstants(enum.StrEnum):

mergeron/gen/upp_tests.py

@@ -4,16 +4,11 @@ from generated market data.
 
 """
 
-from importlib.metadata import version
-from pathlib import Path
-
-from .. import _PKG_NAME  # noqa: TID252
-
-__version__ = version(_PKG_NAME)
-
 from collections.abc import Sequence
 from contextlib import suppress
 from dataclasses import fields
+from importlib.metadata import version
+from pathlib import Path
 from typing import Literal, TypeAlias, TypedDict
 
 import numpy as np
@@ -24,6 +19,7 @@ from joblib import Parallel, cpu_count, delayed  # type: ignore
 from numpy.random import SeedSequence
 from numpy.typing import NDArray
 
+from .. import _PKG_NAME  # noqa: TID252
 from ..core import guidelines_boundaries as gbl  # noqa: TID252
 from . import (
     EMPTY_ARRAY_DEFAULT,
@@ -40,6 +36,9 @@ from . import (
 from . import data_generation as dgl
 from . import investigations_stats as isl
 
+__version__ = version(_PKG_NAME)
+
+
 ptb.parameters.MAX_NUMEXPR_THREADS = 8
 ptb.parameters.MAX_BLOSC_THREADS = 4
 

{mergeron-2024.738949.0.dist-info → mergeron-2024.738949.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergeron
-Version: 2024.738949.0
+Version: 2024.738949.5
 Summary: Analysis of standards defined in Horizontal Merger Guidelines
 License: MIT
 Keywords: merger policy analysis,merger guidelines,merger screening,policy presumptions,concentration standards,upward pricing pressure,GUPPI

{mergeron-2024.738949.0.dist-info → mergeron-2024.738949.5.dist-info}/RECORD

@@ -2,14 +2,14 @@ mergeron/License.txt,sha256=csSkn4lgUmJ0VEw1KAFZ3a8q0L4XccUdJ6Jj6xSNNRY,1246
 mergeron/__init__.py,sha256=gk_2mS6jdui5fVmVHHfZVaEG9LyO3vfRATnES29ajRA,398
 mergeron/core/InCommon RSA Server CA cert chain.pem,sha256=W8TqydgY8jphQ4fr6WMdT6jLwqFjHLpx8fFr3LXub4s,4292
 mergeron/core/__init__.py,sha256=iyfxkX3-SoMS4ZQZKHKPn8JEMN536vpty9oSZf0LHv8,115
-mergeron/core/damodaran_margin_data.py,sha256=N1SU_PDjFMoCzCqone-If-gR4PpcG-MK5TfayusOJLs,8166
-mergeron/core/excel_helper.py,sha256=_TkoWMPB4MZSVcP6qzqwqWWHcxHFrJu7prMbIArC98w,8079
-mergeron/core/ftc_merger_investigations_data.py,sha256=8Zn-kbEg6J6R-qkpkkq-8kBHJt7QbGcRPn9hpjgFfP4,26761
-mergeron/core/guidelines_boundaries.py,sha256=uWQUoVn2SCL-4cCTUkEPfeMTmFpIHLfMXFMTPNV0mqA,44733
-mergeron/core/proportions_tests.py,sha256=YER1RTLSTSyNbP4ZUkvUWTViUv4lxlnRCCKuC6HbWXI,15320
-mergeron/core/pseudorandom_numbers.py,sha256=ZnIE1ixp3JcgJjlulgMsIcWFVAxeyjC9lsiMIk7OHlM,9430
+mergeron/core/damodaran_margin_data.py,sha256=DHTQdFjuZ5Yl3Dbq0db0QR4FHUqJpZj4yi5zdUncLtg,8166
+mergeron/core/excel_helper.py,sha256=wU3Y325r_YNfoyr92y605m_9ZCDJ01WiR-vahi4KGmc,8094
+mergeron/core/ftc_merger_investigations_data.py,sha256=YYkgeF-b_2_Tk8dsy_4dMz5QpV5UQEr7tB9ORiqKmww,26760
+mergeron/core/guidelines_boundaries.py,sha256=E38g6aonHqqFiSP0Duh_UfUGaHkZlKQt-23Q7EAEtBA,50541
+mergeron/core/proportions_tests.py,sha256=tCrbya1el5u1OFOXphODP6yWOGywuNY6z9LBTsNRKzM,15320
+mergeron/core/pseudorandom_numbers.py,sha256=mSAMJ1zZ58k8j9duT3Ohi_1TCjZaFG1Ud1P_JI1ryYY,9430
 mergeron/examples/__init__.py,sha256=iyfxkX3-SoMS4ZQZKHKPn8JEMN536vpty9oSZf0LHv8,115
-mergeron/examples/concentration_as_diversion.py,sha256=p9-VzqC8Tb3fMJD1mLnqmMnvOCrCTULjIPCEG0RhASQ,20645
+mergeron/examples/concentration_as_diversion.py,sha256=oDo5InVGLL-pON_ror8XWOMwC6S2dnDvei7Yw_AXgFw,21620
 mergeron/examples/enforcement_boundaries_for_mergers_with_asymmetric_shares.py,sha256=-jOHETKp788pqKTv7U25t28UzVtJNMmUn1FVH7jCiCU,16020
 mergeron/examples/enforcement_boundaries_for_symmetric_firm_mergers.py,sha256=DAljm5NJquE56f-x4pLXzKCdhYQyVpWaM8uGlD6rIEs,5779
 mergeron/examples/example_parameterizations.py,sha256=VP-hi7L0j30ffcEzmJ3P8mOj1VjwEWKCTZSx_CaVQxA,4197
@@ -25,10 +25,10 @@ mergeron/examples/visualize_guidelines_tests.py,sha256=VE3aotuFOsU-CSt4SymRG8_iV
 mergeron/ext/__init__.py,sha256=iyfxkX3-SoMS4ZQZKHKPn8JEMN536vpty9oSZf0LHv8,115
 mergeron/ext/tol_colors.py,sha256=wFOHZXWZonbp9mhmSGu9mVujBYhdTsvx9_WikMpoCmo,22229
 mergeron/gen/__init__.py,sha256=MxjGj4bHklt6R-Xc-iT46pgK4XZNlcMDErnlF3jA7LU,16787
-mergeron/gen/_data_generation_functions_nonpublic.py,sha256=fQu-CEfjdHeCod-6nrejpXAvV1dTG6H4bZBTXVd5j9s,21370
-mergeron/gen/data_generation.py,sha256=52youq5pmg-cuJo9tefy8Kab4_fyWgmQrFrazIqHnGg,8868
-mergeron/gen/investigations_stats.py,sha256=ByLTr3rkvGjKxoOkBvB74WTugvilE1lLEP67OYhDWMs,22815
-mergeron/gen/upp_tests.py,sha256=0qytw39LIDfSR_aS-wpu7NikNfcnlos9EYQaLgkCQZg,16188
+mergeron/gen/_data_generation_functions_nonpublic.py,sha256=zBrgIkeaR-5pMZ5sowiM_CkGEqWsTgS7xeZNhB9m4rg,21368
+mergeron/gen/data_generation.py,sha256=uG2-O_JNMH9acm7U91X_XXFnevGbue6sbrQ88RxzzrQ,8867
+mergeron/gen/investigations_stats.py,sha256=cZgghfUHmyU4ZY0Fi8R4iwf21YwzAzbrNpYsNbgEq6g,22812
+mergeron/gen/upp_tests.py,sha256=zc8DUIy66m9jnEwLaX4jSRoNnsf4KgXJL1uVpyd0xYc,16187
 mergeron/jinja_LaTex_templates/clrrate_cis_summary_table_template.tex.jinja2,sha256=ae4JiciU-pt8YAM8mRbsmt4W6ePuN1y1NPCWD95oXIo,4833
 mergeron/jinja_LaTex_templates/ftcinvdata_byhhianddelta_table_template.tex.jinja2,sha256=ODEurkC0UHuWpjRUiQpeW85njSeUEUJYRdYg8gqoEq0,3642
 mergeron/jinja_LaTex_templates/ftcinvdata_summary_table_template.tex.jinja2,sha256=h8_DEE0iskT9tnga5lZtxcoevN7pY4iKF-maErt4UU4,2906
@@ -37,6 +37,6 @@ mergeron/jinja_LaTex_templates/mergeron.cls,sha256=AV2mk4-uERvAuMkE95Ka7el6LZsb0
 mergeron/jinja_LaTex_templates/mergeron_table_collection_template.tex.jinja2,sha256=nr6xUI0_2KHG4Sz9k1JFVQjs2h9qS9BGt1MeE6Tygs8,2429
 mergeron/jinja_LaTex_templates/setup_tikz_tables.tex.jinja2,sha256=WKVxtp3eoMchfGliQAJMj4w2FtBkWG5z2V3-hBYUYUQ,3292
 mergeron/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-mergeron-2024.738949.0.dist-info/METADATA,sha256=frwPeN3n7LB93DCX30amODqFJyAfwNbX5ErHWbU9rY4,6362
-mergeron-2024.738949.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-mergeron-2024.738949.0.dist-info/RECORD,,
+mergeron-2024.738949.5.dist-info/METADATA,sha256=v_U_sf-0kwTsgcg3SpLqUv5X9iaTHBOVhuMAt4N7xb0,6362
+mergeron-2024.738949.5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+mergeron-2024.738949.5.dist-info/RECORD,,