Libraries.Compute.Statistics.Columns.TextColumn Documentation

TextColumn is a DataFrameColumn that contains Number objects. These objects can be undefined or not.

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

Summary

Actions Summary Table

ActionsDescription
Add(text value)
Calculate(Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)This action conducts a calculation on this column.
CanConvertToVector()This action returns whether or not this column type can be converted to a Vector of numbers.
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
ConvertToVector()Some column types can be converted to a raw vector of numbers.
Copy()
Copy(integer rowStart, integer rowEnd)
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Get(integer row)
GetAsNumber(integer index)Regardless of the type of the column, this action attempts to convert the item at the index to a number.
GetHashCode()This action gets the hash code for an object.
GetHeader()This gets the header for this column.
GetSize()
SendValueTo(integer index, Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)
SetHeader(text header)This sets the header for this column.
Swap(integer left, integer right)

Actions Documentation

Add(text value)

Parameters

Calculate(Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)

This action conducts a calculation on this column. The calculation begins by issuing a Start action. Then if it is an iterable action, sends each data point to the class for processing. If not, it is asked to conduct the entire operation at once on the full data set. Finally, it issues an end action.

Parameters

CanConvertToVector()

This action returns whether or not this column type can be converted to a Vector of numbers.

Return

boolean:

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

Return

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

ConvertToVector()

Some column types can be converted to a raw vector of numbers. All other column types throw an error if they cannot convert.

Return

Libraries.Compute.Vector:

Copy()

Return

Libraries.Compute.Statistics.DataFrameColumn

Copy(integer rowStart, integer rowEnd)

Parameters

Return

Libraries.Compute.Statistics.DataFrameColumn

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

Return

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

Get(integer row)

Parameters

Return

Libraries.Language.Types.Text

GetAsNumber(integer index)

Regardless of the type of the column, this action attempts to convert the item at the index to a number. Attrribute: Parameter index the item to be converted

Parameters

Return

number:

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.

GetHeader()

This gets the header for this column.

Return

text:

GetSize()

Return

integer

SendValueTo(integer index, Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)

Parameters

SetHeader(text header)

This sets the header for this column.

Parameters

Swap(integer left, integer right)

Parameters