mergeron 2024.739125.3__py3-none-any.whl → 2024.739127.1__py3-none-any.whl

mergeron/__init__.py

@@ -2,14 +2,13 @@ from __future__ import annotations
 
 import enum
 from pathlib import Path
-from typing import TypeAlias
 
 import numpy as np
 from numpy.typing import NDArray
 
 _PKG_NAME: str = Path(__file__).parent.stem
 
-VERSION = "2024.739125.3"
+VERSION = "2024.739127.1"
 
 __version__ = VERSION
 
@@ -25,21 +24,21 @@ if not DATA_DIR.is_dir():
 np.set_printoptions(precision=18)
 
 
-ArrayINT = NDArray[np.intp]
-ArrayFloat = NDArray[np.half | np.single | np.double]
+type ArrayINT = NDArray[np.intp]
+type ArrayFloat = NDArray[np.half | np.single | np.double]
 
 
-ArrayBoolean: TypeAlias = NDArray[np.bool_]
+type ArrayBoolean = NDArray[np.bool_]
 
-ArrayDouble: TypeAlias = NDArray[np.double]
-ArrayBIGINT: TypeAlias = NDArray[np.int64]
+type ArrayDouble = NDArray[np.double]
+type ArrayBIGINT = NDArray[np.int64]
 
 DEFAULT_REC_RATE = 0.85
 
 
 @enum.unique
 class RECForm(enum.StrEnum):
-    """Recapture rate - derivation methods."""
+    """For derivation of recapture rate from market shares."""
 
     INOUT = "inside-out"
     OUTIN = "outside-in"
@@ -49,7 +48,7 @@ class RECForm(enum.StrEnum):
 @enum.unique
 class UPPAggrSelector(enum.StrEnum):
     """
-    Aggregator selection for GUPPI and diversion ratio
+    Aggregator for GUPPI and diversion ratio estimates.
 
     """
 

mergeron/core/ftc_merger_investigations_data.py

@@ -14,7 +14,7 @@ from importlib import resources
 from operator import itemgetter
 from pathlib import Path
 from types import MappingProxyType
-from typing import Any, NamedTuple, TypeAlias
+from typing import Any, NamedTuple
 
 import msgpack  # type: ignore
 import msgpack_numpy as m  # type: ignore
@@ -95,7 +95,7 @@ class INVTableData(NamedTuple):
     data_array: ArrayBIGINT
 
 
