mergeron 2024.739125.2__py3-none-any.whl → 2024.739127.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of mergeron might be problematic. Click here for more details.

Files changed (16) hide show
  1. mergeron/__init__.py +1 -1
  2. mergeron/gen/data_generation.py +21 -21
  3. mergeron/gen/enforcement_stats.py +3 -553
  4. mergeron/gen/upp_tests.py +16 -17
  5. {mergeron-2024.739125.2.dist-info → mergeron-2024.739127.0.dist-info}/METADATA +1 -1
  6. mergeron-2024.739127.0.dist-info/RECORD +24 -0
  7. mergeron/data/jinja2_LaTeX_templates/clrrate_cis_summary_table_template.tex.jinja2 +0 -121
  8. mergeron/data/jinja2_LaTeX_templates/ftcinvdata_byhhianddelta_table_template.tex.jinja2 +0 -82
  9. mergeron/data/jinja2_LaTeX_templates/ftcinvdata_summary_table_template.tex.jinja2 +0 -57
  10. mergeron/data/jinja2_LaTeX_templates/ftcinvdata_summarypaired_table_template_tabularray.tex.jinja2 +0 -81
  11. mergeron/data/jinja2_LaTeX_templates/ftcinvdata_summarypaired_table_template_tikz.tex.jinja2 +0 -142
  12. mergeron/data/jinja2_LaTeX_templates/mergeron.cls +0 -155
  13. mergeron/data/jinja2_LaTeX_templates/mergeron_table_collection_template.tex.jinja2 +0 -93
  14. mergeron/data/jinja2_LaTeX_templates/setup_tikz_tables.sty +0 -129
  15. mergeron-2024.739125.2.dist-info/RECORD +0 -32
  16. {mergeron-2024.739125.2.dist-info → mergeron-2024.739127.0.dist-info}/WHEEL +0 -0
mergeron/__init__.py CHANGED
@@ -9,7 +9,7 @@ from numpy.typing import NDArray
9
9
 
10
10
  _PKG_NAME: str = Path(__file__).parent.stem
11
11
 
12
- VERSION = "2024.739125.2"
12
+ VERSION = "2024.739127.0"
13
13
 
14
14
  __version__ = VERSION
15
15
 
mergeron/gen/data_generation.py CHANGED
@@ -34,7 +34,7 @@ from .data_generation_functions import (
34
34
  gen_share_data,
35
35
  parse_seed_seq_list,
36
36
  )
37
- from .upp_tests import SaveData, enf_cnts, save_data_to_hdf5
37
+ from .upp_tests import SaveData, compute_upp_test_counts, save_data_to_hdf5
38
38
 
39
39
  __version__ = VERSION
40
40
 
@@ -113,15 +113,13 @@ class MarketSample:
113
113
 
114
114
  enf_counts: UPPTestsCounts = field(default=None)
115
115
 
