KSLCore/ksl.app.optimization.results

Package-level declarations

Types

Canonical filenames for the auto-written artifacts. Centralised so any UI shell can list and offer to open them without re-deriving the conventions.

ArtifactWriteResult

data class ArtifactWriteResult(val summaryTomlWritten: Boolean, val iterationHistoryCsvWritten: Boolean, val bestSolutionCsvWritten: Boolean, val convergencePngWritten: Boolean, val reportHtmlWritten: Boolean)

Result of an artifact-write attempt. Per-artifact flags let callers (and tests) verify that a partial set landed even when individual writes failed.

BestSolutionCsvWriter

object BestSolutionCsvWriter

Single-row CSV of the best solution found by an optimization run.

ConvergencePlot

class ConvergencePlot(history: List<SolverStateSnapshot>) : BasePlot

Convergence plot for a simulation-optimization run.

ConvergencePlotBuilder

object ConvergencePlotBuilder

Convenience helpers around ConvergencePlot for writing a PNG sibling artifact in the run directory. The interactive embed in the HTML report is handled by the report DSL — this writer only produces the static PNG for users who want an image they can drop into slides or share without a browser.

HtmlReportWriter

object HtmlReportWriter

HTML report writer for a finished optimization run.

IterationHistoryCsvWriter

object IterationHistoryCsvWriter

Wide-format CSV of the full iteration history.

LatestBestSnapshot

data class LatestBestSnapshot(val iteration: Int, val estimatedObjective: Double, val bestInputs: Map<String, Double>)

Minimal projection of a RunEvent.IterationCompleted used when building a partial RunSummary. Decoupled from the substrate type so callers don't need to construct a real RunEvent.

ResultsArtifactWriter

object ResultsArtifactWriter

Coordinator that writes the full artifact set on a successful run completion. Each writer is best-effort — a single failure (e.g. lets-plot PNG export failing because the JVM can't find its native renderer) doesn't abort the rest.

ResultsStatus

@Serializable

enum ResultsStatus : Enum<ResultsStatus>

Status of a finished run, embedded in RunSummary so a partial artifact set (cancelled / failed runs) is still self-describing.

RunSummary

@Serializable

data class RunSummary(val analysisName: String, val runDirectory: String? = null, val algorithm: String, val solverName: String? = null, val modelIdentifier: String? = null, val status: ResultsStatus, val statusReason: String? = null, val startTime: String, val endTime: String, val elapsedMillis: Long, val totalIterations: Int, val totalOracleCalls: Int? = null, val bestEstimatedObjective: Double? = null, val bestPenalizedObjective: Double? = null, val bestFoundAtIteration: Int? = null, val runId: String, val bestInputs: Map<String, Double> = emptyMap(), val solverConfiguration: Map<String, String> = emptyMap())

Machine-readable summary of a finished optimization run.

RunSummaryWriter

object RunSummaryWriter

Writer + builder for RunSummary.