Libraries.Compute.Statistics.Calculations.Kurtosis Documentation

This class calculates the Kurtosis. The equations used for it were pulled from Apache Commons: https://commons.apache.org/proper/commons-math/javadocs/api-3.6/org/apache/commons/math3/stat/descriptive/moment/Kurtosis.html

Example Code

use Libraries.Compute.Statistics.DataFrame
    use Libraries.Compute.Statistics.Calculations.Skew

    //Load a comma separated file
    DataFrame frame
    frame:Load("Data.csv") 
    Kurtosis kurtosis
    DataFrameColumn column = frame:GetColumn(0)
    output column:Calculate(kurtosi

Inherits from: Libraries.Language.Object, Libraries.Compute.Statistics.DataFrameColumnCalculation

Summary

Actions Summary Table

ActionsDescription
Add(Libraries.Language.Object value)If the calculation otherwise has no primitive type, it sends it to the column as a raw object.
Add(Libraries.Language.Types.Integer value)
Add(Libraries.Language.Types.Boolean value)If the calculation returns true from IsIterable, this is a Boolean object that was passed to the calculation.
Add(Libraries.Language.Types.Number value)
Add(Libraries.Language.Types.Text value)If the calculation returns true from IsIterable, this is a Text object that was passed to the calculation.
Calculate(Libraries.Compute.Statistics.DataFrameColumn column)This action can calculate the equation from a particular column.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Empty()This Calculation can be re-used if the Empty action is called before passing it to another column.
End(Libraries.Compute.Statistics.DataFrameColumn column)
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetKurtosis()This action returns the Kurtosis that was calculate
IsIterable()If this action returns true, each element of the column will be sent to this calculation one by one.
Start(Libraries.Compute.Statistics.DataFrameColumn column)

Actions Documentation

Add(Libraries.Language.Object value)

If the calculation otherwise has no primitive type, it sends it to the column as a raw object. Columns might use this if they have custom type

Parameters

Add(Libraries.Language.Types.Integer value)

Parameters

Add(Libraries.Language.Types.Boolean value)

If the calculation returns true from IsIterable, this is a Boolean object that was passed to the calculation. This may be undefined, which indicates that the column did not contain a value at this position in the colum

Parameters

Add(Libraries.Language.Types.Number value)

Parameters

Add(Libraries.Language.Types.Text value)

If the calculation returns true from IsIterable, this is a Text object that was passed to the calculation. This may be undefined, which indicates that the column did not contain a value at this position in the colum

Parameters

Calculate(Libraries.Compute.Statistics.DataFrameColumn column)

This action can calculate the equation from a particular column. By default this action will only be called if the Calculation is not Iterable. Because the Column class is not guaranteed to have any particular data type, individual Calculation classes may need to cast to a particular column or data type to perform their operations. If a calculation is Iterable, the column will pass all of its data, one by one, to the calculation instea

Parameters

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 (smalle

Parameters

Return

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

Empty()

This Calculation can be re-used if the Empty action is called before passing it to another column. Otherwise, it retains its dat

End(Libraries.Compute.Statistics.DataFrameColumn column)

Parameters

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(

Parameters

Return

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

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.

GetKurtosis()

This action returns the Kurtosis that was calculate

Return

number:

IsIterable()

If this action returns true, each element of the column will be sent to this calculation one by one. If this is false, the column should ask this class to conduct the calculation all at once using the Calculate actio

Return

boolean:

Start(Libraries.Compute.Statistics.DataFrameColumn column)

Parameters