R1.1.9

KSLCore/ksl.utilities.random.rvariable/BinomialRV

BinomialRV

class BinomialRV(val pSuccess: Double, val numTrials: Int, stream: RNStreamIfc = KSLRandom.nextRNStream(), name: String? = null) : ParameterizedRV

BinomialRV(probability of success, number of trials)

Parameters

pSuccess

the probability of success, must be in (0,1)

numTrials

the number of trials, must be greater than 0

stream

the stream from the stream provider to use

name

an optional name

Constructors

constructor(pSuccess: Double, numTrials: Int, streamNum: Int, name: String? = null)

constructor(pSuccess: Double, numTrials: Int, stream: RNStreamIfc = KSLRandom.nextRNStream(), name: String? = null)

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

open override var antithetic: Boolean

Tells the stream to start producing antithetic variates

open override val emitter: Emitter<Double>

open override val id: Int

open override var label: String?

open override val name: String

val numTrials: Int

open override val parameters: RVParameters

override var previousValue: Double

The last (previous) randomly generated value. This value does not change until the next randomly generated value is obtained

val pSuccess: Double

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

override var rnStream: RNStreamIfc

rnStream provides a reference to the underlying stream of random numbers

open val streamNumber: Int

open override val value: Double

The randomly generated value. Each value will be different

Functions

advanceToNextSubStream

open override fun advanceToNextSubStream()

Positions the RNG at the beginning of its next substream

antitheticInstance

open override fun antitheticInstance(): RVariableIfc

open operator fun div(x: Double): RVariableIfc

open operator fun div(other: RVariableIfc): RVariableIfc

open override fun instance(stream: RNStreamIfc): BinomialRV

open fun instance(): RVariableIfc

fun instance(newRNG: Boolean): RVariableIfc

Makes a new instance. False allows the new instance to keep using the same underlying source of random numbers.

open operator fun minus(x: Double): RVariableIfc

open operator fun minus(other: RVariableIfc): RVariableIfc

open operator fun plus(x: Double): RVariableIfc

open operator fun plus(other: RVariableIfc): RVariableIfc

open fun pow(x: Double): RVariableIfc

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

open fun sample(sampleSize: Int): DoubleArray

Generates a random generated sample of the give size

override fun sample(): Double

sampleAsColumns

open fun sampleAsColumns(sampleSize: Int, nCols: Int = 1): Array<DoubleArray>

Generates the number of columns nCols with each column holding a random sample of size sampleSize

open fun sampleAsRows(sampleSize: Int, nRows: Int = 1): Array<DoubleArray>

Generates the number of rows nRows with each row holding a random sample of size sampleSize

open fun sampleInto(matrix: Array<DoubleArray>)

Fills the supplied matrix with randomly generated values

open fun sampleInto(values: DoubleArray)

Fills the supplied array with randomly generated values

open fun sum(numInSum: Int): Double

open operator fun times(x: Double): RVariableIfc

open operator fun times(other: RVariableIfc): RVariableIfc

open override fun toString(): String

useStreamNumber

open fun useStreamNumber(streamNumber: Int)

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

open override fun value(): Double

The randomly generated value. Each value will be different