116
- def gen_market_sample(
116
+ def _gen_market_sample(
117
117
  self,
118
118
  /,
119
119
  *,
120
- sample_size: int = 10**6,
121
- seed_seq_list: Sequence[SeedSequence] | None = None,
122
- nthreads: int = 16,
123
- save_data_to_file: SaveData = False,
124
- saved_array_name_suffix: str = "",
120
+ sample_size: int,
121
+ seed_seq_list: Sequence[SeedSequence] | None,
122
+ nthreads: int,
125
123
  ) -> MarketDataSample:
126
124
  """
127
125
  Generate share, diversion ratio, price, and margin data for MarketSpec.
@@ -242,11 +240,11 @@ class MarketSample:
242
240
  self,
243
241
  /,
244
242
  *,
245
- sample_size: int,
246
- seed_seq_list: Sequence[SeedSequence],
247
- nthreads: int,
248
- save_data_to_file: SaveData,
249
- saved_array_name_suffix: str,
243
+ sample_size: int = 10**6,
244
+ seed_seq_list: Sequence[SeedSequence] | None = None,
245
+ nthreads: int = 16,
246
+ save_data_to_file: SaveData = False,
247
+ saved_array_name_suffix: str = "",
250
248
  ) -> None:
251
249
  """Populate :attr:`data` with generated data
252
250
 
@@ -258,7 +256,7 @@ class MarketSample:
258
256
 
259
257
  """
260
258
 
261
- self.data = self.gen_market_sample(
259
+ self.data = self._gen_market_sample(
262
260
  sample_size=sample_size, seed_seq_list=seed_seq_list, nthreads=nthreads
263
261
  )
264
262
 
@@ -275,7 +273,7 @@ class MarketSample:
275
273
  save_data_to_file=save_data_to_file,
276
274
  )
277
275
 
278
- def sim_enf_cnts(
276
+ def _sim_enf_cnts(
279
277
  self,
280
278
  _upp_test_parms: gbl.HMGThresholds,
281
279
  _sim_test_regime: UPPTestRegime,
@@ -322,7 +320,7 @@ class MarketSample:
322
320
 
323
321
  """
324
322
 
325
- _market_data_sample = self.gen_market_sample(
323
+ _market_data_sample = self._gen_market_sample(
326
324
  sample_size=sample_size, seed_seq_list=seed_seq_list, nthreads=nthreads
327
325
  )
328
326
 
@@ -339,7 +337,7 @@ class MarketSample:
339
337
  save_data_to_file=save_data_to_file,
340
338
  )
341
339
 
342
- _upp_test_arrays = enf_cnts(
340
+ _upp_test_arrays = compute_upp_test_counts(
343
341
  _market_data_sample, _upp_test_parms, _sim_test_regime
344
342
  )
345
343
 
@@ -351,7 +349,7 @@ class MarketSample:
351
349
 
352
350
  return _upp_test_arrays
353
351
 
354
- def sim_enf_cnts_ll(
352
+ def _sim_enf_cnts_ll(
355
353
  self,
356
354
  _enf_parm_vec: gbl.HMGThresholds,
357
355
  _sim_test_regime: UPPTestRegime,
@@ -435,7 +433,7 @@ class MarketSample:
435
433
  })
436
434
 
437
435
  _res_list = Parallel(n_jobs=_thread_count, prefer="threads")(
438
- delayed(self.sim_enf_cnts)(
436
+ delayed(self._sim_enf_cnts)(
439
437
  _enf_parm_vec,
440
438
  _sim_test_regime,
441
439
  **_sim_enf_cnts_kwargs,
@@ -474,7 +472,7 @@ class MarketSample:
474
472
  save_data_to_file: SaveData = False,
475
473
  saved_array_name_suffix: str = "",
476
474
  ) -> None:
477
- """Populate :attr:`enf_counts` etimated test counts.
475
+ """Populate :attr:`enf_counts` with estimated UPP test counts.
478
476
 
479
477
  Parameters
480
478
  ----------
@@ -510,7 +508,7 @@ class MarketSample:
510
508
  """
511
509
 
512
510
  if self.data is None:
513
- self.enf_counts = self.sim_enf_cnts_ll(
511
+ self.enf_counts = self._sim_enf_cnts_ll(
514
512
  _enf_parm_vec,
515
513
  _upp_test_regime,
516
514
  sample_size=sample_size,
@@ -520,7 +518,9 @@ class MarketSample:
520
518
  saved_array_name_suffix=saved_array_name_suffix,
521
519
  )
522
520
  else:
523
- self.enf_counts = enf_cnts(self.data, _enf_parm_vec, _upp_test_regime)
521
+ self.enf_counts = compute_upp_test_counts(
522
+ self.data, _enf_parm_vec, _upp_test_regime
523
+ )
524
524
  if save_data_to_file:
525
525
  save_data_to_hdf5(
526
526
  self.enf_counts,