KSLCore/ksl.utilities.random.robj/BernoulliPicker

BernoulliPicker

class BernoulliPicker<T>(successProbability: Double, successOption: T, failureOption: T, stream: RNStreamIfc = KSLRandom.nextRNStream()) : RElementIfc<T>

Allows the picking between two alternatives according to a Bernoulli process.

Parameters

successProbability

the probability associated with success

success

the success choice

failure

the failure choice

stream

the associated random number stream

Constructors

BernoulliPicker

constructor(successProbability: Double, successOption: T, failureOption: T, streamNum: Int)

constructor(successProbability: Double, successOption: T, failureOption: T, stream: RNStreamIfc = KSLRandom.nextRNStream())

Properties

advanceToNextSubStreamOption

open override var advanceToNextSubStreamOption: Boolean

If true, the stream will automatically participate in having its stream advanced to the next sub-stream via stream managers

antithetic

open override var antithetic: Boolean

Tells the stream to start producing antithetic variates

failure

var failure: T

randomElement

open override val randomElement: T

Returns an element randomly selected from the list

resetStartStreamOption

open override var resetStartStreamOption: Boolean

If true, the stream will automatically participate in having its stream reset to its start stream via stream managers

rnStream

open override var rnStream: RNStreamIfc

the underlying stream of random numbers

streamNumber

open val streamNumber: Int

success

var success: T

Functions

advanceToNextSubStream

open override fun advanceToNextSubStream()

Positions the RNG at the beginning of its next substream

resetStartStream

open override fun resetStartStream()

The resetStartStream method will position the RNG at the beginning of its stream. This is the same location in the stream as assigned when the RNG was created and initialized.

resetStartSubStream

open override fun resetStartSubStream()

Resets the position of the RNG at the start of the current substream

sample

open fun sample(): T

Returns an element randomly selected from the list

open fun sample(size: Int): List<T>

Returns sample of size from the list

useStreamNumber

open fun useStreamNumber(streamNumber: Int)

Assigns the stream associated with the supplied number from the default RNStreamProvider