Libraries.Compute.Statistics.Distributions.TDistribution Documentation

This class, ported from Apache Commons, is an implementation of the T-Distribution. More information can be found here: https://en.wikipedia.org/wiki/Student%27s_t-distribution

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
CumulativeProbability(number x)
Density(number x)* {@inheritDoc}
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetDegreesOfFreedom()
GetHashCode()This action gets the hash code for an object.
GetNumericalMean()* * {@inheritDoc} * * For degrees of freedom parameter {@code df}, the mean is *
    *
  • if {@code df > 1} then {@code 0},
  • *
  • else undefined ({@code Double.
GetNumericalVariance()* * {@inheritDoc} * * For degrees of freedom parameter {@code df}, the variance is *
    *
  • if {@code df > 2} then {@code df / (df - 2)},
  • *
  • if {@code 1 < df <= 2} then positive infinity * ({@code Double.
GetSolverAbsoluteAccuracy()@Overri
GetSupportLowerBound()* * {@inheritDoc} * * The lower bound of the support is always negative infinity no matter the * parameters.
GetSupportUpperBound()* * {@inheritDoc} * * The upper bound of the support is always positive infinity no matter the * parameters.
IsSupportConnected()* * {@inheritDoc} * * The support of this distribution is connected.
IsSupportLowerBoundInclusive()* {@inheritDoc}
IsSupportUpperBoundInclusive()* {@inheritDoc}
LogDensity(number x)* {@inheritDoc}
Setup(number degreesOfFreedom)

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Example Code

Object o
        Object t
        integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

CumulativeProbability(number x)

Parameters

Return

number

Density(number x)

* {@inheritDoc}

Parameters

Return

number:

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetDegreesOfFreedom()

Return

number

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetNumericalMean()

* * {@inheritDoc} * * For degrees of freedom parameter {@code df}, the mean is *

    *
  • if {@code df > 1} then {@code 0},
  • *
  • else undefined ({@code Double.NaN}).
  • *

Return

number:

GetNumericalVariance()

* * {@inheritDoc} * * For degrees of freedom parameter {@code df}, the variance is *

    *
  • if {@code df > 2} then {@code df / (df - 2)},
  • *
  • if {@code 1 < df <= 2} then positive infinity * ({@code Double.POSITIVE_INFINITY}),
  • *
  • else undefined ({@code Double.NaN}).
  • *

Return

number:

GetSolverAbsoluteAccuracy()

@Overri

Return

number:

GetSupportLowerBound()

* * {@inheritDoc} * * The lower bound of the support is always negative infinity no matter the * parameters. * * @return lower bound of the support (always * {@code Double.NEGATIVE_INFINITY})

Return

number:

GetSupportUpperBound()

* * {@inheritDoc} * * The upper bound of the support is always positive infinity no matter the * parameters. * * @return upper bound of the support (always * {@code Double.POSITIVE_INFINITY})

Return

number:

IsSupportConnected()

* * {@inheritDoc} * * The support of this distribution is connected. * * @return {@code true}

Return

boolean:

IsSupportLowerBoundInclusive()

* {@inheritDoc}

Return

boolean:

IsSupportUpperBoundInclusive()

* {@inheritDoc}

Return

boolean:

LogDensity(number x)

* {@inheritDoc}

Parameters

Return

number:

Setup(number degreesOfFreedom)

Parameters