mergeron 2024.739089.2__py3-none-any.whl → 2024.739091.2__py3-none-any.whl

mergeron/__init__.py

@@ -11,7 +11,7 @@ from numpy.typing import NDArray
 
 _PKG_NAME: str = Path(__file__).parent.stem
 
-VERSION = "2024.739089.2"
+VERSION = "2024.739091.2"
 
 __version__ = VERSION
 

mergeron/ext/xlsxw_helper.py

@@ -7,15 +7,15 @@ Includes a flexible system of defining cell formats.
 NOTES
 -----
 
-This module is desinged for producing formatted summary output. For
+This module is designed for producing formatted summary output. For
 writing bulk data to Excel, facilities provided in third-party packages
-such as `polars` likely provide better performance.
+such as `polars <https://pola.rs/>`_ likely provide better performance.
 
 """
 
 from __future__ import annotations
 
-from collections.abc import Mapping, Sequence
+from collections.abc import Sequence
 from typing import Any, ClassVar, Literal, TypeAlias, TypedDict
 
 import numpy as np
@@ -29,7 +29,7 @@ __version__ = VERSION
 
 Workbook = xlsxwriter.Workbook
 
-xl_border_type: TypeAlias = Literal[
+XLBorderType: TypeAlias = Literal[
     "none",
     "thin",
     "medium",
@@ -66,13 +66,12 @@ xl_border_type: TypeAlias = Literal[
 class CFmtVal(TypedDict, total=False):
     """Keys for xlsxwriter Format objects.
 
-    This is a partial list based on formats defined below.
+    This is a partial list based on formats of interest.
     """
 
     font_name: str
     font_size: int
     font_color: str
-    bg_color: str  # html color string, no #
     align: Literal[
         "left", "center", "right", "center_across", "top", "bottom", "vcenter"
     ]
@@ -100,93 +99,106 @@ class CFmtVal(TypedDict, total=False):
     num_format: str
 
     pattern: int
+    fg_color: str  # html color string, no #
+    bg_color: str  # html color string, no #
 
-    border: xl_border_type
-    bottom: xl_border_type
-    left: xl_border_type
-    right: xl_border_type
-    top: xl_border_type
+    hidden: bool
+    locked: bool
+
+    border: XLBorderType
+    bottom: XLBorderType
+    left: XLBorderType
+    right: XLBorderType
+    top: XLBorderType
+    border_color: str  # html color string, no #
     bottom_color: str  # html color string, no #
     left_color: str  # html color string, no #
     right_color: str  # html color string, no #
     top_color: str  # html color string, no #
 
+    diag_border: XLBorderType
+    diag_border_color: str  # html color string, no #
+    diag_type: Literal[
+        1, 2, 3, "up", "down", "left", "right", "cross", "diagonalUp", "diagonalDown"
+    ]
+
 
 @unique
 class CFmt(dict, Enum):  # type: ignore
     """
-    Initialize cell formats for xlsxwriter.
+    Cell format enums for xlsxwriter Format objects.
 
-    The mappings included here, and unions, etc. of them
-    and any others added at runtime, are rendered
-    as xlsxWriter.Workbook.Format objects for writing
-    cell values to formatted cells in a spreadsheet.
+    The enums defined here, or sequences of (any of) them
+    and any added with :meth:`CFmt.add_new`, are
+    rendered as :code:`xlsxWriter.Workbook.Format` objects
+    with :meth:`CFmt.xl_fmt`.
 
     NOTES
     -----
 
