KSLCore/ksl.utilities.distributions/ShiftedDistribution

ShiftedDistribution

open class ShiftedDistribution(theDistribution: DistributionIfc, theShift: Double, name: String? = null) : Distribution(source)

Represents a Distribution that has been Shifted (translated to the right) The shift must be >= 0.0

Constructs a shifted distribution based on the provided distribution

Parameters

theDistribution

the distribution to shift

theShift

The linear shift

name

an optional name/label

Inheritors

Constructors

Link copied to clipboard
constructor(theDistribution: DistributionIfc, theShift: Double, name: String? = null)

Properties

Link copied to clipboard
var shift: Double

Functions

Link copied to clipboard
open override fun cdf(x: Double): Double

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

Link copied to clipboard
open override fun instance(): ShiftedDistribution
Link copied to clipboard
open override fun invCDF(p: Double): Double

Provides the inverse cumulative distribution function for the distribution

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

Returns the mean or expected value of a distribution

Link copied to clipboard
open override fun parameters(): DoubleArray

Gets the parameters for the shifted distribution shift = parameter0 The other elements of the returned array are the parameters of the underlying distribution

open override fun parameters(params: DoubleArray)

Sets the parameters of the shifted distribution shift = param0 If supplied, the other elements of the array are used in setting the parameters of the underlying distribution. If only the shift is supplied as a parameter, then the underlying distribution's parameters are not changed (and do not need to be supplied)

Link copied to clipboard
open override fun randomVariable(streamNumber: Int, streamProvider: RNStreamProviderIfc): RVariableIfc

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

Link copied to clipboard
fun setDistribution(distribution: DistributionIfc, shift: Double)

Changes the underlying distribution and the shift

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

Returns the variance of the distribution if defined