-INVData: TypeAlias = Mapping[str, Mapping[str, Mapping[str, INVTableData]]]
+type INVData = Mapping[str, Mapping[str, Mapping[str, INVTableData]]]
 
 
 def construct_data(

mergeron/core/guidelines_boundaries.py

@@ -7,7 +7,7 @@ with a canvas on which to draw boundaries for Guidelines standards.
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Literal, TypeAlias
+from typing import Literal
 
 import numpy as np
 from attrs import Attribute, field, frozen, validators
@@ -28,7 +28,7 @@ __version__ = VERSION
 mp.prec = 80
 mp.trap_complex = True
 
-HMGPubYear: TypeAlias = Literal[1992, 2004, 2010, 2023]
+type HMGPubYear = Literal[1992, 2004, 2010, 2023]
 
 
 @dataclass(frozen=True)

mergeron/demo/visualize_empirical_margin_distribution.py

@@ -48,10 +48,9 @@ with warnings.catch_warnings():
 mgn_kde = stats.gaussian_kde(mgn_data_obs, weights=mgn_data_wts, bw_method="silverman")
 mgn_kde.set_bandwidth(bw_method=mgn_kde.factor / 3.0)
 
-mgn_xvec = np.linspace(0, BIN_COUNT, 10**5) / BIN_COUNT
 mgn_ax.plot(
-    mgn_xvec,
-    mgn_kde(mgn_xvec),
+    (_xv := np.linspace(0, BIN_COUNT, 10**5) / BIN_COUNT),
+    mgn_kde(_xv),
     color="#004488",
     rasterized=True,
     label="Estimated Density",

mergeron/gen/data_generation.py

@@ -34,7 +34,7 @@ from .data_generation_functions import (
     gen_share_data,
     parse_seed_seq_list,
 )
-from .upp_tests import SaveData, enf_cnts, save_data_to_hdf5
+from .upp_tests import SaveData, compute_upp_test_counts, save_data_to_hdf5
 
 __version__ = VERSION
 
@@ -113,15 +113,13 @@ class MarketSample:
 
     enf_counts: UPPTestsCounts = field(default=None)
 
-    def gen_market_sample(
+    def _gen_market_sample(
         self,
         /,
         *,
-        sample_size: int = 10**6,
-        seed_seq_list: Sequence[SeedSequence] | None = None,
-        nthreads: int = 16,
-        save_data_to_file: SaveData = False,
-        saved_array_name_suffix: str = "",
+        sample_size: int,
+        seed_seq_list: Sequence[SeedSequence] | None,
+        nthreads: int,
     ) -> MarketDataSample:
         """
         Generate share, diversion ratio, price, and margin data for MarketSpec.
@@ -242,11 +240,11 @@ class MarketSample:
         self,
         /,
         *,
-        sample_size: int,
-        seed_seq_list: Sequence[SeedSequence],
-        nthreads: int,
-        save_data_to_file: SaveData,
-        saved_array_name_suffix: str,
+        sample_size: int = 10**6,
+        seed_seq_list: Sequence[SeedSequence] | None = None,
+        nthreads: int = 16,
+        save_data_to_file: SaveData = False,
+        saved_array_name_suffix: str = "",
     ) -> None:
         """Populate :attr:`data` with generated data
 
@@ -258,7 +256,7 @@ class MarketSample:
 
         """
 
-        self.data = self.gen_market_sample(
+        self.data = self._gen_market_sample(
             sample_size=sample_size, seed_seq_list=seed_seq_list, nthreads=nthreads
         )
 
@@ -275,7 +273,7 @@ class MarketSample:
             save_data_to_file=save_data_to_file,
         )
 
-    def sim_enf_cnts(
+    def _sim_enf_cnts(
         self,
         _upp_test_parms: gbl.HMGThresholds,
         _sim_test_regime: UPPTestRegime,
@@ -322,7 +320,7 @@ class MarketSample:
 
         """
 
-        _market_data_sample = self.gen_market_sample(
+        _market_data_sample = self._gen_market_sample(
             sample_size=sample_size, seed_seq_list=seed_seq_list, nthreads=nthreads
         )
 
@@ -339,7 +337,7 @@ class MarketSample:
             save_data_to_file=save_data_to_file,
         )
 
-        _upp_test_arrays = enf_cnts(
+        _upp_test_arrays = compute_upp_test_counts(
             _market_data_sample, _upp_test_parms, _sim_test_regime
         )
 
@@ -351,7 +349,7 @@ class MarketSample:
 
         return _upp_test_arrays
 
-    def sim_enf_cnts_ll(
+    def _sim_enf_cnts_ll(
         self,
         _enf_parm_vec: gbl.HMGThresholds,
         _sim_test_regime: UPPTestRegime,
@@ -435,7 +433,7 @@ class MarketSample:
         })
 
         _res_list = Parallel(n_jobs=_thread_count, prefer="threads")(
-            delayed(self.sim_enf_cnts)(
+            delayed(self._sim_enf_cnts)(
                 _enf_parm_vec,
                 _sim_test_regime,
                 **_sim_enf_cnts_kwargs,
@@ -474,7 +472,7 @@ class MarketSample:
         save_data_to_file: SaveData = False,
         saved_array_name_suffix: str = "",
     ) -> None:
-        """Populate :attr:`enf_counts` etimated test counts.
+        """Populate :attr:`enf_counts` with estimated UPP test counts.
 
         Parameters
         ----------
@@ -510,7 +508,7 @@ class MarketSample:
         """
 
         if self.data is None:
-            self.enf_counts = self.sim_enf_cnts_ll(
+            self.enf_counts = self._sim_enf_cnts_ll(
                 _enf_parm_vec,
                 _upp_test_regime,
                 sample_size=sample_size,
@@ -520,7 +518,9 @@ class MarketSample:
                 saved_array_name_suffix=saved_array_name_suffix,
             )
         else:
-            self.enf_counts = enf_cnts(self.data, _enf_parm_vec, _upp_test_regime)
+            self.enf_counts = compute_upp_test_counts(
+                self.data, _enf_parm_vec, _upp_test_regime
+            )
             if save_data_to_file:
                 save_data_to_hdf5(
                     self.enf_counts,