Libraries.Compute.Statistics.Calculations.InterQuartileRange Documentation

This class calculates the mean of a particular DataFrameColumn.

Example Code

use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Calculations.InterQuartileRange

//Load a comma separated file
DataFrame frame
frame:Load("Data.csv") 
InterQuartileRange iqr
DataFrameColumn column = frame:GetColumn(0)
column:Calculate(iqr)
number result = iqr:GetInterQuartileRange()
output result

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

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 types.

Parameters

Add(Libraries.Language.Types.Integer value)

If the calculation returns true from IsIterable, this is an Integer 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 column.

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 column.

Parameters

Add(Libraries.Language.Types.Number value)

If the calculation returns true from IsIterable, this is a Number 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 column.

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 column.

Parameters

Calculate(Libraries.Compute.Statistics.DataFrameColumn column)

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.

Parameters

Return

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

Example

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

Empty()

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

End(Libraries.Compute.Statistics.DataFrameColumn column)

This action is called at the end of a calculation.

Parameters

Equals(Libraries.Language.Object object)

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

Parameters

Return

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

Example

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

GetBottomMedian()

Returns the median in the bottom half of the column.

Return

number: the median in the bottom half

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetInterQuartileRange()

Returns the interquartile range, which is the top median - the bottom median.

Return

number: the interquartile range.

GetMaximum()

Returns the max value in the data set.

Return

number: the max value

GetMedian()

Returns the median for the column.

Return

number: the median

GetMinimum()

Returns the min value in the data set.

Return

number: the min value

GetSize()

Returns the sample size for the column.

Return

integer: the sample size

GetTopMedian()

Returns the median in the top half of the column.

Return

number: the median in the top half

IsIterable()

Return

boolean

IsNumerical()

If this action returns true, the calculation is numerical, the column must be numerical If this is false, the calculation should be non-numerical, thus the column will not be required to be a numerical column action.

Return

boolean:

Start(Libraries.Compute.Statistics.DataFrameColumn column)

Parameters