Libraries.Compute.Statistics.Reporting.CompareGroupsResult

Libraries.Compute.Statistics.Reporting.CompareGroupsResult Documentation

This class represents data that comes back from a correlation.

Inherits from: Libraries.Compute.Statistics.Inputs.ColumnInput, Libraries.Language.Object

Summary

Actions Summary Table

Actions	Description
AddColumn(integer column)	This action adds a value to the end of the input.
Compare(Libraries.Language.Object object)	This action compares two object hash codes and returns an integer.
EmptyColumns()	This action empty's the list, clearing out all of the items contained within it.
Equals(Libraries.Language.Object object)	This action determines if two objects are equal based on their hash code values.
GetColumn(integer index)	This action gets the item at a given location in an array.
GetColumnIterator()	This action gets an iterator for the object and returns that iterator.
GetColumnSize()	This action gets the size of the array.
GetCriticalValue()	This indicates the critical value for any statistical test that was run
GetEffectSize()	Sets the name of the test in formal mathematical language.
GetEffectSizeName()	This sets the critical value for any statistical test that was run
GetFormalTestName()	Returns the name of the test in formal mathematical language.
GetHashCode()	This action gets the hash code for an object.
GetProbabilityValue()	Obtains the probability value (p in statistics) calculated by the test.
IsEmptyColumns()	This action returns a boolean value, true if the container is empty and false if it contains any items.
RemoveColumn(integer column)	This action removes the first occurrence of an item that is found in the Addable object.
RemoveColumnAt(integer index)	This action removes an item from an indexed object and returns that item.
SetCriticalValue(number criticalValue)	This sets the critical value for any statistical test that was run
SetEffectSize(number effectSize)	Returns the name of the test in formal mathematical language.
SetEffectSizeName(text effectSizeName)	This indicates the critical value for any statistical test that was run
SetFormalTestName(text formalTestName)	Sets the name of the test in formal mathematical language.
SetProbabilityValue(number probabilityValue)	Sets the probability value (p in statistics) calculated by the test.

Actions Documentation

AddColumn(integer column)

This action adds a value to the end of the input.

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 (smaller)

Parameters

Libraries.Language.Object: The object to compare to.

Return

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

EmptyColumns()

This action empty's the list, clearing out all of the items contained within it.

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

Libraries.Language.Object: The to be compared.

Return

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

GetColumn(integer index)

This action gets the item at a given location in an array.

Parameters

Return

integer: The item at the given location.

GetColumnIterator()

This action gets an iterator for the object and returns that iterator.

Return

Libraries.Containers.Iterator: Returns the iterator for an object.

GetColumnSize()

This action gets the size of the array.

Return

integer:

GetCriticalValue()

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

Return

number: the critical value

GetEffectSize()

Sets the name of the test in formal mathematical language.

Return

number:

GetEffectSizeName()

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

Return

text:

GetFormalTestName()

Returns the name of the test in formal mathematical language.

Return

text: the name of the test in mathematical language.

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.

GetProbabilityValue()

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

Return

number: the probability

IsEmptyColumns()

This action returns a boolean value, true if the container is empty and false if it contains any items.

Return

boolean: Returns true when the container is empty and false when it is not.

RemoveColumn(integer column)

This action removes the first occurrence of an item that is found in the Addable object.