KSLCore/ksl.utilities.statistic/HalfWidthSequentialSampler

HalfWidthSequentialSampler

class HalfWidthSequentialSampler(aName: String? = null) : Observable<Double> , IdentityIfc, DoubleEmitterIfc

Continually gets the value of the supplied GetValueIfc in the run() until the supplied sampling half-width requirement is met or the default maximum number of iterations is reached, whichever comes first.

Author

rossetti

Constructors

HalfWidthSequentialSampler

constructor(aName: String? = null)

Properties

confidenceLevel

var confidenceLevel: Double

desiredHalfWidth

var desiredHalfWidth: Double

emitter

open override val emitter: Emitter<Double>

open override val id: Int

label

open override var label: String?

maxIterations

var maxIterations: Long

name

open override val name: String

statistic

val statistic: StatisticIfc

Functions

attachObserver

open override fun attachObserver(observer: ObserverIfc<Double>)

Allows the adding (attaching) of an observer to the observable

countObservers

open override fun countObservers(): Int

Returns how many observers are currently attached to the observable

detachAllObservers

open override fun detachAllObservers()

Detaches all the observers from the observable

detachObserver

open override fun detachObserver(observer: ObserverIfc<Double>)

Allows the deletion (removing) of an observer from the observable

hasConverged

fun hasConverged(dhw: Double): Boolean

isAttached

open override fun isAttached(observer: ObserverIfc<Double>): Boolean

Returns true if the observer is already attached

observe

fun <T> Observable<T>.observe(block: (T?) -> Unit)

run

fun run(v: GetValueIfc, dhw: Double = desiredHalfWidth, maxIter: Long = maxIterations): Boolean

toString

open override fun toString(): String