-    For more information about xlsxwriter's cell formats,
+    For more information about xlsxwriter cell formats,
     see, https://xlsxwriter.readthedocs.io/format.html
 
     """
 
-    XL_DEFAULT: ClassVar[CFmtVal] = {"font_name": "Calibri", "font_size": 11}
-    XL_DEFAULT_2003: ClassVar[CFmtVal] = {"font_name": "Arial", "font_size": 10}
-
-    A_CTR: ClassVar[CFmtVal] = {"align": "center"}
-    A_CTR_ACROSS: ClassVar[CFmtVal] = {"align": "center_across"}
-    A_LEFT: ClassVar[CFmtVal] = {"align": "left"}
-    A_RIGHT: ClassVar[CFmtVal] = {"align": "right"}
-    V_TOP: ClassVar[CFmtVal] = {"align": "top"}
-    V_BOTTOM: ClassVar[CFmtVal] = {"align": "bottom"}
-    V_CTR: ClassVar[CFmtVal] = {"align": "vcenter"}
-
-    TEXT_WRAP: ClassVar[CFmtVal] = {"text_wrap": True}
-    TEXT_ROTATE: ClassVar[CFmtVal] = {"rotation": 90}
-    IND_1: ClassVar[CFmtVal] = {"indent": 1}
-
-    BOLD: ClassVar[CFmtVal] = {"bold": True}
-    BOLD_ITALIC: ClassVar[CFmtVal] = {"bold": True, "italic": True}
-    ITALIC: ClassVar[CFmtVal] = {"italic": True}
-    ULINE: ClassVar[CFmtVal] = {"underline": "single"}
-    SOUT: ClassVar[CFmtVal] = {"font_strikeout": True}
+    XL_DEFAULT: ClassVar = {"font_name": "Calibri", "font_size": 11}
+    XL_DEFAULT_2003: ClassVar = {"font_name": "Arial", "font_size": 10}
+
+    A_CTR: ClassVar = {"align": "center"}
+    A_CTR_ACROSS: ClassVar = {"align": "center_across"}
+    A_LEFT: ClassVar = {"align": "left"}
+    A_RIGHT: ClassVar = {"align": "right"}
+    V_TOP: ClassVar = {"align": "top"}
+    V_BOTTOM: ClassVar = {"align": "bottom"}
+    V_CTR: ClassVar = {"align": "vcenter"}
+
+    TEXT_WRAP: ClassVar = {"text_wrap": True}
+    TEXT_ROTATE: ClassVar = {"rotation": 90}
+    IND_1: ClassVar = {"indent": 1}
+
+    BOLD: ClassVar = {"bold": True}
+    BOLD_ITALIC: ClassVar = {"bold": True, "italic": True}
+    ITALIC: ClassVar = {"italic": True}
+    ULINE: ClassVar = {"underline": "single"}
+    SOUT: ClassVar = {"font_strikeout": True}
     # Useful with write_rich_text()
-    SUPERSCRIPT: ClassVar[CFmtVal] = {"font_script": 1}
-    SUBSCRIPT: ClassVar[CFmtVal] = {"font_script": 2}
-
-    AREA_NUM: ClassVar[CFmtVal] = {"num_format": "0.00000000"}
-    DOLLAR_NUM: ClassVar[CFmtVal] = {"num_format": "[$$-409]#,##0.00"}
-    DT_NUM: ClassVar[CFmtVal] = {"num_format": "mm/dd/yyyy"}
-    PCT_NUM: ClassVar[CFmtVal] = {"num_format": "##0%"}
-    PCT2_NUM: ClassVar[CFmtVal] = {"num_format": "##0.00%"}
-    PCT4_NUM: ClassVar[CFmtVal] = {"num_format": "##0.0000%"}
-    PCT6_NUM: ClassVar[CFmtVal] = {"num_format": "##0.000000%"}
-    PCT8_NUM: ClassVar[CFmtVal] = {"num_format": "##0.00000000%"}
-    QTY_NUM: ClassVar[CFmtVal] = {"num_format": "#,##0.0"}
-
-    BAR_FILL: ClassVar[CFmtVal] = {"pattern": 1, "bg_color": "dfeadf"}
-    HDR_FILL: ClassVar[CFmtVal] = {"pattern": 1, "bg_color": "bfbfbf"}
-
-    LEFT_BORDER: ClassVar[CFmtVal] = {"left": 1, "left_color": "000000"}
-    RIGHT_BORDER: ClassVar[CFmtVal] = {"right": 1, "right_color": "000000"}
-    BOTTOM_BORDER: ClassVar[CFmtVal] = {"bottom": 1, "bottom_color": "000000"}
-    TOP_BORDER: ClassVar[CFmtVal] = {"top": 1, "top_color": "000000"}
-    HDR_BORDER: ClassVar[CFmtVal] = TOP_BORDER | BOTTOM_BORDER
+    SUPERSCRIPT: ClassVar = {"font_script": 1}
+    SUBSCRIPT: ClassVar = {"font_script": 2}
+
+    AREA_NUM: ClassVar = {"num_format": "0.00000000"}
+    DOLLAR_NUM: ClassVar = {"num_format": "[$$-409]#,##0.00"}
+    DT_NUM: ClassVar = {"num_format": "mm/dd/yyyy"}
+    PCT_NUM: ClassVar = {"num_format": "##0%"}
+    PCT2_NUM: ClassVar = {"num_format": "##0.00%"}
+    PCT4_NUM: ClassVar = {"num_format": "##0.0000%"}
+    PCT6_NUM: ClassVar = {"num_format": "##0.000000%"}
+    PCT8_NUM: ClassVar = {"num_format": "##0.00000000%"}
+    QTY_NUM: ClassVar = {"num_format": "#,##0.0"}
+
+    BAR_FILL: ClassVar = {"pattern": 1, "bg_color": "dfeadf"}
+    HDR_FILL: ClassVar = {"pattern": 1, "bg_color": "bfbfbf"}
+
+    FULL_BORDER: ClassVar = {"border": 1, "border_color": "000000"}
+    BOTTOM_BORDER: ClassVar = {"bottom": 1, "bottom_color": "000000"}
+    LEFT_BORDER: ClassVar = {"left": 1, "left_color": "000000"}
+    RIGHT_BORDER: ClassVar = {"right": 1, "right_color": "000000"}
+    TOP_BORDER: ClassVar = {"top": 1, "top_color": "000000"}
+    HDR_BORDER: ClassVar = TOP_BORDER | BOTTOM_BORDER
 
     @classmethod
     def add_new(self, _fmt_name: str, _xlsx_fmt_dict: CFmtVal, /) -> CFmt:
         """
