KSLCore/ksl.utilities.distributions.metalog

Package-level declarations

Types

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

A two-term metalog distribution.

Metalog3P

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

A three-term metalog distribution.

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

A four-term metalog distribution.

Metalog5P

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

A five-term metalog distribution.

Metalog6P

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

A six-term metalog distribution.

MetalogBoundedness

enum MetalogBoundedness : Enum<MetalogBoundedness>

Identifies which member of the metalog family a pair of bounds describes, and supplies the transformation between the metalog's fitting space and the random variable's space.

MetalogDistribution

abstract class MetalogDistribution(coefficients: DoubleArray, lowerBound: Double = Double.NEGATIVE_INFINITY, upperBound: Double = Double.POSITIVE_INFINITY, name: String? = null) : Distribution, ContinuousDistributionIfc, InverseCDFIfc, GetRVariableIfc, MomentsIfc

Shared behavior for the metalog distributions of Keelin (2016).

MetalogFeasibilityChecker

class MetalogFeasibilityChecker(val uniformStep: Double = DEFAULT_UNIFORM_STEP, val tailDecades: Int = DEFAULT_TAIL_DECADES)

Checks whether a metalog coefficient vector defines a valid quantile function.

MetalogFeasibilityResult

data class MetalogFeasibilityResult(val feasible: Boolean, val minimumDerivative: Double, val worstProbability: Double)

The outcome of a metalog feasibility check.

MetalogFunctions

object MetalogFunctions

The basis functions underlying the metalog quantile function of Keelin (2016).

MetalogMoments

object MetalogMoments

Moments of metalog distributions.