mergeron 2024.739088.0__tar.gz → 2024.739088.2__tar.gz

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mergeron
-Version: 2024.739088.0
+Version: 2024.739088.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

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/pyproject.toml

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

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/src/mergeron/__init__.py

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

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/src/mergeron/data/jinja2_LaTeX_templates/ftcinvdata_summarypaired_table_template.tex.jinja2

@@ -19,19 +19,19 @@
 		Grouped by Entry Conditions and Reporting Period \\[0.5\baselineskip]}
 	\begin{tikzpicture}[auto, font = \sffamily]
 		\begin{pgfonlayer}{background}
-			\matrix[datatable, nodes = {text width = 27pt,},] (invres_rate_raw) {
+			\matrix[datatable, nodes = {text width = 27pt,},] (enf_rate_raw) {
 				\JINVAR{ tmpl_data.invdata_datstr -}
 				};
 			% Horizontal scoring for totals
-			\draw[color = OBSHDRFill, line width = 1pt] (invres_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-1.north west) -- (invres_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-8.north east);
+			\draw[color = OBSHDRFill, line width = 1pt] (enf_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-1.north west) -- (enf_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-8.north east);
 			% Vertical scoring for column groups
-			\draw[color = OBSHDRFill, line width = 1pt] (invres_rate_raw-1-2.north east) -- (invres_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-2.south east);
-			\draw[color = OBSHDRFill, line width = 1pt] (invres_rate_raw-1-4.north east) -- (invres_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-4.south east);
-			\draw[color = OBSHDRFill, line width = 1pt] (invres_rate_raw-1-6.north east) -- (invres_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-6.south east);
+			\draw[color = OBSHDRFill, line width = 1pt] (enf_rate_raw-1-2.north east) -- (enf_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-2.south east);
+			\draw[color = OBSHDRFill, line width = 1pt] (enf_rate_raw-1-4.north east) -- (enf_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-4.south east);
+			\draw[color = OBSHDRFill, line width = 1pt] (enf_rate_raw-1-6.north east) -- (enf_rate_raw-\JINVAR{- tmpl_data.invdata_numrows -}-6.south east);
 		\end{pgfonlayer}
 
 		\matrix[hrow,
-			above = 0 pt of invres_rate_raw,
+			above = 0 pt of enf_rate_raw,
 			nodes = {minimum height = 33pt, text depth = 10pt, text width = 60pt, align = left, inner sep = 3pt,},
 			] (hdrrow_raw) {
 			\node[rotate = 90] {Relative \\ Frequency \\}; &
@@ -64,12 +64,12 @@
 			Observed Data \\
 			};
 		% Vertical scoring for column groups
-		\draw[color = white, line width = 1pt] (descrow_raw_pds1-1-1.north east) -- (invres_rate_raw-1-2.north east);
-		\draw[color = white, line width = 1pt] (descrow_raw_mkt1-1-1.north east) -- (invres_rate_raw-1-4.north east);
-		\draw[color = white, line width = 1pt] (descrow_raw_pds2-1-1.north east) -- (invres_rate_raw-1-6.north east);
+		\draw[color = white, line width = 1pt] (descrow_raw_pds1-1-1.north east) -- (enf_rate_raw-1-2.north east);
+		\draw[color = white, line width = 1pt] (descrow_raw_mkt1-1-1.north east) -- (enf_rate_raw-1-4.north east);
+		\draw[color = white, line width = 1pt] (descrow_raw_pds2-1-1.north east) -- (enf_rate_raw-1-6.north east);
 
 		% Header column - row heads
-		\matrix[hcol, left = 0pt of invres_rate_raw, nodes = {
+		\matrix[hcol, left = 0pt of enf_rate_raw, nodes = {
 				text width = \JINVAR{ tmpl_data.hdrcol_raw_width -},
 				inner xsep = 3 pt,
 				},] (hdrcol_raw) {
@@ -85,7 +85,7 @@
 		(hdrcoldesc_raw.north east)
 		;
 		((# % Separator for header column
-		\draw[color = white, line width = 1pt] (descrow_raw_mkt1-1-1.north west) -- (invres_rate_raw-1-1.north west); #))
+		\draw[color = white, line width = 1pt] (descrow_raw_mkt1-1-1.north west) -- (enf_rate_raw-1-1.north west); #))
 
 		% Notes below table
 		\matrix[anytable,

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/src/mergeron/ext/tol_colors.py

@@ -37,24 +37,21 @@ def discretemap(colormap: str, hexclrs: Sequence[str]) -> LinearSegmentedColorma
 
 
 class TOLcmaps:
-    """
-    Class TOLcmaps definition.
-
-    Attributes
-    ----------
-    cmap
-        A matploltib colormap
-
-    cname
-        Colormap name
+    def __init__(self) -> None:
+        """
+        Class TOLcmaps definition.
 
-    namelist
-        A list of colormap names
+        Attributes
+        ----------
+        cmap
+            A matploltib colormap
 
-    """
+        cname
+            Colormap name
 
-    def __init__(self) -> None:
-        """ """
+        namelist
+            A list of colormap names
+        """
         # self.cmap: LinearSegmentedColormap | None = None
         self.cname: str = ""
         self.namelist: Sequence[str] = (

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/src/mergeron/ext/xlsxw_helper.py

@@ -83,7 +83,7 @@ class CFmt(dict, Enum):  # type: ignore
     QTY_NUM: ClassVar = {"num_format": "#,##0.0"}
 
     BAR_FILL: ClassVar = {"pattern": 1, "bg_color": "dfeadf"}
-    HDR_FILL: ClassVar = {"pattern": 1, "bg_color": "e9e9e9"}
+    HDR_FILL: ClassVar = {"pattern": 1, "bg_color": "bfbfbf"}
 
     LEFT_BORDER: ClassVar = {"left": 1, "left_color": "000000"}
     RIGHT_BORDER: ClassVar = {"right": 1, "right_color": "000000"}
@@ -275,7 +275,7 @@ def write_footer(
     None
     """
 
-    if not any((center_footer, left_footer, right_footer)):
+    if any((center_footer, left_footer, right_footer)):
         _xl_sheet.set_footer(
             "".join([
                 f"&L{left_footer}" if left_footer else "",
@@ -445,9 +445,6 @@ def scalar_to_sheet(
 
     Parameters
     ----------
-    _xl_book
-        Workbook object
-
     _xl_sheet
         Worksheet object to which to write the give array
 

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/src/mergeron/gen/enforcement_stats.py

@@ -10,6 +10,7 @@ from collections.abc import Mapping, Sequence
 from importlib import resources
 from pathlib import Path
 from types import SimpleNamespace
+from typing import Literal
 
 import numpy as np
 import re2 as re  # type: ignore
@@ -82,36 +83,12 @@ moe_tmpl = Template(R"""
     {% endif %}
     """)
 
-LTX_ARRAY_LINEEND = R"\\" "\n"
-latex_hrdcoldesc_format_str = "{}\n{}\n{}".format(
-    "".join((
-        R"\matrix[hcol, above=0pt of {}, nodes = {{",
-        R"text width={}, text depth=10pt, inner sep=3pt, minimum height=25pt,",
-        R"}},] ",
-        R"({}) ",
-        R"{{",
-    )),
-    R"\node[align = {},] {{ {} }}; \\",
-    R"}};",
-)
-
-
-class StatsContainer(SimpleNamespace):
-    """A container for passing content to jinja2 templates
-
-    Other attributes added later, to fully populate selected jinja2 templates
-    """
-
-    invdata_hdrstr: str
-    invdata_datstr: str
-
-
-# Define the latex jinja environment
-# http://eosrei.net/articles/2015/11/latex-templates-python-and-jinja2-generate-pdfs
+# Define the LaTeX jinja environment
+# http://eosrei.net/articles/2015/11/LaTeX-templates-python-and-jinja2-generate-pdfs
 with resources.as_file(
     resources.files(f"{_PKG_NAME}.data.jinja2_LaTeX_templates")
 ) as _tmpl_folder:
-    latex_jinja_env = Environment(
+    LaTeX_jinja_env = Environment(
         block_start_string=R"((*",
         block_end_string="*))",
         variable_start_string=R"\JINVAR{",
@@ -126,7 +103,7 @@ with resources.as_file(
         loader=FileSystemLoader(_tmpl_folder),
     )
 
-# Place files related to rendering latex in output data directory
+# Place files related to rendering LaTeX in output data directory
 if not (_out_path := DATA_DIR.joinpath(f"{_PKG_NAME}.cls")).is_file():
     with resources.as_file(
         resources.files(f"{_PKG_NAME}.data.jinja2_LaTeX_templates").joinpath(
@@ -146,6 +123,30 @@ if not (_DOTTEX := DATA_DIR / Rf"{_PKG_NAME}_TikZTableSettings.tex").is_file():
         shutil.copy2(_tex_path, _DOTTEX)
 
 
+LTX_ARRAY_LINEEND = R"\\" "\n"
+LaTeX_hrdcoldesc_format_str = "{}\n{}\n{}".format(
+    "".join((
+        R"\matrix[hcol, above=0pt of {}, nodes = {{",
+        R"text width={}, text depth=10pt, inner sep=3pt, minimum height=25pt,",
+        R"}},] ",
+        R"({}) ",
+        R"{{",
+    )),
+    R"\node[align = {},] {{ {} }}; \\",
+    R"}};",
+)
+
+
+class StatsContainer(SimpleNamespace):
+    """A container for passing content to jinja2 templates
+
+    Other attributes added later, to fully populate selected jinja2 templates
+    """
+
+    invdata_hdrstr: str
+    invdata_datstr: str
+
+
 # Parameters and functions to interpolate selected HHI and ΔHHI values
 #   recorded in fractions to ranges of values in points on the HHI scale
 HHI_DELTA_KNOTS = np.array(
@@ -184,21 +185,39 @@ ZONE_VALS = np.unique(
 )
 
 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};",
+}
+ZONE_DETAIL_STRINGS_HHI = {
+    0: Rf"HHI < {HHI_POST_ZONE_KNOTS[1]} pts.",
+    1: R"HHI ∈ [{}, {}) pts. and ".format(*HHI_POST_ZONE_KNOTS[1:3]),
+    2: Rf"HHI ≥ {HHI_POST_ZONE_KNOTS[2]} pts. and ",
+}
+
+ZONE_DETAIL_STRINGS_DELTA = {
+    0: "",
+    1: Rf"ΔHHI < \text{{{HHI_DELTA_KNOTS[1]} pts.}}",
+    2: Rf"ΔHHI ≥ \text{{{HHI_DELTA_KNOTS[1]} pts.}}",
+    3: R"ΔHHI ∈ \text{{[{}, {}) pts.}}".format(*HHI_DELTA_KNOTS[1:3]),
+    4: Rf"ΔHHI ≥ \text{{{HHI_DELTA_KNOTS[2]} pts.}}",
+}
+
+ZONE_STRINGS_LATEX = {
     0: R"\node[align = left, fill=BrightGreen] {Green Zone (Safeharbor)};",
     1: R"\node[align = left, fill=HiCoYellow] {Yellow Zone};",
     2: R"\node[align = left, fill=VibrRed] {Red Zone (SLC Presumption)};",
     fid.TTL_KEY: R"\node[align = left, fill=OBSHDRFill] {TOTAL};",
 }
 
-ZONE_DETAIL_STRINGS_HHI = {
+ZONE_DETAIL_STRINGS_HHI_LATEX = {
     0: Rf"HHI_{{post}} < \text{{{HHI_POST_ZONE_KNOTS[1]} pts.}}",
-    1: R"HHI_{{post}} \in \text{{[{}, {}) pts. and }} ".format(
-        *HHI_POST_ZONE_KNOTS[1:3]
-    ),
+    1: R"HHI_{{post}} ∈ \text{{[{}, {}) pts. and }} ".format(*HHI_POST_ZONE_KNOTS[1:3]),
     2: Rf"HHI_{{post}} \geqslant \text{{{HHI_POST_ZONE_KNOTS[2]} pts. and }} ",
 }
 
-ZONE_DETAIL_STRINGS_DELTA = {
+ZONE_DETAIL_STRINGS_DELTA_LATEX = {
     0: "",
     1: Rf"\Delta HHI < \text{{{HHI_DELTA_KNOTS[1]} pts.}}",
     2: Rf"\Delta HHI \geqslant \text{{{HHI_DELTA_KNOTS[1]} pts.}}",
@@ -207,13 +226,13 @@ ZONE_DETAIL_STRINGS_DELTA = {
 }
 
 
-def invres_stats_output(
+def enf_stats_output(
     _data_array_dict: fid.INVData,
     _data_period: str = "1996-2003",
     _table_ind_group: INDGRPConstants = INDGRPConstants.ALL,
     _table_evid_cond: EVIDENConstants = EVIDENConstants.UR,
     _stats_group: StatsGrpSelector = StatsGrpSelector.FC,
-    _invres_spec: INVResolution = INVResolution.CLRN,
+    _enf_spec: INVResolution = INVResolution.CLRN,
     /,
     *,
     return_type_sel: StatsReturnSelector = StatsReturnSelector.RPT,
@@ -228,49 +247,49 @@ def invres_stats_output(
 
     match _stats_group:
         case StatsGrpSelector.ZN:
-            _latex_tbl_invres_stats_func = latex_tbl_invres_stats_byzone
+            _enf_stats_table_func = enf_stats_table_byzone
         case StatsGrpSelector.FC:
-            _latex_tbl_invres_stats_func = latex_tbl_invres_stats_1dim
+            _enf_stats_table_func = enf_stats_table_1dim
         case StatsGrpSelector.DL:
-            _latex_tbl_invres_stats_func = latex_tbl_invres_stats_1dim
+            _enf_stats_table_func = enf_stats_table_1dim
         case _:
             raise ValueError(
                 'Statistics formatted, "{_stats_group}" not available here.'
             )
 
-    _invres_stats_cnts = invres_stats_cnts_by_group(
+    _enf_stats_cnts = enf_stats_listing_by_group(
         _data_array_dict,
         _data_period,
         _table_ind_group,
         _table_evid_cond,
         _stats_group,
-        _invres_spec,
+        _enf_spec,
     )
 
-    _invres_stats_hdr_list, _invres_stats_dat_list = _latex_tbl_invres_stats_func(
-        _invres_stats_cnts, None, return_type_sel=return_type_sel, sort_order=sort_order
+    _enf_stats_hdr_list, _enf_stats_dat_list = _enf_stats_table_func(
+        _enf_stats_cnts, None, return_type_sel=return_type_sel, sort_order=sort_order
     )
 
     if print_to_screen:
         print(
-            f"{_invres_spec.capitalize()} stats ({return_type_sel})",
+            f"{_enf_spec.capitalize()} stats ({return_type_sel})",
             f"for Period: {_data_period}",
             "\u2014",
             f"{_table_ind_group};",
             _table_evid_cond,
         )
-        stats_print_rows(_invres_stats_hdr_list, _invres_stats_dat_list)
+        stats_print_rows(_enf_stats_hdr_list, _enf_stats_dat_list)
 
-    return _invres_stats_hdr_list, _invres_stats_dat_list
+    return _enf_stats_hdr_list, _enf_stats_dat_list
 
 
-def invres_stats_cnts_by_group(
+def enf_stats_listing_by_group(
     _invdata_array_dict: Mapping[str, Mapping[str, Mapping[str, fid.INVTableData]]],
     _study_period: str,
     _table_ind_grp: INDGRPConstants,
     _table_evid_cond: EVIDENConstants,
     _stats_group: StatsGrpSelector,
-    _invres_spec: INVResolution,
+    _enf_spec: INVResolution,
     /,
 ) -> NDArray[np.int64]:
     if _stats_group == StatsGrpSelector.HD:
@@ -280,14 +299,14 @@ def invres_stats_cnts_by_group(
 
     match _stats_group:
         case StatsGrpSelector.FC:
-            _cnts_func = invres_cnts_byfirmcount
-            _cnts_listing_func = invres_cnts_listing_byfirmcount
+            _cnts_func = enf_cnts_byfirmcount
+            _cnts_listing_func = enf_cnts_listing_byfirmcount
         case StatsGrpSelector.DL:
-            _cnts_func = invres_cnts_bydelta
-            _cnts_listing_func = invres_cnts_listing_byhhianddelta
+            _cnts_func = enf_cnts_bydelta
+            _cnts_listing_func = enf_cnts_listing_byhhianddelta
         case StatsGrpSelector.ZN:
-            _cnts_func = invres_cnts_byconczone
-            _cnts_listing_func = invres_cnts_listing_byhhianddelta
+            _cnts_func = enf_cnts_byconczone
+            _cnts_listing_func = enf_cnts_listing_byhhianddelta
 
     return _cnts_func(
         _cnts_listing_func(
@@ -295,17 +314,17 @@ def invres_stats_cnts_by_group(
             _study_period,
             _table_ind_grp,
             _table_evid_cond,
-            _invres_spec,
+            _enf_spec,
         )
     )
 
 
-def invres_cnts_listing_byfirmcount(
+def enf_cnts_listing_byfirmcount(
     _data_array_dict: Mapping[str, Mapping[str, Mapping[str, fid.INVTableData]]],
     _data_period: str = "1996-2003",
     _table_ind_group: INDGRPConstants = INDGRPConstants.ALL,
     _table_evid_cond: EVIDENConstants = EVIDENConstants.UR,
-    _invres_spec: INVResolution = INVResolution.CLRN,
+    _enf_spec: INVResolution = INVResolution.CLRN,
     /,
 ) -> NDArray[np.int64]:
     if _data_period not in _data_array_dict:
@@ -322,7 +341,7 @@ def invres_cnts_listing_byfirmcount(
 
     _ndim_in = 1
     _stats_kept_indxs = []
-    match _invres_spec:
+    match _enf_spec:
         case INVResolution.CLRN:
             _stats_kept_indxs = [-1, -2]
         case INVResolution.ENFT:
@@ -336,12 +355,12 @@ def invres_cnts_listing_byfirmcount(
     ])
 
 
-def invres_cnts_listing_byhhianddelta(
+def enf_cnts_listing_byhhianddelta(
     _data_array_dict: Mapping[str, Mapping[str, Mapping[str, fid.INVTableData]]],
     _data_period: str = "1996-2003",
     _table_ind_group: INDGRPConstants = INDGRPConstants.ALL,
     _table_evid_cond: EVIDENConstants = EVIDENConstants.UR,
-    _invres_spec: INVResolution = INVResolution.CLRN,
+    _enf_spec: INVResolution = INVResolution.CLRN,
     /,
 ) -> NDArray[np.int64]:
     if _data_period not in _data_array_dict:
@@ -358,7 +377,7 @@ def invres_cnts_listing_byhhianddelta(
 
     _ndim_in = 2
     _stats_kept_indxs = []
-    match _invres_spec:
+    match _enf_spec:
         case INVResolution.CLRN:
             _stats_kept_indxs = [-1, -2]
         case INVResolution.ENFT:
@@ -398,7 +417,7 @@ def table_no_lku(
     return _tno
 
 
-def invres_cnts_byfirmcount(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int64]:
+def enf_cnts_byfirmcount(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int64]:
     _ndim_in = 1
     return np.vstack([
         np.concatenate([
@@ -409,7 +428,7 @@ def invres_cnts_byfirmcount(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int
     ])
 
 
-def invres_cnts_bydelta(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int64]:
+def enf_cnts_bydelta(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int64]:
     _ndim_in = 2
     return np.vstack([
         np.concatenate([
@@ -420,7 +439,7 @@ def invres_cnts_bydelta(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int64]:
     ])
 
 
-def invres_cnts_byconczone(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int64]:
+def enf_cnts_byconczone(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int64]:
     # Prepare to tag clearance stats by presumption zone
     _hhi_zone_post_ranged = hhi_zone_post_ranger(_cnts_array[:, 0] / 1e4)
     _hhi_delta_ranged = hhi_delta_ranger(_cnts_array[:, 1] / 1e4)
@@ -491,23 +510,23 @@ def invres_cnts_byconczone(_cnts_array: NDArray[np.int64], /) -> NDArray[np.int6
     return _cnts_byconczone[1:]
 
 
-def latex_tbl_invres_stats_1dim(
+def enf_stats_table_1dim(
     _inparr: NDArray[np.float64 | np.int64],
     _totals_row: int | None = None,
     /,
     *,
     return_type_sel: StatsReturnSelector = StatsReturnSelector.CNT,
     sort_order: SortSelector = SortSelector.UCH,
+    print_format: Literal["text", "LaTeX"] = "text",
 ) -> tuple[list[str], list[list[str]]]:
     _ndim_in: int = 1
     _dim_hdr_dict = {
-        _v: (_k if _k == "TOTAL" else f"{{{_k}}}")
-        for _k, _v in fid.CNT_FCOUNT_DICT.items()
+        _v: (_k if _k == "TOTAL" else f"{_k}") for _k, _v in fid.CNT_FCOUNT_DICT.items()
     } | {
         _v: (
-            "{[2500, 5000]}"
+            "[2500, 5000]"
             if _k == "2,500 +"
-            else f"{{[{_k.replace(",", "").replace(" - ", ", ")})}}"
+            else f"[{_k.replace(",", "").replace(" - ", ", ")})"
         )
         for _k, _v in fid.CONC_DELTA_DICT.items()
         if _k != "TOTAL"
@@ -531,7 +550,10 @@ def latex_tbl_invres_stats_1dim(
 
     _stats_hdr_list, _stats_dat_list = [], []
     for _stats_row in _inparr:
-        _stats_hdr_list += [_dim_hdr_dict[_stats_row[0]]]
+        _stats_hdr_str = _dim_hdr_dict[_stats_row[0]]
+        _stats_hdr_list += [
+            f"{{{_stats_hdr_str}}}" if print_format == "LaTeX" else _stats_hdr_str
+        ]
 
         _stats_cnt = _stats_row[_ndim_in:]
         _stats_tot = np.concatenate((
@@ -543,17 +565,20 @@ def latex_tbl_invres_stats_1dim(
     return _stats_hdr_list, _stats_dat_list
 
 
-def latex_tbl_invres_stats_byzone(
+def enf_stats_table_byzone(
     _inparr: NDArray[np.float64 | np.int64],
     _totals_row: int | None = None,
     /,
     *,
     return_type_sel: StatsReturnSelector = StatsReturnSelector.CNT,
     sort_order: SortSelector = SortSelector.UCH,
+    print_format: Literal["text", "LaTeX"] = "text",
 ) -> tuple[list[str], list[list[str]]]:
     _ndim_in: int = ZONE_VALS.shape[1]
 
-    _zone_str_keys = list(ZONE_STRINGS)
+    _zone_str_dict = ZONE_STRINGS_LATEX if print_format == "LaTeX" else ZONE_STRINGS
+    _zone_str_keys = list(_zone_str_dict)
+
     if sort_order == SortSelector.REV:
         _inparr = _inparr[::-1]
         _zone_str_keys = _zone_str_keys[:-1][::-1] + [_zone_str_keys[-1]]
@@ -570,7 +595,7 @@ def latex_tbl_invres_stats_byzone(
     _stats_hdr_list, _stats_dat_list = ([], [])
     for _conc_zone in _zone_str_keys:
         _stats_byzone_it = _inparr[_inparr[:, 0] == _conc_zone]
-        _stats_hdr_list += [ZONE_STRINGS[_conc_zone]]
+        _stats_hdr_list += [_zone_str_dict[_conc_zone]]
 
         _stats_cnt = np.einsum("ij->j", _stats_byzone_it[:, _ndim_in:])
         _stats_tot = np.concatenate((
@@ -585,18 +610,30 @@ def latex_tbl_invres_stats_byzone(
         for _stats_byzone_detail in _stats_byzone_it:
             # Only two sets of subtotals detail, so
             # a conditional expression will do here
-            _stats_text_color = "HiCoYellow" if _conc_zone == 1 else "BrightGreen"
-            _stats_hdr_list += [
-                R"{} {{ \({}{}\) }};".format(
-                    rf"\node[text = {_stats_text_color}, fill = white, align = right]",
-                    ZONE_DETAIL_STRINGS_HHI[_stats_byzone_detail[1]],
-                    (
-                        ""
-                        if _stats_byzone_detail[2] == 0
-                        else Rf"{ZONE_DETAIL_STRINGS_DELTA[_stats_byzone_detail[2]]}"
-                    ),
-                )
-            ]
+            if print_format == "LaTeX":
+                _stats_text_color = "HiCoYellow" if _conc_zone == 1 else "BrightGreen"
+                _stats_hdr_list += [
+                    R"{} {{ \({}{}\) }};".format(
+                        rf"\node[text = {_stats_text_color}, fill = white, align = right]",
+                        ZONE_DETAIL_STRINGS_HHI_LATEX[_stats_byzone_detail[1]],
+                        (
+                            ""
+                            if _stats_byzone_detail[2] == 0
+                            else Rf"{ZONE_DETAIL_STRINGS_DELTA_LATEX[_stats_byzone_detail[2]]}"
+                        ),
+                    )
+                ]
+            else:
+                _stats_hdr_list += [
+                    R"{}{};".format(
+                        ZONE_DETAIL_STRINGS_HHI[_stats_byzone_detail[1]],
+                        (
+                            ""
+                            if _stats_byzone_detail[2] == 0
+                            else Rf"{ZONE_DETAIL_STRINGS_DELTA[_stats_byzone_detail[2]]}"
+                        ),
+                    )
+                ]
 
             _stats_cnt = _stats_byzone_detail[_ndim_in:]
             _stats_tot = np.concatenate((
@@ -652,31 +689,34 @@ def _stats_formatted_row(
 
 
 def stats_print_rows(
-    _invres_stats_hdr_list: list[str], _invres_stats_dat_list: list[list[str]]
+    _enf_stats_hdr_list: list[str],
+    _enf_stats_dat_list: list[list[str]],
+    print_format: Literal["text", "LaTeX"] = "text",
 ) -> None:
-    for _idx, _hdr in enumerate(_invres_stats_hdr_list):
-        # _hv = (
-        #     re.match(r"^\\node.*?(\{.*\});?", _hdr)[1]
-        #     if _hdr.startswith(R"\node")
-        #     else _hdr
-        # )
-        _hdr_str = (
-            _hdr if _hdr == "TOTAL" else re.fullmatch(r".*?\{(.*)\};?", _hdr)[1].strip()
-        )
-        print(
-            _hdr_str,
-            "&",
-            " & ".join(_invres_stats_dat_list[_idx]),
-            LTX_ARRAY_LINEEND,
-            end="",
-        )
+    for _idx, _hdr in enumerate(_enf_stats_hdr_list):
+        if print_format == "LaTeX":
+            _hdr_str = (
+                _hdr
+                if _hdr == "TOTAL"
+                else re.fullmatch(r".*?\{(.*)\};?", _hdr)[1].strip()
+            )
+            print(
+                _hdr_str,
+                " & ",
+                " & ".join(_enf_stats_dat_list[_idx]),
+                LTX_ARRAY_LINEEND,
+                end="",
+            )
+        else:
+            print(_hdr, " | ", " | ".join(_enf_stats_dat_list[_idx]))
+
     print()
 
 
 def render_table_pdf(
     _table_dottex_pathlist: Sequence[str], _table_coll_path: str, /
 ) -> None:
-    _table_collection_design = latex_jinja_env.get_template(
+    _table_collection_design = LaTeX_jinja_env.get_template(
         "mergeron_table_collection_template.tex.jinja2"
     )
     _table_collection_content = StatsContainer()
@@ -692,12 +732,12 @@ def render_table_pdf(
         print("\n", file=_table_coll_file)
 
     _run_rc = subprocess.run(  # noqa: S603
-        f"latexmk -f -quiet -synctex=0 -interaction=nonstopmode -file-line-error -pdflua {_table_coll_path}".split(),
+        f"LaTeXmk -f -quiet -synctex=0 -interaction=nonstopmode -file-line-error -pdflua {_table_coll_path}".split(),
         check=True,
         cwd=DATA_DIR,
     )
     if _run_rc:
-        subprocess.run("latexmk -quiet -c".split(), check=True, cwd=DATA_DIR)  # noqa: S603
+        subprocess.run("LaTeXmk -quiet -c".split(), check=True, cwd=DATA_DIR)  # noqa: S603
     del _run_rc
 
     print(

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/src/mergeron/gen/market_sample.py

@@ -12,7 +12,7 @@ from .. import VERSION  # noqa: TID252
 from ..core.guidelines_boundaries import HMGThresholds  # noqa: TID252
 from . import MarketSpec, UPPTestRegime
 from .data_generation import gen_market_sample
-from .upp_tests import SaveData, invres_cnts, save_data_to_hdf5, sim_invres_cnts_ll
+from .upp_tests import SaveData, enf_cnts, save_data_to_hdf5, sim_enf_cnts_ll
 
 __version__ = VERSION
 
@@ -46,9 +46,9 @@ class MarketSample(MarketSpec):
                 save_data_to_file=save_data_to_file,
             )
 
-    def estimate_invres_counts(
+    def estimate_enf_counts(
         self,
-        _invres_parm_vec: HMGThresholds,
+        _enf_parm_vec: HMGThresholds,
         _upp_test_regime: UPPTestRegime,
         /,
         *,
@@ -58,9 +58,9 @@ class MarketSample(MarketSpec):
         save_data_to_file: SaveData = False,
     ) -> None:
         if getattr(self, "market_data_sample", None) is None:
-            self.invres_counts = sim_invres_cnts_ll(
+            self.enf_counts = sim_enf_cnts_ll(
                 self,
-                _invres_parm_vec,
+                _enf_parm_vec,
                 _upp_test_regime,
                 save_data_to_file=save_data_to_file,
                 sample_size=sample_size,
@@ -68,8 +68,8 @@ class MarketSample(MarketSpec):
                 nthreads=nthreads,
             )
         else:
-            self.invres_counts = invres_cnts(
-                self.data, _invres_parm_vec, _upp_test_regime
+            self.enf_counts = enf_cnts(
+                self.data, _enf_parm_vec, _upp_test_regime
             )
         if save_data_to_file:
-            save_data_to_hdf5(self.invres_counts, save_data_to_file=save_data_to_file)
+            save_data_to_hdf5(self.enf_counts, save_data_to_file=save_data_to_file)

{mergeron-2024.739088.0 → mergeron-2024.739088.2}/src/mergeron/gen/upp_tests.py

@@ -40,7 +40,7 @@ SaveData: TypeAlias = Literal[False] | tuple[Literal[True], ptb.File, ptb.Group]
 
 
 class INVRESCntsArgs(TypedDict, total=False):
-    "Keyword arguments of function, :code:`sim_invres_cnts`"
+    "Keyword arguments of function, :code:`sim_enf_cnts`"
 
     sample_size: int
     seed_seq_list: list[SeedSequence] | None
@@ -49,9 +49,9 @@ class INVRESCntsArgs(TypedDict, total=False):
     saved_array_name_suffix: str
 
 
-def sim_invres_cnts_ll(
+def sim_enf_cnts_ll(
     _mkt_sample_spec: MarketSpec,
-    _invres_parm_vec: gbl.HMGThresholds,
+    _enf_parm_vec: gbl.HMGThresholds,
     _sim_test_regime: UPPTestRegime,
     /,
     *,
@@ -63,8 +63,8 @@ def sim_invres_cnts_ll(
 ) -> UPPTestsCounts:
     """A function to parallelize data-generation and testing
 
-    The parameters `_sim_invres_cnts_kwargs` are passed unaltered to
-    the parent function, `sim_invres_cnts()`, except that, if provided,
+    The parameters `_sim_enf_cnts_kwargs` are passed unaltered to
+    the parent function, `sim_enf_cnts()`, except that, if provided,
     `seed_seq_list` is used to spawn a seed sequence for each thread,
     to assure independent samples in each thread, and `nthreads` defines
     the number of parallel processes used. The number of draws in
@@ -74,7 +74,7 @@ def sim_invres_cnts_ll(
     Parameters
     ----------
 
-    _invres_parm_vec
+    _enf_parm_vec
         Guidelines thresholds to test against
 
     _mkt_sample_spec
@@ -110,12 +110,12 @@ def sim_invres_cnts_ll(
 
     if (
         _mkt_sample_spec.share_spec.recapture_form != RECConstants.OUTIN
-        and _mkt_sample_spec.share_spec.recapture_rate != _invres_parm_vec.rec
+        and _mkt_sample_spec.share_spec.recapture_rate != _enf_parm_vec.rec
     ):
         raise ValueError(
             "{} {} {}".format(
                 f"Recapture rate from market sample spec, {_mkt_sample_spec.share_spec.recapture_rate}",
-                f"must match the value, {_invres_parm_vec.rec}",
+                f"must match the value, {_enf_parm_vec.rec}",
                 "the guidelines thresholds vector.",
             )
         )
@@ -126,18 +126,18 @@ def sim_invres_cnts_ll(
             zip(*[g.spawn(_iter_count) for g in seed_seq_list], strict=True)  # type: ignore
         )
 
-    _sim_invres_cnts_kwargs: INVRESCntsArgs = INVRESCntsArgs({
+    _sim_enf_cnts_kwargs: INVRESCntsArgs = INVRESCntsArgs({
         "sample_size": _subsample_sz,
         "save_data_to_file": save_data_to_file,
         "nthreads": nthreads,
     })
 
     _res_list = Parallel(n_jobs=_thread_count, prefer="threads")(
-        delayed(sim_invres_cnts)(
+        delayed(sim_enf_cnts)(
             _mkt_sample_spec,
-            _invres_parm_vec,
+            _enf_parm_vec,
             _sim_test_regime,
-            **_sim_invres_cnts_kwargs,
+            **_sim_enf_cnts_kwargs,
             saved_array_name_suffix=f"{saved_array_name_suffix}_{_iter_id:0{2 + int(np.ceil(np.log10(_iter_count)))}d}",
             seed_seq_list=_rng_seed_seq_list_ch,
         )
@@ -162,7 +162,7 @@ def sim_invres_cnts_ll(
     return upp_test_results
 
 
-def sim_invres_cnts(
+def sim_enf_cnts(
     _mkt_sample_spec: MarketSpec,
     _upp_test_parms: gbl.HMGThresholds,
     _sim_test_regime: UPPTestRegime,
@@ -195,7 +195,7 @@ def sim_invres_cnts(
         save_data_to_file=save_data_to_file,
     )
 
-    _upp_test_arrays = invres_cnts(
+    _upp_test_arrays = enf_cnts(
         _market_data_sample, _upp_test_parms, _sim_test_regime
     )
 
@@ -208,7 +208,7 @@ def sim_invres_cnts(
     return _upp_test_arrays
 
 
-def invres_cnts(
+def enf_cnts(
     _market_data_sample: MarketDataSample,
     _upp_test_parms: gbl.HMGThresholds,
     _upp_test_regime: UPPTestRegime,
@@ -228,12 +228,12 @@ def invres_cnts(
     if _firm_counts_weights is not None and np.all(_firm_counts_weights >= 0):
         _max_firm_count = len(_firm_counts_weights)
 
-        _invres_cnts_sim_byfirmcount_array = -1 * np.ones(_stats_rowlen, np.int64)
+        _enf_cnts_sim_byfirmcount_array = -1 * np.ones(_stats_rowlen, np.int64)
         for _firm_cnt in 2 + np.arange(_max_firm_count):
             _firm_count_test = _fcounts == _firm_cnt
 
-            _invres_cnts_sim_byfirmcount_array = np.vstack((
-                _invres_cnts_sim_byfirmcount_array,
+            _enf_cnts_sim_byfirmcount_array = np.vstack((
+                _enf_cnts_sim_byfirmcount_array,
                 np.array([
                     _firm_cnt,
                     np.einsum("ij->", 1 * _firm_count_test),
@@ -246,21 +246,21 @@ def invres_cnts(
                     ],
                 ]),
             ))
-        _invres_cnts_sim_byfirmcount_array = _invres_cnts_sim_byfirmcount_array[1:]
+        _enf_cnts_sim_byfirmcount_array = _enf_cnts_sim_byfirmcount_array[1:]
     else:
-        _invres_cnts_sim_byfirmcount_array = np.array(
+        _enf_cnts_sim_byfirmcount_array = np.array(
             np.nan * np.empty((1, _stats_rowlen)), np.int64
         )
-        _invres_cnts_sim_byfirmcount_array[0] = 2
+        _enf_cnts_sim_byfirmcount_array[0] = 2
 
     # Clearance/enfrocement counts --- by delta
     _hhi_delta_ranged = esl.hhi_delta_ranger(_hhi_delta)
-    _invres_cnts_sim_bydelta_array = -1 * np.ones(_stats_rowlen, np.int64)
+    _enf_cnts_sim_bydelta_array = -1 * np.ones(_stats_rowlen, np.int64)
     for _hhi_delta_lim in esl.HHI_DELTA_KNOTS[:-1]:
         _hhi_delta_test = _hhi_delta_ranged == _hhi_delta_lim
 
-        _invres_cnts_sim_bydelta_array = np.vstack((
-            _invres_cnts_sim_bydelta_array,
+        _enf_cnts_sim_bydelta_array = np.vstack((
+            _enf_cnts_sim_bydelta_array,
             np.array([
                 _hhi_delta_lim,
                 np.einsum("ij->", 1 * _hhi_delta_test),
@@ -273,7 +273,7 @@ def invres_cnts(
             ]),
         ))
 
-    _invres_cnts_sim_bydelta_array = _invres_cnts_sim_bydelta_array[1:]
+    _enf_cnts_sim_bydelta_array = _enf_cnts_sim_bydelta_array[1:]
 
     # Clearance/enfrocement counts --- by zone
     try:
@@ -310,16 +310,16 @@ def invres_cnts(
                 ]),
             ))
 
-    _invres_cnts_sim_byconczone_array = esl.invres_cnts_byconczone(
+    _enf_cnts_sim_byconczone_array = esl.enf_cnts_byconczone(
         _stats_byconczone_sim[1:]
     )
     del _stats_byconczone_sim
     del _hhi_delta, _hhi_post, _fcounts
 
     return UPPTestsCounts(
-        _invres_cnts_sim_byfirmcount_array,
-        _invres_cnts_sim_bydelta_array,
-        _invres_cnts_sim_byconczone_array,
+        _enf_cnts_sim_byfirmcount_array,
+        _enf_cnts_sim_bydelta_array,
+        _enf_cnts_sim_byconczone_array,
     )
 
 
@@ -348,7 +348,7 @@ def gen_upp_test_arrays(
         getattr(_upp_test_parms, _f) for _f in ("guppi", "divr", "cmcr", "ipr")
     )
 
-    _invres_resolution, _guppi_aggregator, _divr_aggregator = (
+    _enf_resolution, _guppi_aggregator, _divr_aggregator = (
         getattr(_sim_test_regime, _f)
         for _f in ("resolution", "guppi_aggregator", "divr_aggregator")
     )
@@ -443,7 +443,7 @@ def gen_upp_test_arrays(
     if _divr_aggregator == UPPAggrSelector.MAX:
         _divr_test_vector = _market_data.divr_array.max(axis=1, keepdims=True)
 
-    if _invres_resolution == INVResolution.ENFT:
+    if _enf_resolution == INVResolution.ENFT:
         _upp_test_arrays = UPPTestsRaw(
             _guppi_test_vector >= _g_bar,
             (_guppi_test_vector >= _g_bar) | (_divr_test_vector >= _divr_bar),
@@ -469,7 +469,7 @@ def initialize_hd5(
         _h5_path.unlink()
     _h5_file = ptb.open_file(_h5_path, mode="w", title=_h5_title)
     _save_data_to_file: tuple[Literal[True], ptb.File, str] = (True, _h5_file, "/")
-    _next_subgroup_name_root = "invres_{}_{}_{}_{}".format(
+    _next_subgroup_name_root = "enf_{}_{}_{}_{}".format(
         _hmg_pub_year,
         *(getattr(_test_regime, _f.name).name for _f in _test_regime.__attrs_attrs__),
     )