-        Add new CFmt object to instance.
+        Add new :class:`CFmt` object to instance.
 
         Parameters
         ----------
         _fmt_name
-            Name of new member to be added to CFmt
+            Name of new member to be added to :class:`CFmt`
         _xlsx_fmt_dict
-            Any valid argument to xlsxwriter.Workbook.add_format(), or union of
-            same with one or more CFmt objects with same, e.g.,
-            CFmt.HDR_BORDER | CFmt.HDR_FILL  or
-            CFmt.HDR_BORDER | {"pattern": 1, "bg_color": "f2f2f2"}
+            Any valid argument to :code:`xlsxwriter.Workbook.add_format()`, or union of
+            same with one or more :class:`CFmt` objects, e.g.,
+            :code:`CFmt.HDR_BORDER | CFmt.HDR_FILL`  or
+            :code:`CFmt.HDR_BORDER | {"pattern": 1, "bg_color": "f2f2f2"}`
 
         Returns
         -------
@@ -198,20 +210,21 @@ class CFmt(dict, Enum):  # type: ignore
 
     @classmethod
     def ensure_cell_format_spec_tuple(
-        self, _cell_formats: Sequence[CFmt | Sequence[CFmt]], /
+        self, _cell_format: Sequence[CFmt | Sequence[CFmt]], /
     ) -> bool:
         """
-        Test that a given format specification is a tuple of CFmt enums
+        Test that a given format specification is a tuple of :class:`CFmt` enums
 
         Parameters
         ----------
-        _cell_formats
+        _cell_format
             Format specification
 
         Raises
         ------
         ValueError
-            If format specification is not tuple of CFmt enums
+            If format specification is not a sequence  of (sequences of)
+            :class:`CFmt` enums
 
         Returns
         -------
@@ -219,14 +232,14 @@ class CFmt(dict, Enum):  # type: ignore
 
         """
 
-        for _cell_format in _cell_formats:
-            if isinstance(_cell_format, tuple):
-                self.ensure_cell_format_spec_tuple(_cell_format)
+        for _cf in _cell_format:
+            if isinstance(_cf, tuple):
+                self.ensure_cell_format_spec_tuple(_cf)
 
-            if not (isinstance(_cell_format, CFmt),):
+            if not (isinstance(_cf, CFmt),):
                 raise ValueError(
                     "Improperly specified format tuple for writing array."
-                    "  Must be tuple of CFmt enums."
+                    "  Must be tuple of :class:`CFmt` enums."
                 )
 
         return True
@@ -239,7 +252,7 @@ class CFmt(dict, Enum):  # type: ignore
         /,
     ) -> xlsxwriter.format.Format:
         """
-        Return :code:`xlsxwriter` `Format` object given a CFmt aenum, or tuple thereof.
+        Return :code:`xlsxwriter` :code:`Format` object given a :class:`CFmt` enum, or tuple thereof.
 
         Parameters
         ----------
@@ -247,17 +260,17 @@ class CFmt(dict, Enum):  # type: ignore
             :code:`xlsxwriter.Workbook` object
 
         _cell_fmt
-            :code:`CFmt` aenum object, or tuple thereof
+            :class:`CFmt` enum object, or tuple thereof
 
         Raises
         ------
         ValueError
-            If format specification is not one of None, a CFmt aenum, or
-            a xlsxwriter.format.Format object
+            If format specification is not one of None, a :class:`CFmt` enum, or
+            a :code:`xlsxwriter.format.Format` object
 
         Returns
         -------
-            :code:`xlsxwriter` `Format`  object
+            :code:`xlsxwriter` :code:`Format`  object
 
         """
 
