KSLCore/ksl.simulation/SimulationReporter

SimulationReporter

class SimulationReporter(theModel: Model)

This class facilitates simulation output reporting. There are two main reporting functions: within replication statistics and across replication statistics. The class automatically reports within replication and across replication statistics to comma separated value files by attaching observers to the model. If you do not want this automated output, then you should use the appropriate turnOffXXX methods.

This class attaches a CSVReplicationReport to the model for collection purposes. If the simulation is run multiple times, then statistical data continues to be observed by the CSVReplicationReport, unless it is turned off. Thus, data across many experiments can be captured in this manner. This produces a comma separated value file containing all end of replication statistical summaries for every counter and response variable in the model.

There are a number of options available if you want to capture across replication statistics.

The class uses a CSVExperimentReport to observe the model. This produces a comma separated value file containing all across replication statistical summaries for every counter and response variable in the model.

Use any of the writeAcrossReplicationX() methods. These methods will write across replication summary statistics to files, standard output, LaTeX, CSV, etc.

Author

rossetti

Constructors

SimulationReporter

constructor(theModel: Model)

Properties

counters

val counters: List<Counter>

A convenience method. Gets the counters from the model

frequencies

val frequencies: List<IntegerFrequencyResponse>

A convenience method. Gets the frequencies from the model

histograms

val histograms: List<HistogramResponse>

A convenience method. Gets the histograms from the model

responses

val responses: List<Response>

A convenience method. Gets the response variables from the model

Functions

acrossReplicationCSVStatistics

fun acrossReplicationCSVStatistics(): StringBuilder

Uses a StringBuilder to hold the across replication statistics formatted as a comma separated values with an appropriate header

acrossReplicationStatisticReporter

fun acrossReplicationStatisticReporter(): StatisticReporter

acrossReplicationStatistics

fun acrossReplicationStatistics(sb: StringBuilder = StringBuilder()): StringBuilder

Fills the StringBuilder with across replication statistics

acrossReplicationStatisticsAsDataFrame

fun acrossReplicationStatisticsAsDataFrame(level: Double = 0.95): DataFrame<StatisticData>

Returns the across replication statistics as a data frame with confidence intervals specified by the provided level.

acrossReplicationStatisticsAsLaTeXDocument

fun acrossReplicationStatisticsAsLaTeXDocument(maxRows: Int = 60): StringBuilder

Returns a StringBuilder representation of the across replication statistics as a LaTeX document

acrossReplicationStatisticsAsLaTeXTables

fun acrossReplicationStatisticsAsLaTeXTables(maxRows: Int = 60): List<StringBuilder>

List of StringBuilder representing LaTeX tables

acrossReplicationStatisticsAsLaTeXTabular

fun acrossReplicationStatisticsAsLaTeXTabular(maxRows: Int = 60): List<StringBuilder>

Gets shortened across replication statistics for response variables as a LaTeX tabular. Each StringBuilder in the list represents a tabular with a maximum number of rows

acrossReplicationStatisticsList

fun acrossReplicationStatisticsList(): List<StatisticIfc>

Gets the across replication statistics as a list

fillAcrossReplicationStatistics

fun fillAcrossReplicationStatistics(list: MutableList<StatisticIfc>)

Fills the supplied list with the across replication statistics

fillCounterAcrossReplicationStatistics

fun fillCounterAcrossReplicationStatistics(list: MutableList<StatisticIfc>)

Fills the list with across replication statistics from the Counters

fillResponseReplicationStatistics

fun fillResponseReplicationStatistics(list: MutableList<StatisticIfc>)

Fills the list with across replication statistics from the response variables (Response and TWResponse).

frequencyTextResults

fun frequencyTextResults(): String

Returns all frequency response results as a string

halfWidthSummaryReport

fun halfWidthSummaryReport(title: String? = null, confLevel: Double = 0.95): StringBuilder

histogramTextResults

fun histogramTextResults(): String

Returns all histogram results as a string

printAcrossReplicationCSVStatistics

fun printAcrossReplicationCSVStatistics()

Prints the across replication statistics as comma separated values

printAcrossReplicationSummaryStatistics

fun printAcrossReplicationSummaryStatistics()

Writes the across replication statistics as text values to System.out

printFullAcrossReplicationStatistics

fun printFullAcrossReplicationStatistics()

Writes the across replication statistics as text values to System.out

printHalfWidthSummaryReport

fun printHalfWidthSummaryReport(title: String? = null, confLevel: Double = 0.95)

writeAcrossReplicationCSVStatistics

fun writeAcrossReplicationCSVStatistics(out: PrintWriter)

Writes the across replication statistics to the supplied PrintWriter as comma separated value output

fun writeAcrossReplicationCSVStatistics(pathToFile: Path): PrintWriter

Creates a PrintWriter with the supplied name in directory jslOutput and writes out the across replication statistics

fun writeAcrossReplicationCSVStatistics(fName: String = model.simulationName + "_AcrossRepCSVStatistics.csv"): PrintWriter

Creates a PrintWriter with the supplied name in default output directory for the simulation writes out the across replication statistics

writeAcrossReplicationSummaryStatistics

fun writeAcrossReplicationSummaryStatistics(out: PrintWriter)

Writes shortened across replication statistics to the supplied PrintWriter as text output

fun writeAcrossReplicationSummaryStatistics(pathToFile: Path): PrintWriter

Creates a PrintWriter with the supplied name in directory within jslOutput and writes out the across replication statistics

fun writeAcrossReplicationSummaryStatistics(fName: String = model.simulationName + "_SummaryStatistics.txt"): PrintWriter

Creates a PrintWriter with the supplied name in directory jslOutput and writes out the across replication statistics

writeAcrossReplicationSummaryStatisticsAsLaTeX

fun writeAcrossReplicationSummaryStatisticsAsLaTeX(): PrintWriter

Creates a file with name getSimulation().getName() + "_LaTeX_Across_Replication_Summary.tex" in the simulation's output directory with the results as a LaTeX table.

fun writeAcrossReplicationSummaryStatisticsAsLaTeX(out: PrintWriter)

Writes shortened across replication statistics to the supplied PrintWriter as text output in LaTeX document form

fun writeAcrossReplicationSummaryStatisticsAsLaTeX(pathToFile: Path): PrintWriter

Creates a PrintWriter using the supplied path and writes out the across replication statistics as a LaTeX file

fun writeAcrossReplicationSummaryStatisticsAsLaTeX(fName: String): PrintWriter

Creates a file with the supplied name in the simulation's output directory with the results as a LaTeX table.

writeFullAcrossReplicationStatistics

fun writeFullAcrossReplicationStatistics(out: PrintWriter)

Writes the full across replication statistics to the supplied PrintWriter as text output. Full means all statistical quantities are printed for every statistic

fun writeFullAcrossReplicationStatistics(pathToFile: Path): PrintWriter

Creates a PrintWriter with the supplied path and writes the full statistics to the file. Full means all detailed statistical quantities for every statistic.

fun writeFullAcrossReplicationStatistics(fName: String = model.simulationName + "_FullAcrossRepStatistics.txt"): PrintWriter

Creates a PrintWriter with the supplied name in the default output directory for the model writes out the across replication statistics.

writeHalfWidthSummaryReport

fun writeHalfWidthSummaryReport(out: PrintWriter = PrintWriter(System.out), title: String? = null, confLevel: Double = 0.95)

writeHalfWidthSummaryReportAsMarkDown

fun writeHalfWidthSummaryReportAsMarkDown(out: PrintWriter = PrintWriter(System.out), title: String? = null, confLevel: Double = 0.95, df: DecimalFormat? = null)