KSLCore/ksl.controls.experiments/DesignedExperimentIfc

DesignedExperimentIfc

interface DesignedExperimentIfc : NameIfc(source)

Lightweight reporting and analysis surface shared by designed experiments.

This interface intentionally describes executed design results, not execution mechanics. Sequential and parallel designed experiments differ in how they create and run models, but reporting only needs the design, executed runs, response names, observations, and regression bridge.

Inheritors

DesignedExperiment

ParallelDesignedExperiment

Properties

design

abstract val design: ExperimentalDesignIfc

The experimental design associated with the executed design points.

numSimulationRuns

abstract val numSimulationRuns: Int

The number of design points that have been executed.

responseNames

abstract val responseNames: List<String>

The names of responses or counters available for reporting.

simulationRuns

abstract val simulationRuns: List<SimulationRun>

Executed simulation runs, one run for each simulated design point.

Functions

observationsAsMap

abstract fun observationsAsMap(responseName: String): Map<String, DoubleArray>

Returns a map of design-point label to per-replication observations for responseName.

regressionResults

abstract fun regressionResults(responseName: String, linearModel: LinearModel, coded: Boolean): RegressionResultsIfc

Performs the regression of linearModel for responseName.

toReport

fun DesignedExperimentIfc.toReport(title: String = "Designed Experiment ", confidenceLevel: Double = 0.95, coded: Boolean = false, showDetails: Boolean = false, boxPlotResponses: List<String> = emptyList(), block: ReportBuilder.() -> Unit = { designedExperiment(this@toReport, confidenceLevel, coded, showDetails, boxPlotResponses) }): ReportNode.Document

Builds a ReportNode.Document containing a full designed experiment report for any implementation of DesignedExperimentIfc.