Libraries.Compute.Statistics.Reporting.CorrelateGroupsResult Documentation

This class represents data that comes back from a correlation.

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.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetCorrelation()Obtains the correlation calculated by the test.
GetCriticalValue()This indicates the critical value for any statistical test that was run
GetDegreesOfFreedom()Obtains the degrees of freedom value (df in statistics) calculated by the test.
GetHashCode()This action gets the hash code for an object.
GetLeftIndex()This indicates the left column index
GetProbabilityValue()Obtains the probability value (p in statistics) calculated by the test.
GetRightIndex()This indicates the right column index
SetCorrelation(number correlation)Sets the correlation calculated by the test.
SetCriticalValue(number criticalValue)This sets the critical value for any statistical test that was run
SetDegreesOfFreedom(number degreesOfFreedom)Sets the degrees of freedom value (df in statistics) calculated by the test.
SetLeftIndex(integer leftIndex)This sets the left column index
SetProbabilityValue(number probabilityValue)Sets the probability value (p in statistics) calculated by the test.
SetRightIndex(integer rightIndex)This sets the right column index

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

Parameters

Return

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

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.

GetCorrelation()

Obtains the correlation calculated by the test. This may be of any kind.

Return

number: the correlati

GetCriticalValue()

This indicates the critical value for any statistical test that was run

Return

number: the critical val

GetDegreesOfFreedom()

Obtains the degrees of freedom value (df in statistics) calculated by the test.

Return

number: the degrees of freed

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.

GetLeftIndex()

This indicates the left column index

Return

integer: the left ind

GetProbabilityValue()

Obtains the probability value (p in statistics) calculated by the test.

Return

number: the probabili

GetRightIndex()

This indicates the right column index

Return

integer: the right ind

SetCorrelation(number correlation)

Sets the correlation calculated by the test. This may be of any kind.

Parameters

SetCriticalValue(number criticalValue)

This sets the critical value for any statistical test that was run

Parameters

SetDegreesOfFreedom(number degreesOfFreedom)

Sets the degrees of freedom value (df in statistics) calculated by the test.

Parameters

SetLeftIndex(integer leftIndex)

This sets the left column index

Parameters

SetProbabilityValue(number probabilityValue)

Sets the probability value (p in statistics) calculated by the test.

Parameters

SetRightIndex(integer rightIndex)

This sets the right column index

Parameters