R1.2.2

KSLCore/ksl.utilities.distributions/Triangular

Triangular

class Triangular(theMin: Double = 0.0, theMode: Double = 0.0, theMax: Double = 1.0, name: String? = null) : Distribution, ContinuousDistributionIfc, GetRVariableIfc, RVParametersTypeIfc, MomentsIfc(source)

Represents the Triangular distribution with parameters - minimum value, maximum value and most likely value

Parameters

theMin

The minimum value of the distribution

theMode

The mode of the distribution

theMax

The maximum value of the distribution

name

an optional label/name

Constructors

constructor(parameters: DoubleArray)

Constructs a Triangular distribution with min = parameters0, mode = parameters1, max = parameters2

constructor(theMin: Double = 0.0, theMode: Double = 0.0, theMax: Double = 1.0, name: String? = null)

Types

object Companion

Properties

open override val kurtosis: Double

Gets the kurtosis of the distribution mu4/mu2^2, www.mathworld.wolfram.com/Kurtosis.html www.mathworld.wolfram.com/TriangularDistribution.html

var maximum: Double

myMax the maximum value of the distribution

open override val mean: Double

var minimum: Double

myMin the minimum value of the distribution

var mode: Double

myMax the maximum value of the distribution

val moment3: Double

val moment4: Double

val range: Double

myRange = myMax - myMin

open override val skewness: Double

Gets the skewness of the distribution mu3/mu2^(3/2), www.mathworld.wolfram.com/Skewness.html www.mathworld.wolfram.com/TriangularDistribution.html

open override val variance: Double

Functions

open override fun cdf(x: Double): Double

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

open override fun domain(): Interval

open override fun instance(): Triangular

open override fun invCDF(p: Double): Double

Provides the inverse cumulative distribution function for the distribution

open override fun logLikelihood(x: Double): Double

Computes the natural log of the pdf function evaluated at x. Implementations may want to specify computationally efficient formulas for this function.

open override fun mean(): Double

Returns the mean or expected value of a distribution

open override fun parameters(): DoubleArray

Gets the parameters for the distribution params0 min The minimum value of the distribution params1 mode The mode of the distribution params2 max The maximum value of the distribution

open override fun parameters(params: DoubleArray)

Sets the parameters for the distribution params0 min The minimum value of the distribution params1 mode The mode of the distribution params2 max The maximum value of the distribution

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.

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

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

fun setParameters(min: Double, mode: Double, max: Double)

Sets the minimum, most likely and maximum value of the triangular distribution to the private data members myMin, myMode and myMax resp throws IllegalArgumentException when the min >mode, min >= max, mode > max

open override fun toString(): String

open override fun variance(): Double

Returns the variance of the distribution if defined