mcExperiment

fun ReportBuilder.mcExperiment(exp: MCExperiment, caption: String? = null)(source)

Appends a self-contained section reporting the configuration, convergence diagnostics, and statistical estimate for any MCExperiment.

Delegates to mcExperimentConfig, mcExperimentDiagnostics, and statPropertyTable in sequence. Use the granular functions directly when you need only a subset of these sections.

Produces (inside a section titled caption or "Monte Carlo Experiment"):

  1. mcExperimentConfig section — setup parameters

  2. mcExperimentDiagnostics section — convergence status, HW gap, optional history plot; omitted when the experiment has not been run

  3. statPropertyTable — all 19 statistical fields via ksl.utilities.statistic.StatisticIfc; omitted when the experiment has not been run

Parameters

exp

the MCExperiment to report

caption

optional section title; defaults to "Monte Carlo Experiment"