KSLCore/ksl.utilities.distributions/DUniform

DUniform

class DUniform(min: Int = 0, max: Int = 1, name: String? = null) : Distribution, DiscreteDistributionIfc, RVParametersTypeIfc(source)

Models discrete random variables that are uniformly distributed over a contiguous range of integers. the lower limit must be < upper limit

Parameters

min

The lower limit of the range

max

The upper limit of the range

name

an optional name/label

Constructors

DUniform

constructor(parameters: DoubleArray)

Constructs a discrete uniform where parameter0 is the lower limit and parameter1 is the upper limit of the range. the lower limit must be < upper limit

constructor(range: IntRange)

constructor(min: Int = 0, max: Int = 1, name: String? = null)

Properties

maximum

var maximum: Int

The distribution's upper limit

minimum

var minimum: Int

The distribution's lower limit

range

val range: Int

The discrete maximum - minimum + 1

Functions

cdf

open override fun cdf(x: Double): Double

Returns the F(x) = Pr{X <= x} where F represents the cumulative distribution function

instance

open override fun instance(): DUniform

invCDF

open override fun invCDF(p: Double): Double

Provides the inverse cumulative distribution function for the distribution

mean

open override fun mean(): Double

Returns the mean or expected value of a distribution

parameters

open override fun parameters(): DoubleArray

Gets the parameters for the distribution where parameters0 is the lower limit and parameters1 is the upper limit of the range.

open override fun parameters(params: DoubleArray)

Sets the parameters for the distribution where parameters0 is the lower limit and parameters1 is the upper limit of the range. the lower limit must be < upper limit

pmf

open override fun pmf(i: Int): Double

Returns the probability associated with x

randomVariable

open override fun randomVariable(streamNumber: Int, streamProvider: RNStreamProviderIfc): DUniformRV

Promises to return a random variable that uses the supplied stream number using the supplied stream provider

setRange

fun setRange(range: IntRange)

fun setRange(minimum: Int, maximum: Int)

Sets the range for the distribution the lower limit must be < upper limit

toString

open override fun toString(): String

variance

open override fun variance(): Double

Returns the variance of the distribution if defined