Metalog4P

class Metalog4P(a1: Double = 0.0, a2: Double = 1.0, a3: Double = 0.0, a4: Double = 0.0, lowerBound: Double = Double.NEGATIVE_INFINITY, upperBound: Double = Double.POSITIVE_INFINITY, name: String? = null) : MetalogDistribution, RVParametersTypeIfc(source)

A four-term metalog distribution.

The fourth coefficient primarily controls kurtosis. Raising it from zero makes the distribution fatter through its midrange with correspondingly lighter tails, closer to a normal or a symmetric beta than to a logistic; lowering it below zero narrows the midrange and thickens the tails, closer to a Student t with few degrees of freedom.

Two special cases are exact rather than approximate. With the second and third coefficients zero and the fourth positive, the distribution is uniform on the interval of width equal to the fourth coefficient centered on the first. With the third coefficient zero and both the second and fourth positive, it is a mixture of a logistic and a uniform sharing that mean.

Parameters

a1

the location coefficient

a2

the scale coefficient, which must remain strictly positive

a3

the skewness coefficient

a4

the kurtosis coefficient

lowerBound

the lower bound, or negative infinity when unbounded below

upperBound

the upper bound, or positive infinity when unbounded above

name

an optional name

Constructors

Link copied to clipboard
constructor(a1: Double = 0.0, a2: Double = 1.0, a3: Double = 0.0, a4: Double = 0.0, lowerBound: Double = Double.NEGATIVE_INFINITY, upperBound: Double = Double.POSITIVE_INFINITY, name: String? = null)

Properties

Link copied to clipboard
var a1: Double

The location coefficient.

Link copied to clipboard
var a2: Double

The scale coefficient, which must remain strictly positive.

Link copied to clipboard
var a3: Double

The skewness coefficient.

Link copied to clipboard
var a4: Double

The kurtosis coefficient.

Functions

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

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