Libraries.Compute.Statistics.Charts.ColumnToTextArray Documentation
Inherits from: Libraries.Language.Object, Libraries.Compute.Statistics.DataFrameColumnCalculation
Summary
Actions Summary Table
Actions | Description |
---|---|
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) | |
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() | |
End(Libraries.Compute.Statistics.DataFrameColumn column) | This action is called at the end of a calculation. |
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. |
GetItems() | |
IsIterable() | If this action returns true, each element of the column will be sent to this calculation one by one. |
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. |
Start(Libraries.Compute.Statistics.DataFrameColumn column) | This action is called at the start of a calculation and passes the column that will be computed upon, so that the calculation can obtain any information it needs from the 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 types.
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 column.
Parameters
Add(Libraries.Language.Types.Number value)
Parameters
Add(Libraries.Language.Types.Text value)
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 instead.
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.
Empty()
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.
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.
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.
GetItems()
Return
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 action.
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)
This action is called at the start of a calculation and passes the column that will be computed upon, so that the calculation can obtain any information it needs from the column.