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

Link copied to clipboard
constructor(pSuccess: Double, numTrials: Int, streamNum: Int, name: String? = null)
constructor(pSuccess: Double, numTrials: Int, stream: RNStreamIfc = KSLRandom.nextRNStream(), name: String? = null)

Properties

Link copied to clipboard

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

Link copied to clipboard
open override var antithetic: Boolean

Tells the stream to start producing antithetic variates

Link copied to clipboard
open override val emitter: Emitter<Double>
Link copied to clipboard
open override val id: Int
Link copied to clipboard
open override var label: String?
Link copied to clipboard
open override val name: String
Link copied to clipboard
Link copied to clipboard
open override val parameters: RVParameters
Link copied to clipboard
override var previousValue: Double

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

Link copied to clipboard
Link copied to clipboard
open override var resetStartStreamOption: Boolean

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

Link copied to clipboard
override var rnStream: RNStreamIfc

rnStream provides a reference to the underlying stream of random numbers

Link copied to clipboard
open val streamNumber: Int
Link copied to clipboard
open override val value: Double

The randomly generated value. Each value will be different

Functions

Link copied to clipboard
open override fun advanceToNextSubStream()

Positions the RNG at the beginning of its next substream

Link copied to clipboard
open override fun antitheticInstance(): RVariableIfc
Link copied to clipboard
open operator fun div(x: Double): RVariableIfc
open operator fun div(other: RVariableIfc): RVariableIfc
Link copied to clipboard
open override fun instance(stream: RNStreamIfc): BinomialRV

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

Link copied to clipboard
open operator fun minus(x: Double): RVariableIfc
open operator fun minus(other: RVariableIfc): RVariableIfc
Link copied to clipboard
open operator fun plus(x: Double): RVariableIfc
open operator fun plus(other: RVariableIfc): RVariableIfc
Link copied to clipboard
open fun pow(x: Double): RVariableIfc
Link copied to clipboard
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.

Link copied to clipboard
open override fun resetStartSubStream()

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

Link copied to clipboard
open fun sample(sampleSize: Int): DoubleArray

Generates a random generated sample of the give size

override fun sample(): Double
Link copied to clipboard
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

Link copied to clipboard
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

Link copied to clipboard
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

Link copied to clipboard
open fun sum(numInSum: Int): Double
Link copied to clipboard
open operator fun times(x: Double): RVariableIfc
open operator fun times(other: RVariableIfc): RVariableIfc
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open fun useStreamNumber(streamNumber: Int)

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

Link copied to clipboard
open override fun value(): Double

The randomly generated value. Each value will be different