Libraries.Compute.Statistics.Calculations.Summarize Documentation
This class calculates the mean of a particular DataFrameColumn.
Example Code
use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Calculations.Mean
//Load a comma separated file
DataFrame frame
frame:Load("Data.csv")
Mean mean
DataFrameColumn column = frame:GetColumn(0)
column:Calculate(mean)
number leftMean = mean:GetMean()
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)
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
- Libraries.Language.Object: The object to compare to.
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
- Libraries.Language.Object: The to be compared.
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)
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()
GetMaximum()
Return
number
GetMean()
This Calculation can be re-used if the Empty action is called before passing it to another column. Otherwise, it retains its data.
Return
number:
GetMedian()
Return
number
GetMinimum()
Return
number
GetSize()
Return
integer
GetSum()
Return
number
GetSumOfSquares()
Return
number
GetVariance()
Return
number
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)
On this page
Variables TableAction Documentation- Add(Libraries.Language.Object value)
- Add(Libraries.Language.Types.Integer value)
- Add(Libraries.Language.Types.Boolean value)
- Add(Libraries.Language.Types.Number value)
- Add(Libraries.Language.Types.Text value)
- Calculate(Libraries.Compute.Statistics.DataFrameColumn column)
- Compare(Libraries.Language.Object object)
- Empty()
- End(Libraries.Compute.Statistics.DataFrameColumn column)
- Equals(Libraries.Language.Object object)
- GetHashCode()
- GetMaximum()
- GetMean()
- GetMedian()
- GetMinimum()
- GetSize()
- GetSum()
- GetSumOfSquares()
- GetVariance()
- IsIterable()
- IsNumerical()
- Start(Libraries.Compute.Statistics.DataFrameColumn column)