mergeron 2024.739104.1__tar.gz → 2024.739105.2__tar.gz

mergeron-2024.739105.2/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.1
+Name: mergeron
+Version: 2024.739105.2
+Summary: Merger Policy Analysis using Python
+License: MIT
+Keywords: merger policy analysis,merger guidelines,merger screening,policy presumptions,concentration standards,upward pricing pressure,GUPPI
+Author: Murthy Kambhampaty
+Author-email: smk@capeconomics.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+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 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Dist: aenum (>=3.1.15,<4.0.0)
+Requires-Dist: attrs (>=23.2)
+Requires-Dist: bs4 (>=0.0.1)
+Requires-Dist: certifi (>=2023.11.17)
+Requires-Dist: google-re2 (>=1.1)
+Requires-Dist: jinja2 (>=3.1)
+Requires-Dist: joblib (>=1.3)
+Requires-Dist: matplotlib (>=3.8)
+Requires-Dist: mpmath (>=1.3)
+Requires-Dist: msgpack (>=1.0)
+Requires-Dist: msgpack-numpy (>=0.4)
+Requires-Dist: numpy (>=1.26,<2)
+Requires-Dist: scipy (>=1.12)
+Requires-Dist: sympy (>=1.12)
+Requires-Dist: tables (>=3.8)
+Requires-Dist: types-beautifulsoup4 (>=4.11.2)
+Requires-Dist: urllib3 (>=2.2.2,<3.0.0)
+Requires-Dist: xlrd (>=2.0.1,<3.0.0)
+Requires-Dist: xlsxwriter (>=3.1)
+Description-Content-Type: text/x-rst
+
+mergeron: Merger Policy Analysis using Python
+=============================================
+
+Analyze the sets of mergers conforming to concentration and diversion ratio bounds. Analyze intrinsic enforcement rates, and intrinsic clearance rates, under concentration, diversion ratio, GUPPI, CMCR, and IPR bounds using generated data with specified distributions of market shares, price-cost margins, firm counts, and prices, optionally imposing restrictions implied by statutory filing thresholds and/or Bertrand-Nash oligopoly with MNL demand. Download and analyze merger investigations data published by the U.S. Federal Trade Commission in various reports on extended merger investigations (Second Requests) during 1996 to 2011.
+
+Here, enforcement rates derived with merger enforcement as being exogenous to firm conduct are defined as intrinsic enforcement rates, and similarly intrinsic clearance rates. Depending on the merger enforcement regime, or merger control regime, intrinsic enforcement rates may also not be the complement of intrinsic clearance rates, i.e, it is not necessarily true that the intrinsic clearance rate estimate for a given enforcement regime is 1 minus the intrinsic enforcement rate. In contrast, observed enforcement rates reflect the deterrent effects of merger enforcement on firm conduct as well as the effects of merger screening on the level of enforcement; and, by definition, the observed clearance rate is 1 minus the observed enforcement rate.
+
+Introduction
+------------
+
+Module :code:`.core.guidelines_boundaries` includes classes for specifying concentration bounds (:code:`..core.guidelines_boundaries.ConcentrationBoundary`) and diversion-ratio bounds (:code:`..core.guidelines_boundaries.DiversionRatioBoundary`), with automatic generation of boundary (as an array of share-pairs) and area. This module also includes a function for generating plots of concentration and diversion-ratio boundaries, and functions for mapping GUPPI standards to concentration (ΔHHI) standards, and vice-versa.
+
+Module :code:`.gen.data_generation` includes the :code:`.gen.data_generation.MarketSample` which provides for a rich specification of shares and diversion ratios (:code:`.gen.data_generation.MarketSample.share_spec`), margins (:code:`.gen.data_generation.MarketSample.pcm_spec`, prices (:code:`.gen.data_generation.MarketSample.price_spec`), and HSR filing requirements (:code:`.gen.data_generation.MarketSample.hsr_filing_test_type`), and with methods for, (i) generating sample data (:code:`.gen.data_generation.MarketSample.generate_sample`), and (ii) estimating enforcement or clearance rates under specified enforcement regimes given a method of aggregating diversion ratio or GUPPI estimates for the firms in a merger (:code:`.gen.data_generation.MarketSample.estimate_enf_counts`). While the latter populate the properties, :code:`.gen.data_generation.MarketSample.data`
+and :code:`.gen.data_generation.MarketSample.enf_counts`, respectively, the underlying methods for generating standalone :code:`MarketDataSample` and :code:`UPPTestCounts` objects are included in the class definition, with helper functions defined in the modules, :code:`.gen.data_generation_functions` and :code:`.gen.upp_tests`. Notably, market shares are generated for a sample of markets with firm-count distributed as specified in :code:`.gen.data_generation.MarketSample.ShareSpec.firm_count_weights`, with defaults as discussed below (also see, :code:`.gen.ShareSpec.firm_count_weights`.
+
+By default, merging-firm shares are drawn with uniform distribution over the space :math:`s_1 + s_2 \leqslant 1` for an unspecified number of firms. Alternatively, shares may be drawn from the Dirichlet distribution, with specified shape parameters (see :code:`.gen.data_generation.MarketSample.ShareSpec`, and, specifically, :code:`.gen.SHRDistribution`). When drawing shares from the Dirichlet distribution, the user passes, using :code:`.gen.data_generation.MarketSample.ShareSpec.firm_count_weights`, a vector of weights specifying the frequency distribution over sequential firm counts, e.g., :code:`[133, 184, 134, 52, 32, 10, 12, 4, 3]` to specify shares drawn from Dirichlet distributions with 2 to 10 pre-merger firms distributed as in data for FTC merger investigations during 1996--2003 (See, for example, Table 4.1 of `FTC, Horizontal Merger Investigations Data, Fiscal Years 1996--2003 (Revised: August 31, 2004) <https://www.ftc.gov/sites/default/files/documents/reports/horizontal-merger-investigation-data-fiscal-years-1996-2003/040831horizmergersdata96-03.pdf>`_). If :code:`.gen.data_generation.MarketSample.ShareSpec.firm_count_weights` is not explicitly assigned a value when defining :code:`.gen.data_generation.MarketSample.ShareSpec`, the default values is used, which results in a sample of markets with 2 to 7 firms with relative frequency in inverse proportion to firm-count, with 2-firm markets being 6 times as likely to be drawn as 7-firm markets.
+
+Recapture rates can be specified as, "proportional", "inside-out", "outside-in" (see :code:`.RECForm`. The "inside-out" specification (:code:`.gen.data_generation.MarketSample.ShareSpec.recapture_form`:code:` = `:code:`.RECForm.INOUT`) results in recapture ratios consistent with merging-firms' in-market shares and a default recapture rate. The "outside-in" specification (:code:`.gen.data_generation.MarketSample.ShareSpec.recapture_form`:code:` = `:code:`.RECForm.INOUT`) yields diversion ratios from purchase probabilities drawn at random for :math:`N+1` goods, from which are derived market shares and recapture rates for the :math:`N` goods in the putative market (see, :code:`.gen.ShareSpec`). The "outside-in" specification is invalid when the distribution of markets over firm-count is unspecified, i.e., when :code:`.gen.data_generation.MarketSample.ShareSpec.dist_type`:code:` ==`:code:`.gen.ShareDistributions.UNI`, thus raising a :code:`ValueError` exception. The "proportional" form (:code:`.gen.data_generation.MarketSample.ShareSpec.recapture_form`:code:` = `:code:`.RECForm.FIXED`) is often used in the literature, as an approximation to the "inside-out" form. See, for example, Coate (2011).
+
+Price-cost-margins may be specified as having uniform distribution, Beta distribution (including a bounded Beta distribution with specified mean and variance), or an empirical distribution (see, :code:`.gen.PCMSpec`). The empirical margin distribution is based on resampling margin data published by Prof. Damodaran of NYU Stern School of Business (see Notes), using an estimated Gaussian KDE. The second merging firm's margin (:code:`.gen.data_generation.MarketSample.PCMSpec.firm2_pcm_constraint`) may be specified as symmetric, i.i.d., or subject to equilibrium conditions for (profit-maximization in) Bertrand-Nash oligopoly with MNL demand (:code:`.gen.FM2Constraint`).
+
+Prices may be specified as symmetric or asymmetric, and in the latter case, the direction of correlation between merging firm prices, if any, can also be specified (see, :code:`.gen.PriceSpec`). Prices may also be defined by imposing cost symmetry on firms in the sample, with fixed unit marginal costs normalized to 1 unit, such that price equal :math:`1 / (1 - \pmb{m})`, where :math:`\pmb{m}` represents the array of margins for firms in the sample.
+
+The market sample may be restricted to mergers meeting the HSR filing requirement under two alternative approaches: in the one, the smaller of the two merging firms meets the lower HSR size threshold ($10 million, as adjusted) and the larger of the two merging firms meets the size test if it's share is no less than 10 times the share of the smaller firm. In the other, the :math:`n`-th firm's size is maintained as $10 million, as adjusted (see, :code:`.gen.SSZConstant`), and a merger meets the HSR filing test if either, (a.) the smaller merging firm is no smaller than the n-th firm and the larger merging firm is at 10-times as large as the n-th firm, or (b.) the smaller merging firm's market share is in excess of 10%; in effect this version of the test maintains that if the smaller merging firm's market share exceeds 10%, the value of the transaction exceeds $200 million, as adjusted, and the size-of-person test is eliminated (see, FTC (2008, p. 12); the above are simplifications of the statutory HSR filing requirements). The second assumption avoids the unfortunate assumption in the first that, within the resulting sample, the larger merging firm be at least 10 times as large as the smaller merging firm, as a consequence of the full definition of the HSR filing requirement.
+
+The full specification of a market sample is given in a :code:`.gen.data_generation.MarketSample` object, including the above parameters. Data are drawn by invoking :code:`.gen.data_generation.MarketSample.generate_sample` which adds a :code:`data` property of class, :code:`.gen.MarketDataSample`. Enforcement or clearance counts are computed by invoking :code:`.gen.data_generation.MarketSample.estimate_enf_counts`, which adds an :code:`enf_counts` property of class :code:`.gen.UPPTestsCounts`. For fast, parallel generation of enforcement or clearance counts over large market data samples that ordinarily would exceed available limits on machine memory, the user can invoke the method :code:`.gen.data_generation.MarketSample.estimate_enf_counts` on a :code:`.gen.data_generation.MarketSample` object without first invoking :code:`.gen.data_generation.MarketSample.generate_sample`. Note, however, that this strategy does not retain the market sample in memory in the interests of conserving memory and maintaining high performance (the user can specify that the market sample and enforcement statistics be stored to permanent storage; when saving to current PCIe NVMe storage, the performance penalty is slight, but can be considerable if saving to SATA storage).
+
+Enforcement statistics based on FTC investigations data and test data are printed to screen or rendered to LaTex files (for processing into publication-quality tables) using methods provided in :code:`.gen.enforcement_stats`.
+
+Programs demonstrating the use of this package are included in the sub-package, :code:`.demo`.
+
+This package includes  a class, :code:`.core.pseudorandom_numbers.MulithreadedRNG` for generating random numbers with selected continuous distribution over specified parameters, and with CPU multithreading on machines with multiple virtual, logical, or physical CPU cores. This class is an adaptation from the documentation of the :code:`numpy` package, from the discussion on `multithreaded random-number generation <https://numpy.org/doc/stable/reference/random/multithreading.html>_`; the version included here permits selection of the distribution with pre-tests to catch and inform on common errors. To access these directly:
+
+.. code-block:: python
+
+    import mergeron.core.pseudorandom_numbers as prng
+
+Documentation for this package is in the form of the API Reference. Documentation for individual functions and classes is accessible within a python shell. For example:
+
+.. code-block:: python
+
+    import mergeron.core.market_sample as market_sample
+
+    help(market_sample.MarketSample)
+
+.. rubric:: References
+
+.. _coate2011:
+
+Coate, M. B. (2011). Benchmarking the upward pricing pressure model with Federal Trade
+Commission evidence. Journal of Competition Law & Economics, 7(4), 825--846. URL: https://doi.org/10.1093/joclec/nhr014.
+
+.. _ftc_premerger_guide2:
+
+FTC Premerger Notification Office. “To File or Not to File: When You Must File a Premerger Notification Report Form”. 2008 (September, revised). URL: https://www.ftc.gov/sites/default/files/attachments/premerger-introductory-guides/guide2.pdf
+
+
+.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+   :alt: Poetry
+   :target: https://python-poetry.org/
+
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :alt: Ruff
+   :target: https://github.com/astral-sh/ruff
+
+.. image:: https://www.mypy-lang.org/static/mypy_badge.svg
+   :alt: Checked with mypy
+   :target: https://mypy-lang.org/
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :alt: License: MIT
+   :target: https://opensource.org/licenses/MIT
+
+

mergeron-2024.739105.2/README.rst

@@ -0,0 +1,73 @@
+mergeron: Merger Policy Analysis using Python
+=============================================
+
+Analyze the sets of mergers conforming to concentration and diversion ratio bounds. Analyze intrinsic enforcement rates, and intrinsic clearance rates, under concentration, diversion ratio, GUPPI, CMCR, and IPR bounds using generated data with specified distributions of market shares, price-cost margins, firm counts, and prices, optionally imposing restrictions implied by statutory filing thresholds and/or Bertrand-Nash oligopoly with MNL demand. Download and analyze merger investigations data published by the U.S. Federal Trade Commission in various reports on extended merger investigations (Second Requests) during 1996 to 2011.
+
+Here, enforcement rates derived with merger enforcement as being exogenous to firm conduct are defined as intrinsic enforcement rates, and similarly intrinsic clearance rates. Depending on the merger enforcement regime, or merger control regime, intrinsic enforcement rates may also not be the complement of intrinsic clearance rates, i.e, it is not necessarily true that the intrinsic clearance rate estimate for a given enforcement regime is 1 minus the intrinsic enforcement rate. In contrast, observed enforcement rates reflect the deterrent effects of merger enforcement on firm conduct as well as the effects of merger screening on the level of enforcement; and, by definition, the observed clearance rate is 1 minus the observed enforcement rate.
+
+Introduction
+------------
+
+Module :code:`.core.guidelines_boundaries` includes classes for specifying concentration bounds (:code:`..core.guidelines_boundaries.ConcentrationBoundary`) and diversion-ratio bounds (:code:`..core.guidelines_boundaries.DiversionRatioBoundary`), with automatic generation of boundary (as an array of share-pairs) and area. This module also includes a function for generating plots of concentration and diversion-ratio boundaries, and functions for mapping GUPPI standards to concentration (ΔHHI) standards, and vice-versa.
+
+Module :code:`.gen.data_generation` includes the :code:`.gen.data_generation.MarketSample` which provides for a rich specification of shares and diversion ratios (:code:`.gen.data_generation.MarketSample.share_spec`), margins (:code:`.gen.data_generation.MarketSample.pcm_spec`, prices (:code:`.gen.data_generation.MarketSample.price_spec`), and HSR filing requirements (:code:`.gen.data_generation.MarketSample.hsr_filing_test_type`), and with methods for, (i) generating sample data (:code:`.gen.data_generation.MarketSample.generate_sample`), and (ii) estimating enforcement or clearance rates under specified enforcement regimes given a method of aggregating diversion ratio or GUPPI estimates for the firms in a merger (:code:`.gen.data_generation.MarketSample.estimate_enf_counts`). While the latter populate the properties, :code:`.gen.data_generation.MarketSample.data`
+and :code:`.gen.data_generation.MarketSample.enf_counts`, respectively, the underlying methods for generating standalone :code:`MarketDataSample` and :code:`UPPTestCounts` objects are included in the class definition, with helper functions defined in the modules, :code:`.gen.data_generation_functions` and :code:`.gen.upp_tests`. Notably, market shares are generated for a sample of markets with firm-count distributed as specified in :code:`.gen.data_generation.MarketSample.ShareSpec.firm_count_weights`, with defaults as discussed below (also see, :code:`.gen.ShareSpec.firm_count_weights`.
+
+By default, merging-firm shares are drawn with uniform distribution over the space :math:`s_1 + s_2 \leqslant 1` for an unspecified number of firms. Alternatively, shares may be drawn from the Dirichlet distribution, with specified shape parameters (see :code:`.gen.data_generation.MarketSample.ShareSpec`, and, specifically, :code:`.gen.SHRDistribution`). When drawing shares from the Dirichlet distribution, the user passes, using :code:`.gen.data_generation.MarketSample.ShareSpec.firm_count_weights`, a vector of weights specifying the frequency distribution over sequential firm counts, e.g., :code:`[133, 184, 134, 52, 32, 10, 12, 4, 3]` to specify shares drawn from Dirichlet distributions with 2 to 10 pre-merger firms distributed as in data for FTC merger investigations during 1996--2003 (See, for example, Table 4.1 of `FTC, Horizontal Merger Investigations Data, Fiscal Years 1996--2003 (Revised: August 31, 2004) <https://www.ftc.gov/sites/default/files/documents/reports/horizontal-merger-investigation-data-fiscal-years-1996-2003/040831horizmergersdata96-03.pdf>`_). If :code:`.gen.data_generation.MarketSample.ShareSpec.firm_count_weights` is not explicitly assigned a value when defining :code:`.gen.data_generation.MarketSample.ShareSpec`, the default values is used, which results in a sample of markets with 2 to 7 firms with relative frequency in inverse proportion to firm-count, with 2-firm markets being 6 times as likely to be drawn as 7-firm markets.
+
+Recapture rates can be specified as, "proportional", "inside-out", "outside-in" (see :code:`.RECForm`. The "inside-out" specification (:code:`.gen.data_generation.MarketSample.ShareSpec.recapture_form`:code:` = `:code:`.RECForm.INOUT`) results in recapture ratios consistent with merging-firms' in-market shares and a default recapture rate. The "outside-in" specification (:code:`.gen.data_generation.MarketSample.ShareSpec.recapture_form`:code:` = `:code:`.RECForm.INOUT`) yields diversion ratios from purchase probabilities drawn at random for :math:`N+1` goods, from which are derived market shares and recapture rates for the :math:`N` goods in the putative market (see, :code:`.gen.ShareSpec`). The "outside-in" specification is invalid when the distribution of markets over firm-count is unspecified, i.e., when :code:`.gen.data_generation.MarketSample.ShareSpec.dist_type`:code:` ==`:code:`.gen.ShareDistributions.UNI`, thus raising a :code:`ValueError` exception. The "proportional" form (:code:`.gen.data_generation.MarketSample.ShareSpec.recapture_form`:code:` = `:code:`.RECForm.FIXED`) is often used in the literature, as an approximation to the "inside-out" form. See, for example, Coate (2011).
+
+Price-cost-margins may be specified as having uniform distribution, Beta distribution (including a bounded Beta distribution with specified mean and variance), or an empirical distribution (see, :code:`.gen.PCMSpec`). The empirical margin distribution is based on resampling margin data published by Prof. Damodaran of NYU Stern School of Business (see Notes), using an estimated Gaussian KDE. The second merging firm's margin (:code:`.gen.data_generation.MarketSample.PCMSpec.firm2_pcm_constraint`) may be specified as symmetric, i.i.d., or subject to equilibrium conditions for (profit-maximization in) Bertrand-Nash oligopoly with MNL demand (:code:`.gen.FM2Constraint`).
+
+Prices may be specified as symmetric or asymmetric, and in the latter case, the direction of correlation between merging firm prices, if any, can also be specified (see, :code:`.gen.PriceSpec`). Prices may also be defined by imposing cost symmetry on firms in the sample, with fixed unit marginal costs normalized to 1 unit, such that price equal :math:`1 / (1 - \pmb{m})`, where :math:`\pmb{m}` represents the array of margins for firms in the sample.
+
+The market sample may be restricted to mergers meeting the HSR filing requirement under two alternative approaches: in the one, the smaller of the two merging firms meets the lower HSR size threshold ($10 million, as adjusted) and the larger of the two merging firms meets the size test if it's share is no less than 10 times the share of the smaller firm. In the other, the :math:`n`-th firm's size is maintained as $10 million, as adjusted (see, :code:`.gen.SSZConstant`), and a merger meets the HSR filing test if either, (a.) the smaller merging firm is no smaller than the n-th firm and the larger merging firm is at 10-times as large as the n-th firm, or (b.) the smaller merging firm's market share is in excess of 10%; in effect this version of the test maintains that if the smaller merging firm's market share exceeds 10%, the value of the transaction exceeds $200 million, as adjusted, and the size-of-person test is eliminated (see, FTC (2008, p. 12); the above are simplifications of the statutory HSR filing requirements). The second assumption avoids the unfortunate assumption in the first that, within the resulting sample, the larger merging firm be at least 10 times as large as the smaller merging firm, as a consequence of the full definition of the HSR filing requirement.
+
+The full specification of a market sample is given in a :code:`.gen.data_generation.MarketSample` object, including the above parameters. Data are drawn by invoking :code:`.gen.data_generation.MarketSample.generate_sample` which adds a :code:`data` property of class, :code:`.gen.MarketDataSample`. Enforcement or clearance counts are computed by invoking :code:`.gen.data_generation.MarketSample.estimate_enf_counts`, which adds an :code:`enf_counts` property of class :code:`.gen.UPPTestsCounts`. For fast, parallel generation of enforcement or clearance counts over large market data samples that ordinarily would exceed available limits on machine memory, the user can invoke the method :code:`.gen.data_generation.MarketSample.estimate_enf_counts` on a :code:`.gen.data_generation.MarketSample` object without first invoking :code:`.gen.data_generation.MarketSample.generate_sample`. Note, however, that this strategy does not retain the market sample in memory in the interests of conserving memory and maintaining high performance (the user can specify that the market sample and enforcement statistics be stored to permanent storage; when saving to current PCIe NVMe storage, the performance penalty is slight, but can be considerable if saving to SATA storage).
+
+Enforcement statistics based on FTC investigations data and test data are printed to screen or rendered to LaTex files (for processing into publication-quality tables) using methods provided in :code:`.gen.enforcement_stats`.
+
+Programs demonstrating the use of this package are included in the sub-package, :code:`.demo`.
+
+This package includes  a class, :code:`.core.pseudorandom_numbers.MulithreadedRNG` for generating random numbers with selected continuous distribution over specified parameters, and with CPU multithreading on machines with multiple virtual, logical, or physical CPU cores. This class is an adaptation from the documentation of the :code:`numpy` package, from the discussion on `multithreaded random-number generation <https://numpy.org/doc/stable/reference/random/multithreading.html>_`; the version included here permits selection of the distribution with pre-tests to catch and inform on common errors. To access these directly:
+
+.. code-block:: python
+
+    import mergeron.core.pseudorandom_numbers as prng
+
+Documentation for this package is in the form of the API Reference. Documentation for individual functions and classes is accessible within a python shell. For example:
+
+.. code-block:: python
+
+    import mergeron.core.market_sample as market_sample
+
+    help(market_sample.MarketSample)
+
+.. rubric:: References
+
+.. _coate2011:
+
+Coate, M. B. (2011). Benchmarking the upward pricing pressure model with Federal Trade
+Commission evidence. Journal of Competition Law & Economics, 7(4), 825--846. URL: https://doi.org/10.1093/joclec/nhr014.
+
+.. _ftc_premerger_guide2:
+
+FTC Premerger Notification Office. “To File or Not to File: When You Must File a Premerger Notification Report Form”. 2008 (September, revised). URL: https://www.ftc.gov/sites/default/files/attachments/premerger-introductory-guides/guide2.pdf
+
+
+.. image:: https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json
+   :alt: Poetry
+   :target: https://python-poetry.org/
+
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+   :alt: Ruff
+   :target: https://github.com/astral-sh/ruff
+
+.. image:: https://www.mypy-lang.org/static/mypy_badge.svg
+   :alt: Checked with mypy
+   :target: https://mypy-lang.org/
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
+   :alt: License: MIT
+   :target: https://opensource.org/licenses/MIT
+

{mergeron-2024.739104.1 → mergeron-2024.739105.2}/pyproject.toml

@@ -13,7 +13,7 @@ keywords = [
     "upward pricing pressure",
     "GUPPI",
 ]
-version = "2024.739104.1"
+version = "2024.739105.2"
 
 # Classifiers list: https://pypi.org/classifiers/
 classifiers = [

{mergeron-2024.739104.1 → mergeron-2024.739105.2}/src/mergeron/__init__.py

@@ -9,7 +9,7 @@ from numpy.typing import NDArray
 
 _PKG_NAME: str = Path(__file__).parent.stem
 
-VERSION = "2024.739104.1"
+VERSION = "2024.739105.2"
 
 __version__ = VERSION
 
@@ -36,7 +36,7 @@ ArrayBIGINT: TypeAlias = NDArray[np.int64]
 
 
 @enum.unique
-class RECTypes(enum.StrEnum):
+class RECForm(enum.StrEnum):
     """Recapture rate - derivation methods."""
 
     INOUT = "inside-out"

{mergeron-2024.739104.1 → mergeron-2024.739105.2}/src/mergeron/core/guidelines_boundaries.py

@@ -13,7 +13,7 @@ import numpy as np
 from attrs import Attribute, field, frozen, validators
 from mpmath import mp, mpf  # type: ignore
 
-from .. import VERSION, ArrayDouble, RECTypes, UPPAggrSelector  # noqa: TID252
+from .. import VERSION, ArrayDouble, RECForm, UPPAggrSelector  # noqa: TID252
 from . import guidelines_boundary_functions as gbfn
 
 __version__ = VERSION
@@ -223,14 +223,14 @@ def _divr_value_validator(
 
 def _rec_spec_validator(
     _instance: DiversionRatioBoundary,
-    _attribute: Attribute[RECTypes],
-    _value: RECTypes,
+    _attribute: Attribute[RECForm],
+    _value: RECForm,
     /,
 ) -> None:
-    if _value == RECTypes.OUTIN and _instance.recapture_rate:
+    if _value == RECForm.OUTIN and _instance.recapture_rate:
         raise ValueError(
             f"Invalid recapture specification, {_value!r}. "
-            "You may consider specifying `mergeron.RECTypes.INOUT` here, and "
+            "You may consider specifying `mergeron.RECForm.INOUT` here, and "
             'assigning the default recapture rate as attribute, "recapture_rate" of '
             "this `DiversionRatioBoundarySpec` object."
         )
@@ -265,24 +265,24 @@ class DiversionRatioBoundary:
         kw_only=False, default=0.85, validator=validators.instance_of(float)
     )
 
-    recapture_form: RECTypes | None = field(
+    recapture_form: RECForm | None = field(
         kw_only=True,
-        default=RECTypes.INOUT,
+        default=RECForm.INOUT,
         validator=(
-            validators.instance_of((type(None), RECTypes)),
+            validators.instance_of((type(None), RECForm)),
             _rec_spec_validator,
         ),
     )
     """
     The form of the recapture rate.
 
-    When :attr:`mergeron.RECTypes.INOUT`, the recapture rate for
+    When :attr:`mergeron.RECForm.INOUT`, the recapture rate for
     he product having the smaller market-share is assumed to equal the default,
     and the recapture rate for the product with the larger market-share is
     computed assuming MNL demand. Fixed recapture rates are specified as
-    :attr:`mergeron.RECTypes.FIXED`. (To specify that recapture rates be
+    :attr:`mergeron.RECForm.FIXED`. (To specify that recapture rates be
     constructed from the generated purchase-probabilities for products in
-    the market and for the outside good, specify :attr:`mergeron.RECTypes.OUTIN`.)
+    the market and for the outside good, specify :attr:`mergeron.RECForm.OUTIN`.)
 
     The GUPPI boundary is a continuum of diversion ratio boundaries conditional on
     price-cost margins, :math:`d_{ij} = g_i * p_i / (m_j * p_j)`,

{mergeron-2024.739104.1 → mergeron-2024.739105.2}/src/mergeron/gen/__init__.py

@@ -21,7 +21,7 @@ from .. import (  # noqa: TID252
     ArrayDouble,
     ArrayFloat,
     ArrayINT,
-    RECTypes,
+    RECForm,
     UPPAggrSelector,
 )
 from ..core.pseudorandom_numbers import DIST_PARMS_DEFAULT  # noqa: TID252
@@ -57,7 +57,7 @@ class PriceSpec(tuple[bool, str | None], enum.ReprEnum):
 
 
 @enum.unique
-class SHRDistributions(enum.StrEnum):
+class SHRDistribution(enum.StrEnum):
     """Market share distributions."""
 
     UNI = "Uniform"
@@ -98,26 +98,26 @@ class ShareSpec:
     A key feature of market-share specification in this package is that
     the draws represent markets with multiple different firm-counts.
     Firm-counts are unspecified if the share distribution is
-    :attr:`mergeron.SHRDistributions.UNI`, for Dirichlet-distributed market-shares,
+    :attr:`mergeron.SHRDistribution.UNI`, for Dirichlet-distributed market-shares,
     the default specification is that firm-counts  vary between
     2 and 7 firms with each value equally likely.
 
     Notes
     -----
-    If :attr:`mergeron.gen.ShareSpec.dist_type`:code:` == `:attr:`mergeron.gen.SHRDistributions.UNI`,
+    If :attr:`mergeron.gen.ShareSpec.dist_type`:code:` == `:attr:`mergeron.gen.SHRDistribution.UNI`,
     then it is infeasible that
-    :attr:`mergeron.gen.ShareSpec.recapture_form`:code:` == `:attr:`mergeron.RECTypes.OUTIN`.
+    :attr:`mergeron.gen.ShareSpec.recapture_form`:code:` == `:attr:`mergeron.RECForm.OUTIN`.
     In other words, if firm-counts are unspecified, the recapture rate cannot be
     estimated using outside good choice probabilities.
 
     For a sample with explicit firm counts, market shares must
     be specified as having a supported Dirichlet distribution
-    (see :class:`mergeron.gen.SHRDistributions`).
+    (see :class:`mergeron.gen.SHRDistribution`).
 
     """
 
-    dist_type: SHRDistributions
-    """See :class:`SHRDistributions`"""
+    dist_type: SHRDistribution
+    """See :class:`SHRDistribution`"""
 
     dist_parms: ArrayDouble | None = field(
         default=None, eq=cmp_using(eq=np.array_equal)
@@ -143,22 +143,22 @@ class ShareSpec:
 
     @firm_counts_weights.validator
     def _check_fcw(_i: ShareSpec, _a: Attribute[ArrayDouble], _v: ArrayDouble) -> None:
-        if _v is not None and _i.dist_type == SHRDistributions.UNI:
+        if _v is not None and _i.dist_type == SHRDistribution.UNI:
             raise ValueError(
                 "Generated data for markets with specified firm-counts or "
                 "varying firm counts are not feasible for market shares "
                 "with Uniform distribution. Consider revising the "
-                r"distribution type to {SHRDistributions.DIR_FLAT}, which gives "
+                r"distribution type to {SHRDistribution.DIR_FLAT}, which gives "
                 "uniformly distributed draws on the :math:`n+1` simplex "
                 "for firm-count, :math:`n`."
             )
 
-    recapture_form: RECTypes = field(default=RECTypes.INOUT)
-    """See :class:`mergeron.RECTypes`"""
+    recapture_form: RECForm = field(default=RECForm.INOUT)
+    """See :class:`mergeron.RECForm`"""
 
     @recapture_form.validator
-    def _check_rf(_i: ShareSpec, _a: Attribute[RECTypes], _v: RECTypes) -> None:
-        if _v == RECTypes.OUTIN and _i.dist_type == SHRDistributions.UNI:
+    def _check_rf(_i: ShareSpec, _a: Attribute[RECForm], _v: RECForm) -> None:
+        if _v == RECForm.OUTIN and _i.dist_type == SHRDistribution.UNI:
             raise ValueError(
                 "Market share specification requires estimation of recapture rate from "
                 "generated data. Either delete recapture rate specification or set it to None."
@@ -168,7 +168,7 @@ class ShareSpec:
     """A value between 0 and 1, typically 0.8.
 
     :code:`None` if market share specification requires direct generation of
-    outside good choice probabilities (:attr:`mergeron.RECTypes.OUTIN`).
+    outside good choice probabilities (:attr:`mergeron.RECForm.OUTIN`).
 
     The recapture rate is usually calibrated to the numbers-equivalent of the
     HHI threshold for the presumtion of harm from unilateral competitive effects
@@ -191,7 +191,7 @@ class ShareSpec:
     def _check_rr(_i: ShareSpec, _a: Attribute[float], _v: float) -> None:
         if _v and not (0 < _v <= 1):
             raise ValueError("Recapture rate must lie in the interval, [0, 1).")
-        elif _v is None and _i.recapture_form != RECTypes.OUTIN:
+        elif _v is None and _i.recapture_form != RECForm.OUTIN:
             raise ValueError(
                 f"Recapture specification, {_i.recapture_form!r} requires that "
                 "the market sample specification inclues a recapture rate in the "
@@ -200,7 +200,7 @@ class ShareSpec:
 
 
 @enum.unique
-class PCMDistributions(enum.StrEnum):
+class PCMDistribution(enum.StrEnum):
     """Margin distributions."""
 
     UNI = "Uniform"
@@ -210,7 +210,7 @@ class PCMDistributions(enum.StrEnum):
 
 
 @enum.unique
-class FM2Constants(enum.StrEnum):
+class FM2Constraint(enum.StrEnum):
     """Firm 2 margins - derivation methods."""
 
     IID = "i.i.d"
@@ -234,8 +234,8 @@ class PCMSpec:
 
     """
 
-    dist_type: PCMDistributions = field(kw_only=False, default=PCMDistributions.UNI)
-    """See :class:`PCMDistributions`"""
+    dist_type: PCMDistribution = field(kw_only=False, default=PCMDistribution.UNI)
+    """See :class:`PCMDistribution`"""
 
     dist_parms: ArrayDouble | None = field(kw_only=False, default=None)
     """Parameter specification for tailoring PCM distribution
@@ -260,9 +260,9 @@ class PCMSpec:
                     "are not valid with margin distribution, {_dist_type_pcm!r}"
                 )
             elif (
-                _i.dist_type == PCMDistributions.BETA and len(_v) != len(("a", "b"))
+                _i.dist_type == PCMDistribution.BETA and len(_v) != len(("a", "b"))
             ) or (
-                _i.dist_type == PCMDistributions.BETA_BND
+                _i.dist_type == PCMDistribution.BETA_BND
                 and len(_v) != len(("mu", "sigma", "max", "min"))
             ):
                 raise ValueError(
@@ -270,18 +270,18 @@ class PCMSpec:
                     f'for PCM with distribution, "{_i.dist_type}" is incorrect.'
                 )
 
-        elif _i.dist_type == PCMDistributions.EMPR and _v is not None:
+        elif _i.dist_type == PCMDistribution.EMPR and _v is not None:
             raise ValueError(
                 f"Empirical distribution does not require additional parameters; "
                 f'"given value, {_v!r} is ignored."'
             )
 
-    firm2_pcm_constraint: FM2Constants = field(kw_only=False, default=FM2Constants.IID)
-    """See :class:`FM2Constants`"""
+    firm2_pcm_constraint: FM2Constraint = field(kw_only=False, default=FM2Constraint.IID)
+    """See :class:`FM2Constraint`"""
 
 
 @enum.unique
-class SSZConstants(float, enum.ReprEnum):
+class SSZConstant(float, enum.ReprEnum):
     """
     Scale factors to offset sample size reduction.
 

{mergeron-2024.739104.1 → mergeron-2024.739105.2}/src/mergeron/gen/data_generation.py

@@ -13,18 +13,18 @@ from attrs import Attribute, define, field, validators
 from joblib import Parallel, cpu_count, delayed  # type: ignore
 from numpy.random import SeedSequence
 
-from .. import VERSION, RECTypes  # noqa: TID252  # noqa
+from .. import VERSION, RECForm  # noqa: TID252  # noqa
 from ..core import guidelines_boundaries as gbl  # noqa: TID252
 from ..core.guidelines_boundaries import HMGThresholds  # noqa: TID252
 from . import (
-    FM2Constants,
+    FM2Constraint,
     MarketDataSample,
-    PCMDistributions,
+    PCMDistribution,
     PCMSpec,
     PriceSpec,
     ShareSpec,
-    SHRDistributions,
-    SSZConstants,
+    SHRDistribution,
+    SSZConstant,
     UPPTestRegime,
     UPPTestsCounts,
 )
@@ -40,7 +40,7 @@ __version__ = VERSION
 
 
 class SamplingFunctionKWArgs(TypedDict, total=False):
-    "Keyword arguments of function, :func:`MarketSample.sim_enf_cnts`"
+    "Keyword arguments of sampling methods defined below"
 
     sample_size: int
     """number of draws to generate"""
@@ -73,26 +73,26 @@ class MarketSample:
 
     share_spec: ShareSpec = field(
         kw_only=True,
-        default=ShareSpec(SHRDistributions.UNI, None, None, RECTypes.INOUT, 0.8),
+        default=ShareSpec(SHRDistribution.UNI, None, None, RECForm.INOUT, 0.8),
         validator=validators.instance_of(ShareSpec),
     )
     """Market-share specification, see :class:`ShareSpec`"""
 
     pcm_spec: PCMSpec = field(
-        kw_only=True, default=PCMSpec(PCMDistributions.UNI, None, FM2Constants.IID)
+        kw_only=True, default=PCMSpec(PCMDistribution.UNI, None, FM2Constraint.IID)
     )
     """Margin specification, see :class:`PCMSpec`"""
 
     @pcm_spec.validator
     def _check_pcm(self, _a: Attribute[PCMSpec], _v: PCMSpec, /) -> None:
         if (
-            self.share_spec.recapture_form == RECTypes.FIXED
-            and _v.firm2_pcm_constraint == FM2Constants.MNL
+            self.share_spec.recapture_form == RECForm.FIXED
+            and _v.firm2_pcm_constraint == FM2Constraint.MNL
         ):
             raise ValueError(
                 f'Specification of "recapture_form", "{self.share_spec.recapture_form}" '
                 "requires Firm 2 margin must have property, "
-                f'"{FM2Constants.IID}" or "{FM2Constants.SYM}".'
+                f'"{FM2Constraint.IID}" or "{FM2Constraint.SYM}".'
             )
 
     price_spec: PriceSpec = field(
@@ -100,12 +100,12 @@ class MarketSample:
     )
     """Price specification, see :class:`PriceSpec`"""
 
-    hsr_filing_test_type: SSZConstants = field(
+    hsr_filing_test_type: SSZConstant = field(
         kw_only=True,
-        default=SSZConstants.ONE,
-        validator=validators.instance_of(SSZConstants),
+        default=SSZConstant.ONE,
+        validator=validators.instance_of(SSZConstant),
     )
-    """Method for modeling HSR filing threholds, see :class:`SSZConstants`"""
+    """Method for modeling HSR filing threholds, see :class:`SSZConstant`"""
 
     data: MarketDataSample = field(default=None)
 
@@ -124,7 +124,7 @@ class MarketSample:
         """
         Generate share, diversion ratio, price, and margin data for MarketSpec.
 
-        see :attr:`SamplingFunctionKWArgs` for description of parameters
+        see :attr:`SamplingFunctionKWArgs` for description of keyord parameters
 
         Returns
         -------
@@ -149,8 +149,8 @@ class MarketSample:
         _shr_sample_size = 1.0 * sample_size
         # Scale up sample size to offset discards based on specified criteria
         _shr_sample_size *= _hsr_filing_test_type
-        if _dist_firm2_pcm == FM2Constants.MNL:
-            _shr_sample_size *= SSZConstants.MNL_DEP
+        if _dist_firm2_pcm == FM2Constraint.MNL:
+            _shr_sample_size *= SSZConstant.MNL_DEP
         _shr_sample_size = int(_shr_sample_size)
 
         # Generate share data
@@ -195,7 +195,7 @@ class MarketSample:
 
         _mnl_test_rows = _mnl_test_rows * _hsr_filing_test
         _s_size = sample_size  # originally-specified sample size
-        if _dist_firm2_pcm == FM2Constants.MNL:
+        if _dist_firm2_pcm == FM2Constraint.MNL:
             _mktshr_array = _mktshr_array[_mnl_test_rows][:_s_size]
             _pcm_array = _pcm_array[_mnl_test_rows][:_s_size]
             _price_array = _price_array[_mnl_test_rows][:_s_size]
@@ -240,13 +240,21 @@ class MarketSample:
         self,
         /,
         *,
-        sample_size: int = 10**6,
-        seed_seq_list: list[SeedSequence] | None,
+        sample_size: int,
+        seed_seq_list: Sequence[SeedSequence],
         nthreads: int,
-        save_data_to_file: SaveData = False,
-        saved_array_name_suffix: str = "",
+        save_data_to_file: SaveData,
+        saved_array_name_suffix: str,
     ) -> None:
-        """Generate market data"""
+        """Populate :attr:`data` with generated data
+
+        see :attr:`SamplingFunctionKWArgs` for description of keyord parameters
+
+        Returns
+        -------
+        None
+
+        """
 
         self.data = self.gen_market_sample(
             sample_size=sample_size, seed_seq_list=seed_seq_list, nthreads=nthreads
@@ -389,7 +397,8 @@ class MarketSample:
 
         Returns
         -------
-            Arrays of UPPTestCounts
+            Arrays of enforcement counts or clearance counts by firm count,
+            ΔHHI and concentration zone
 
         """
         _sample_sz = sample_size
@@ -400,7 +409,7 @@ class MarketSample:
         _thread_count = cpu_count()
 
         if (
-            self.share_spec.recapture_form != RECTypes.OUTIN
+            self.share_spec.recapture_form != RECForm.OUTIN
             and self.share_spec.recapture_rate != _enf_parm_vec.rec
         ):
             raise ValueError(
@@ -458,12 +467,12 @@ class MarketSample:
         /,
         *,
         sample_size: int = 10**6,
-        seed_seq_list: list[SeedSequence] | None,
-        nthreads: int,
+        seed_seq_list: Sequence[SeedSequence] | None = None,
+        nthreads: int = 16,
         save_data_to_file: SaveData = False,
         saved_array_name_suffix: str = "",
     ) -> None:
-        """Estimate enforcement counts
+        """Populate :attr:`enf_counts` etimated test counts.
 
         Parameters
         ----------
@@ -478,16 +487,16 @@ class MarketSample:
             merging firms
 
         sample_size
-            Size of the market sample drawn
+            Number of draws to simulate
 
         seed_seq_list
-            List of :code:`numpy.random.SeedSequence` objects
+            List of seed sequences, to assure independent samples in each thread
 
         nthreads
-            Number of threads to use
+            Number of parallel processes to use
 
         save_data_to_file
-            Save data to given HDF5 file, at specified group node
+            Whether to save data to an HDF5 file, and where to save it
 
         saved_array_name_suffix
             Suffix to add to the array names in the HDF5 file