KSLCore/ksl.utilities.distributions/Constant

Constant

class Constant(var value: Double = 0.0, name: String? = null) : Distribution, DiscreteDistributionIfc, GetRVariableIfc, RVParametersTypeIfc(source)

Constructs a degenerate distribution with all probability at the provided point. Once made the value of the constant cannot be changed.

Construct a constant using the supplied value

Parameters

value

the value for the constant

name

a string name/label

Constructors

Constant

constructor(parameters: DoubleArray, name: String? = null)

constructor(value: Double = 0.0, name: String? = null)

Types

Companion

object Companion

Properties

value

var value: Double

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(): Constant

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

open override fun parameters(params: DoubleArray)

Sets the parameters

pmf

open override fun pmf(x: Double): Double

If x is not an integer value, then the probability must be zero otherwise pmf(int x) is used to determine the probability

open override fun pmf(i: Int): Double

Returns the f(i) where f represents the probability mass function for the distribution.

randomVariable

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

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

toString

open override fun toString(): String

variance

open override fun variance(): Double

Returns the variance of the distribution if defined