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.
CalculateValueCount()
CalculateValueCountAsText()This action returns a HashTable with AsText key values and counts of the items in the 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.
ConvertToBooleanColumn()Regardless of the type of this column, the system will attempt to convert it to a BooleanColumn.
ConvertToIntegerColumn()Regardless of the type of this column, the system will attempt to convert it to an IntegerColumn.
ConvertToNumberColumn()Regardless of the type of this column, the system will attempt to convert it to a NumberColumn.
ConvertToTextColumn()Regardless of the type of this column, the system will attempt to convert it to a TextColumn.
ConvertToVector()Some column types can be converted to a raw vector of numbers.
Copy(integer rowStart, integer rowEnd, boolean sort, boolean unique)
Copy()
Copy(boolean sort, boolean unique)
Copy(integer rowStart, integer rowEnd)
CopyToColumns(boolean sort, boolean unique)
CopyToRow(Libraries.Compute.Statistics.DataFrameColumn column, integer to, integer from)
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Get(integer row)
GetAsBoolean(integer index)Regardless of the type of the column, this action attempts to convert the item at the index to a boolean.
GetAsInteger(integer index)Regardless of the type of the column, this action attempts to convert the item at the index to an integer.
GetAsNumber(integer index)Regardless of the type of the column, this action attempts to convert the item at the index to a number.
GetAsText(integer index)
GetHashCode()This action gets the hash code for an object.
GetHeader()This gets the header for this column.
GetSize()
GetUndefinedSize()This action returns the number of items in this column that are undefined.
GetUndefinedText()This action returns a default text string for undefined values.
GetUnique()
IsBooleanColumn()This action detects whether this column ultimately stores booleans inside of it.
IsIntegerColumn()This action detects whether this column ultimately stores integers inside of it.
IsNumberColumn()This action detects whether this column ultimately stores numbers inside of it.
IsTextColumn()
IsUndefined(integer row)
Move(integer left, integer right)
SendValueTo(integer index, Libraries.Compute.Statistics.DataFrameColumnCalculation calculation)
SetAsBoolean(integer index, boolean value)This action sets the index to a boolean if and only if this is a boolean column.
SetAsInteger(integer index, integer value)This action sets the index to an integer if and only if this is an integer column.
SetAsNumber(integer index, number value)This action sets the index to a number if and only if this is a number column.
SetAsText(integer index, Libraries.Language.Types.Text value)
SetAsText(integer index, text value)
SetHeader(text header)This sets the header for this column.
SetSize(integer size)
Swap(integer left, integer right)
ToText()

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

CalculateValueCount()

Return

Libraries.Containers.HashTable

CalculateValueCountAsText()

This action returns a HashTable with AsText key values and counts of the items in the column.

Return

Libraries.Containers.HashTable: a HashTable with the count for each item in the column.

CanConvertToVector()

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

Return

boolean: true if this column type can be converted and false if it would throw an error on conversion.

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.

ConvertToBooleanColumn()

Regardless of the type of this column, the system will attempt to convert it to a BooleanColumn. This may cause an error to be thrown if the types are not compatible. Attrribute: Returns the newly converted column

Return

Libraries.Compute.Statistics.Columns.BooleanColumn:

ConvertToIntegerColumn()

Regardless of the type of this column, the system will attempt to convert it to an IntegerColumn. This may cause an error to be thrown if the types are not compatible. Attrribute: Returns the newly converted column

Return

Libraries.Compute.Statistics.Columns.IntegerColumn:

ConvertToNumberColumn()

Regardless of the type of this column, the system will attempt to convert it to a NumberColumn. This may cause an error to be thrown if the types are not compatible. Attrribute: Returns the newly converted column

Return

Libraries.Compute.Statistics.Columns.NumberColumn:

ConvertToTextColumn()

Regardless of the type of this column, the system will attempt to convert it to a TextColumn. This may cause an error to be thrown if the types are not compatible. Attrribute: Returns the newly converted column

Return

Libraries.Compute.Statistics.Columns.TextColumn:

ConvertToVector()

Some column types can be converted to a raw vector of numbers. All other column types throw an error if they cannot convert. This vector conversion stores numbers more tightly in primitive form, so no undefined values are allowed, but the system can process on the vector more quickly and efficiently.

Return

Libraries.Compute.Vector: the vector

Copy(integer rowStart, integer rowEnd, boolean sort, boolean unique)

Parameters

Return

Libraries.Compute.Statistics.DataFrameColumn

Copy()

Return

Libraries.Compute.Statistics.DataFrameColumn

Copy(boolean sort, boolean unique)

Parameters

Return

Libraries.Compute.Statistics.DataFrameColumn

Copy(integer rowStart, integer rowEnd)

Parameters

Return

Libraries.Compute.Statistics.DataFrameColumn

CopyToColumns(boolean sort, boolean unique)

Parameters

Return

Libraries.Containers.Array

CopyToRow(Libraries.Compute.Statistics.DataFrameColumn column, integer to, integer from)

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

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

GetAsBoolean(integer index)

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

Parameters

Return

boolean:

GetAsInteger(integer index)

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

Parameters

Return

integer:

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:

GetAsText(integer index)

Parameters

Return

text

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

GetUndefinedSize()

This action returns the number of items in this column that are undefined.

Return

integer: the number of items that are not defined

GetUndefinedText()

This action returns a default text string for undefined values.

Return

text:

GetUnique()

Return

Libraries.Containers.Array

IsBooleanColumn()

This action detects whether this column ultimately stores booleans inside of it. This type of information is implementation dependent, as arbitrary columns can store these values however they see fit.

Return

boolean: true if this column stores booleans

IsIntegerColumn()

This action detects whether this column ultimately stores integers inside of it. This type of information is implementation dependent, as arbitrary columns can store these values however they see fit.

Return

boolean: true if this column stores integers

IsNumberColumn()

This action detects whether this column ultimately stores numbers inside of it. This type of information is implementation dependent, as arbitrary columns can store these numbers however they see fit.

Return

boolean: true if this column stores numbers

IsTextColumn()

Return

boolean

IsUndefined(integer row)

Parameters

Return

boolean

Move(integer left, integer right)

Parameters

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

Parameters

SetAsBoolean(integer index, boolean value)

This action sets the index to a boolean if and only if this is a boolean column. Attrribute: Parameter index the item to be converted

Parameters

SetAsInteger(integer index, integer value)

This action sets the index to an integer if and only if this is an integer column. Attrribute: Parameter index the item to be converted

Parameters

SetAsNumber(integer index, number value)

This action sets the index to a number if and only if this is a number column. Attrribute: Parameter index the item to be converted

Parameters

SetAsText(integer index, Libraries.Language.Types.Text value)

Parameters

SetAsText(integer index, text value)

Parameters

SetHeader(text header)

This sets the header for this column.

Parameters

SetSize(integer size)

Parameters

Swap(integer left, integer right)

Parameters

ToText()

Return

text