@@ -266,7 +279,7 @@ class CFmt(dict, Enum):  # type: ignore
         elif _cell_fmt is None:
             return _xl_book.add_format(CFmt.XL_DEFAULT.value)
 
-        _cell_fmt_dict: Mapping[str, Any] = {}
+        _cell_fmt_dict: CFmtVal = {}
         if isinstance(_cell_fmt, Sequence):
             self.ensure_cell_format_spec_tuple(_cell_fmt)
             for _cf in _cell_fmt:
@@ -387,7 +400,11 @@ def array_to_sheet(
     Write a 2-D array to a worksheet.
 
     The given array is required be a two-dimensional array, whether
-    a nested list, nested tuple, or a 2-D numpy ndarray.
+    a nested list, nested tuple, or a 2-D numpy ndarray. The array is assumed
+    to be ragged by default, i.e. not all rows are the same length, and some
+    cells may contain lists, etc. For rectangular arrays, set `ragged_flag` to
+    false if you wish to provide a format tuple with distinct formats for each
+    column in the rectangular array.
 
 
     Parameters
@@ -430,7 +447,8 @@ def array_to_sheet(
         If array is not rectangular and cell_format is a Sequence
 
     ValueError
-        If array is rectangular format tuple does not match data in length
+        If array is rectangular but length of format tuple does not
+        match row-length
 
 
     Returns
@@ -441,12 +459,12 @@ def array_to_sheet(
     Notes
     -----
 
-    The keyword argument cell_format may be passed a tuple of CFmt enums,
+    The keyword argument cell_format may be passed a tuple of :class:`CFmt` enums,
     if, and only if, ragged_flag is False. If cell_format is a tuple, it must
-    have length equal to the number of cells in the range to be written. Further,
-    members of cell_format must each be a CFmt enum or a tuple of CFmt enums; in
-    other words, `CFmt.ensure_cell_format_spec_tuple(_c)` must return True for
-    any tuple `_c` passed as `cell_format`.
+    have length equal to the number of cells in each row of the passed array.
+    Further, members of cell_format must each be a :class:`CFmt` enum or a
+    tuple of :class:`CFmt` enums; in other words, :meth:`CFmt.ensure_cell_format_spec_tuple`
+    must return True for any tuple `_c` passed as `cell_format`.
 
     """
 
@@ -540,11 +558,11 @@ def scalar_to_sheet(
 
     _cell_addr_0
         First element of a cell address, which may be the entire address
-        in 'A1' format or the row-part in 'R1,C1' format
+        in 'A1' format or the row-part in 'Row-column' format
 
     _s2s_args
         Other arguments, which may be just the cell value to be written and the
-        cell format, or the column-part of the 'R1,C1' address along with
+        cell format, or the column-part of the 'Row-column' address along with
         cell value and cell format.
 
     Raises
@@ -558,6 +576,11 @@ def scalar_to_sheet(
     -------
         None
 
+    Notes
+    -----
+    For more information on xlsxwriter cell-address notation, see:
+    https://xlsxwriter.readthedocs.io/working_with_cell_notation.html
+
     """
 
     _cell_addr: tuple[int | str, ...] = ()

mergeron/gen/__init__.py

@@ -111,7 +111,7 @@ class ShareSpec:
     """
 
     dist_type: SHRConstants
-    """See :class:`mergeron.gen.SHRConstants`"""
+    """See :class:`SHRConstants`"""
 
     dist_parms: NDArray[np.float64] | None = field(
         default=None, eq=cmp_using(eq=np.array_equal)
@@ -144,7 +144,7 @@ class PCMConstants(enum.StrEnum):
     UNI = "Uniform"
     BETA = "Beta"
     BETA_BND = "Bounded Beta"
-    EMPR = "Damodaran margin data"
+    EMPR = "Damodaran margin data, resampled"
 
 
 @enum.unique
@@ -173,10 +173,10 @@ class PCMSpec:
     """
 
     firm2_pcm_constraint: FM2Constants
-    """See :class:`mergeron.gen.FM2Constants`"""
+    """See :class:`FM2Constants`"""
 
     dist_type: PCMConstants
-    """See :class:`mergeron.gen.PCMConstants`"""
+    """See :class:`PCMConstants`"""
 
     dist_parms: NDArray[np.float64] | None
     """Parameter specification for tailoring PCM distribution
@@ -313,55 +313,28 @@ class MarketSpec:
         default=ShareSpec(RECConstants.INOUT, 0.85, SHRConstants.UNI, None, None),
         validator=[validators.instance_of(ShareSpec), _share_spec_validator],
     )
-    """Market-share specification, see :class:`mergeron.gen.ShareSpec`"""
+    """Market-share specification, see :class:`ShareSpec`"""
 
     pcm_spec: PCMSpec = field(
         kw_only=True,
         default=PCMSpec(FM2Constants.IID, PCMConstants.UNI, None),
         validator=[validators.instance_of(PCMSpec), _pcm_spec_validator],
     )
-    """Margin specification, see :class:`mergeron.gen.PCMSpec`"""
+    """Margin specification, see :class:`PCMSpec`"""
 
     price_spec: PriceConstants = field(
         kw_only=True,
         default=PriceConstants.SYM,
         validator=validators.instance_of(PriceConstants),
     )
-    """Price specification, see :class:`mergeron.gen.PriceConstants`"""
+    """Price specification, see :class:`PriceConstants`"""
 
     hsr_filing_test_type: SSZConstants = field(
         kw_only=True,
         default=SSZConstants.ONE,
         validator=validators.instance_of(SSZConstants),
     )
-    """Method for modeling HSR filing threholds, see :class:`mergeron.gen.SSZConstants`"""
-
-
-@enum.unique
-class INVResolution(enum.StrEnum):
-    CLRN = "clearance"
-    ENFT = "enforcement"
-    BOTH = "both"
-
-
-@frozen
-class UPPTestRegime:
-    resolution: INVResolution = field(
-        default=INVResolution.ENFT, validator=validators.instance_of(INVResolution)
-    )
-    guppi_aggregator: UPPAggrSelector = field(
-        default=UPPAggrSelector.MIN, validator=validators.instance_of(UPPAggrSelector)
-    )
-    divr_aggregator: UPPAggrSelector | None = field(
-        default=None, validator=validators.instance_of((UPPAggrSelector, type(None)))
-    )
-
-
-# https://stackoverflow.com/questions/54668000
-class DataclassInstance(Protocol):
-    """Generic dataclass-instance"""
-
-    __dataclass_fields__: ClassVar
+    """Method for modeling HSR filing threholds, see :class:`SSZConstants`"""
 
 
 @dataclass(slots=True, frozen=True)
@@ -457,6 +430,26 @@ class MarginDataSample:
     """
 
 
+@enum.unique
+class INVResolution(enum.StrEnum):
+    CLRN = "clearance"
+    ENFT = "enforcement"
+    BOTH = "both"
+
+
+@frozen
+class UPPTestRegime:
+    resolution: INVResolution = field(
+        default=INVResolution.ENFT, validator=validators.instance_of(INVResolution)
+    )
+    guppi_aggregator: UPPAggrSelector = field(
+        default=UPPAggrSelector.MIN, validator=validators.instance_of(UPPAggrSelector)
+    )
+    divr_aggregator: UPPAggrSelector | None = field(
+        default=None, validator=validators.instance_of((UPPAggrSelector, type(None)))
+    )
+
+
 @dataclass(slots=True, frozen=True)
 class UPPTestsRaw:
     """Container for arrays marking test failures and successes
@@ -494,3 +487,10 @@ class UPPTestsCounts:
     by_conczone: NDArray[np.int64]
     """Zones are "unoncentrated", "moderately concentrated", and "highly concentrated"
     """
+
+
+# https://stackoverflow.com/questions/54668000
+class DataclassInstance(Protocol):
+    """Generic dataclass-instance"""
+
+    __dataclass_fields__: ClassVar

mergeron/gen/enforcement_stats.py

@@ -188,7 +188,7 @@ ZONE_STRINGS = {
     0: R"Green Zone (Safeharbor)",
     1: R"Yellow Zone",
     2: R"Red Zone (SLC Presumption)",
-    fid.TTL_KEY: R"\node[align = left, fill=OBSHDRFill] {TOTAL};",
+    fid.TTL_KEY: "TOTAL",
 }
 ZONE_DETAIL_STRINGS_HHI = {
     0: Rf"HHI < {HHI_POST_ZONE_KNOTS[1]} pts.",
@@ -213,7 +213,9 @@ ZONE_STRINGS_LATEX = {
 
 ZONE_DETAIL_STRINGS_HHI_LATEX = {
     0: Rf"HHI_{{post}} < \text{{{HHI_POST_ZONE_KNOTS[1]} pts.}}",
-    1: R"HHI_{{post}} ∈ \text{{[{}, {}) pts. and }} ".format(*HHI_POST_ZONE_KNOTS[1:3]),
+    1: R"HHI_{{post}} \in \text{{[{}, {}) pts. and }} ".format(
+        *HHI_POST_ZONE_KNOTS[1:3]
+    ),
     2: Rf"HHI_{{post}} \geqslant \text{{{HHI_POST_ZONE_KNOTS[2]} pts. and }} ",
 }
 
@@ -249,9 +251,9 @@ def enf_stats_output(
         case StatsGrpSelector.ZN:
             _enf_stats_table_func = enf_stats_table_byzone
         case StatsGrpSelector.FC:
-            _enf_stats_table_func = enf_stats_table_1dim
+            _enf_stats_table_func = enf_stats_table_onedim
         case StatsGrpSelector.DL:
-            _enf_stats_table_func = enf_stats_table_1dim
+            _enf_stats_table_func = enf_stats_table_onedim
         case _:
             raise ValueError(
                 'Statistics formatted, "{_stats_group}" not available here.'
@@ -510,7 +512,7 @@ def enf_cnts_byconczone(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int64]:
     return _cnts_byconczone[1:]
 
 
-def enf_stats_table_1dim(
+def enf_stats_table_onedim(
     _inparr: NDArray[np.float64 | np.int64],
     _totals_row: int | None = None,
     /,

{mergeron-2024.739089.2.dist-info → mergeron-2024.739091.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergeron
-Version: 2024.739089.2
+Version: 2024.739091.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
@@ -34,6 +34,7 @@ Requires-Dist: msgpack-numpy (>=0.4)
 Requires-Dist: numpy (>=1.26,<2.0)
 Requires-Dist: openpyxl (>=3.1.2)
 Requires-Dist: pendulum (>=3.0.0)
+Requires-Dist: poetry-plugin-export (>=1.8.0,<2.0.0)
 Requires-Dist: requests (>=2.31)
 Requires-Dist: requests-toolbelt (>=1.0.0)
 Requires-Dist: scipy (>=1.12)
@@ -56,13 +57,13 @@ Intrinsic clearance and enforcement rates are distinguished from *observed* clea
 Introduction
 ------------
 
-Classes for specifying concentration standards (`mergeron.core.guidelines_boundaries.ConcentrationBoundary`) and diversion-ratio standards (`mergeron.core.guidelines_boundaries.DiversionRatioBoundary`), with automatic generation of boundary (as an array of share-pairs) and area, are provided in `mergeron.core.guidelines_boundaries`. This module also includes a function for generating plots of concentation and diversion-ratio boundaries, and functions for mapping GUPPI standards to concentration (ΔHHI) standards, and vice-versa.
+Classes for specifying concentration standards (:code:`mergeron.core.guidelines_boundaries.ConcentrationBoundary`) and diversion-ratio standards (:code:`mergeron.core.guidelines_boundaries.DiversionRatioBoundary`), with automatic generation of boundary (as an array of share-pairs) and area, are provided in :code:`mergeron.core.guidelines_boundaries`. This module also includes a function for generating plots of concentation and diversion-ratio boundaries, and functions for mapping GUPPI standards to concentration (ΔHHI) standards, and vice-versa.
 
-Methods for generating industry data under various distributions of shares, margins, and prices are included in, `mergeron.gen.data_generation`. Shares are drawn with uniform distribution with :math:`s_1 + s_2 \leqslant 1` and an unspecified number of firms. Alternatively, shares may be drawn from the Dirichlet distribution. When drawing shares from the Dirichlet distribution, the user can specify a fixed number for firms or provide 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>`_). The user can specify recapture rates as, "proportional", "inside-out" --- i.e., consistent with merging-firms' in-market shares and a default recapture rate) --- or "outside-in" --- i.e., purchase probabilities are 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. Documentation on specifying the sampling strategy for market shares is at `mergeron.gen.ShareSpec`. Price-cost-margins may be specified as symmetric, i.i.d., or subject to equilibrium conditions for (profit-mazimization in) Bertrand-Nash oligopoly with MNL demand (see, `mergeron.gen.PCMSpec`). 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, `mergeron.gen.PriceSpec`). Two alternative approaches for modeling statutory filing requirements (HSR filing thresholds) are implemented (see, `mergeron.gen.SSZConstants`). The full specification of a market sample is given in a `mergeron.gen.market_sample.MarketSample` object. Data are drawn by invoking `mergeron.gen.market_sample.MarketSample.generate_sample` which adds a `data` property of class, `mergeron.gen.MarketDataSample`. Enforcement or clearance counts are computed by invoking `mergeron.gen.market_sample.MarketSample.estimate_invres_counts`, which adds an `invres_counts` property of class `mergeron.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 `estimate_invres_counts` on a `mergeron.gen.market_sample.MarketSample` object without first invoking `generate_sample`. Note, however, that this strategy discards the market sample in the interests of conserving memory and maintaining high performance.
+Methods for generating industry data under various distributions of shares, margins, and prices are included in, :code:`mergeron.gen.data_generation`. Shares are drawn with uniform distribution with :math:`s_1 + s_2 \leqslant 1` and an unspecified number of firms. Alternatively, shares may be drawn from the Dirichlet distribution. When drawing shares from the Dirichlet distribution, the user can specify a fixed number for firms or provide 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>`_). The user can specify recapture rates as, "proportional", "inside-out" --- i.e., consistent with merging-firms' in-market shares and a default recapture rate) --- or "outside-in" --- i.e., purchase probabilities are 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. Documentation on specifying the sampling strategy for market shares is at :code:`mergeron.gen.ShareSpec`. Price-cost-margins may be specified as symmetric, i.i.d., or subject to equilibrium conditions for (profit-mazimization in) Bertrand-Nash oligopoly with MNL demand (see, :code:`mergeron.gen.PCMSpec`). 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:`mergeron.gen.PriceSpec`). Two alternative approaches for modeling statutory filing requirements (HSR filing thresholds) are implemented (see, :code:`mergeron.gen.SSZConstants`). The full specification of a market sample is given in a :code:`mergeron.gen.market_sample.MarketSample` object. Data are drawn by invoking :code:`mergeron.gen.market_sample.MarketSample.generate_sample` which adds a :code:`data` property of class, :code:`mergeron.gen.MarketDataSample`. Enforcement or clearance counts are computed by invoking :code:`mergeron.gen.market_sample.MarketSample.estimate_invres_counts`, which adds an :code:`invres_counts` property of class :code:`mergeron.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:`estimate_invres_counts` on a :code:`mergeron.gen.market_sample.MarketSample` object without first invoking :code:`generate_sample`. Note, however, that this strategy discards the market sample in the interests of conserving memory and maintaining high performance.
 
-Methods for printing 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 `mergeron.gen.enforcement_stats`.
+Methods for printing 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:`mergeron.gen.enforcement_stats`.
 
-Programs demonstrating the analysis and reporting facilites provided by the sub-package, `mergeron.demo`.
+Programs demonstrating the analysis and reporting facilites provided by the sub-package, :code:`mergeron.demo`.
 
 This package exposes methods employed 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. To access these directly:
 
@@ -70,13 +71,13 @@ This package exposes methods employed for generating random numbers with selecte
 
     import mergeron.core.pseudorandom_numbers as prng
 
-Also included are methods for estimating confidence intervals for proportions and for contrasts (differences) in proportions. (Although coded from scratch using the source literature, the APIs implemented in the module included here are designed for consistency with the APIs in, `statsmodels.stats.proportion` from the package, `statsmodels` (https://pypi.org/project/statsmodels/).) To access these directly:
+Also included are methods for estimating confidence intervals for proportions and for contrasts (differences) in proportions. (Although coded from scratch using the source literature, the APIs implemented in the module included here are designed for consistency with the APIs in, :code:`statsmodels.stats.proportion` from the package, :code:`statsmodels` (https://pypi.org/project/statsmodels/).) To access these directly:
 
 .. code-block:: python
 
     import mergeron.core.proportions_tests as prci
 
-A recent version of Paul Tol's python module, `tol_colors.py` is redistributed within this package. Other than re-formatting and type annotation, the `mergeron.ext.tol_colors` module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The `tol_colors.py` module is distributed under the Standard 3-clause BSD license. To access the `mergeron.ext.tol_colors` module directly:
+A recent version of Paul Tol's python module, :code:`tol_colors.py` is redistributed within this package. Other than re-formatting and type annotation, the :code:`mergeron.ext.tol_colors` module is re-distributed as downloaded from, https://personal.sron.nl/~pault/data/tol_colors.py. The :code:`tol_colors.py` module is distributed under the Standard 3-clause BSD license. To access the :code:`mergeron.ext.tol_colors` module directly:
 
 .. code-block:: python
 

{mergeron-2024.739089.2.dist-info → mergeron-2024.739091.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 mergeron/License.txt,sha256=7iX-y0EyjkbVJKJLS4ZKzuuE1wd0lryfsD_IytLG8lQ,1246
-mergeron/__init__.py,sha256=J8TIPolz32U7FX1X1sdb9UiqVbkXM_EJxCRwDZxotpc,1647
+mergeron/__init__.py,sha256=dQe1ZhZ4GP5p0TMy4E_chUcvo-6TpWhft70eWLQCZBY,1647
 mergeron/core/__init__.py,sha256=KtjBlZOl7jwBCAUhrTJB9PdrN39YLYytNiSUSM_gRmA,62
 mergeron/core/damodaran_margin_data.py,sha256=pjI1rSK_O1-3Oel5b9KXH6ctnInjX1Vii7fypt00gV8,8541
 mergeron/core/ftc_merger_investigations_data.py,sha256=ZaV2DO7UZabV8eX0Ubq_ToIor7tIRzcvYC54ADliuTk,27931
@@ -23,14 +23,14 @@ mergeron/demo/__init__.py,sha256=KtjBlZOl7jwBCAUhrTJB9PdrN39YLYytNiSUSM_gRmA,62
 mergeron/demo/visualize_empirical_margin_distribution.py,sha256=v1xFJumBX2Ooye82kSSgly-_GpFVkYSDqBwM__rcmZY,2363
 mergeron/ext/__init__.py,sha256=KtjBlZOl7jwBCAUhrTJB9PdrN39YLYytNiSUSM_gRmA,62
 mergeron/ext/tol_colors.py,sha256=QBw8s-ZGpUpIIYOplHbLFZSXVoa6eDDJDtzSScP954E,22303
-mergeron/ext/xlsxw_helper.py,sha256=QkVjn-v1-kLFZgHKo6fm4L0RAjjOqtQ-ZGNnPtN9bZc,17281
-mergeron/gen/__init__.py,sha256=mlZn8gud6bxP_XKSQY2c-u-C85A8U7VxUKLiXu2hMw0,16280
+mergeron/ext/xlsxw_helper.py,sha256=4wAhwQjWKSm65931sR_4yO6EuoU2RnWvtW5aCSQn5Iw,17951
+mergeron/gen/__init__.py,sha256=pAEirl5FAO9r_6f7BdvqU0LCH9lXMe1YR0SnrGMpCWI,16200
 mergeron/gen/_data_generation_functions.py,sha256=7fP4mSVaN36FBhPKSf1y_TbxfRUe-I7fgqdBt74oaCA,21029
 mergeron/gen/data_generation.py,sha256=gDvCZYJwGpQnokcygM7IRzHBpE5rYI2J5I8uu0_wQyE,8727
-mergeron/gen/enforcement_stats.py,sha256=kpkpMbhqEGQcY2-oUYDj4N2MJ6tvBPSxVpPJne46WxI,24431
+mergeron/gen/enforcement_stats.py,sha256=Hr-w3LZ9SJD4A1RZS1KMhXwuKyGzPC7eeNQullWZRNU,24410
 mergeron/gen/market_sample.py,sha256=ekMA9db2AWvrA-GDbIieu270fovFX0JyynCo5FRAGzk,2270
 mergeron/gen/upp_tests.py,sha256=GQZcXU4vQPJRxdI2DVsY7yX6TPqhntlTH-DOAufWFmM,17197
 mergeron/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-mergeron-2024.739089.2.dist-info/METADATA,sha256=94GaNsInzLR-APqYMs2CGjy7exFdJJa9zDYYWwLODkM,8690
-mergeron-2024.739089.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-mergeron-2024.739089.2.dist-info/RECORD,,
+mergeron-2024.739091.2.dist-info/METADATA,sha256=wK0ioIu_QUYP5PLYeJgBKqM8A1wfIWJOG22beUjM8AI,8899
+mergeron-2024.739091.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+mergeron-2024.739091.2.dist-info/RECORD,,