KSLCore/ksl.observers/ControlVariateDataCollector

ControlVariateDataCollector

class ControlVariateDataCollector @JvmOverloads constructor(model: Model, name: String? = null) : ModelElement(source)

Defines responses and controls for a control variate experiment. Collects the replication responses for the responses and for the controls. Must be created prior to running the simulation to actually collect any data. Uses a ReplicationDataCollector

Constructors

@JvmOverloads

constructor(model: Model, name: String? = null)

Properties

numberOfResponses

val numberOfResponses: Int

numReplications

val numReplications: Int

The number of replications observed

Functions

addControlVariate

fun addControlVariate(randomVariableName: String, meanValue: Double): ResponseCIfc

If the RandomVariable doesn't exist in the model then an error occurs

fun addControlVariate(rvSource: RandomVariableCIfc, meanValue: Double, controlAlias: String = rvSource.name): ResponseCIfc

If the random source doesn't exist in the model then an error occurs

addResponse

fun addResponse(responseName: String)

The supplied name must be the name of the model element representing the desired response. If the name does not exist in the model, then nothing is added and no errors occur. Thus, this method fails silently.

fun addResponse(response: ResponseCIfc, responseAlias: String = response.name)

The response is added to the control variate data collector with the supplied responseAlias response alias. The default response alias is the name of the response within the model. If the response alias has already been added, then an exception occurs. That is, the response alias must be unique to the collector.

allNames