KSLCore/ksl.utilities.distributions/ShiftedContinuousDistribution

ShiftedContinuousDistribution

class ShiftedContinuousDistribution(theShift: Double, distribution: ContinuousDistributionIfc, name: String? = null) : Distribution, ContinuousDistributionIfc(source)

This class models a continuous distribution that has been shifted by a positive constant.

Parameters

theShift

the shift parameter. It must be greater than or equal to 0.0

distribution

the distribution to be shifted.

name

an optional name for the distribution

Constructors

Link copied to clipboard
constructor(theShift: Double, distribution: ContinuousDistributionIfc, 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 domain(): Interval
Link copied to clipboard
open override fun instance(): ContinuousDistributionIfc
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 pdf(x: Double): Double

Returns the f(x) where f represents the probability density function for the distribution. Note this is not a probability.

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
open override fun toString(): String
Link copied to clipboard
open override fun variance(): Double

Returns the variance of the distribution if defined