Libraries.Compute.Statistics.Columns.AudioColumn Documentation

AudioColumn is a DataFrameColumn that contains number objects. The AudioColumn must have an AudioSamples object manually loaded into it. Because this column contains AudioSamples objects, which must contain samples at each point, no row can be possibly be undefined. The same representation can be used for multi-channel audio, by setting the channel per column.

Inherits from: Libraries.Compute.Statistics.DataFrameColumn, Libraries.Containers.Support.Comparison, Libraries.Language.Object

Actions Documentation

Add(text value)

Columns may optionally add data from a text representation of that data. This can be in any arbitrary format determined by the column implementor. The Add action does the auto-conversion, while the set values are only accepted if that data type is allowed. The broad purpose is to allow this action to read in from an arbitrary text source and add it to the column.

Parameters

  • text value: The value to be converted to the proper type for this kind of column.

AddAsResult(Libraries.Language.Compile.Interpreter.Result value)

Columns may optionally add data from the Runtime system. In this case, columns may optionally choose to accept or reject a particular Libraries.Language.Compile.Interpreter.Result based on type. If the column is rejected, an undefined value is placed at the new position. The Result object must have a corresponding Libraries.Language.Compile.Symbol.Type.

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

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()

Return

boolean

Compare(boolean a, boolean b)

This action provides a way to compare two objects. The returned values from its sole action is an integer with the value of -1 (the left item is smaller), 0 (the items are equal) or 1 (the left item is larger).It can be used to override the standard comparison in Object for various applications (e.g., sorting). In the case of booleans, by default, false is considered less than true.

Parameters

  • boolean a
  • boolean b

Return

integer:

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)

Compare(number a, number b)

This action provides a way to compare two objects. The returned values from its sole action is an integer with the value of -1 (the left item is smaller), 0 (the items are equal) or 1 (the left item is larger).It can be used to override the standard comparison in Object for various applications (e.g., sorting).

Parameters

  • number a
  • number b

Return

integer:

Compare(integer a, integer b)

This action provides a way to compare two objects. The returned values from its sole action is an integer with the value of -1 (the left item is smaller), 0 (the items are equal) or 1 (the left item is larger).It can be used to override the standard comparison in Object for various applications (e.g., sorting).

Parameters

  • integer a
  • integer b

Return

integer:

Compare(Libraries.Language.Object a, Libraries.Language.Object b)

We can manually set a comparison, which is then passed to the default sorting routines if sorting occurs.

Parameters

Return

integer:

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:

ConvertToTextArray()

This action converts to a text array from the column.

Return

Libraries.Containers.Array: a version of the column as a text array.

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()

ConvertToVector(integer rowStart, integer rowEnd)

This action does a deep copy of the row between the 0-indexed rowStart and rowEnd.

Parameters

  • integer rowStart: the first row to copy
  • integer rowEnd: the last row to copy

Return

Libraries.Compute.Vector:

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

An AudioColumn uses an underlying AudioSamples object, which cannot have undefined items.

Parameters

  • integer rowStart
  • integer rowEnd
  • boolean sort
  • boolean unique

Return

Libraries.Compute.Statistics.DataFrameColumn:

Copy(boolean sort, boolean unique)

Parameters

  • boolean sort
  • boolean unique

Return

Libraries.Compute.Statistics.DataFrameColumn

Copy(integer rowStart, integer rowEnd)

This action does a deep copy of the row between the 0-indexed rowStart and rowEnd.

Parameters

  • integer rowStart: the first row to copy
  • integer rowEnd: the last row to copy

Return

Libraries.Compute.Statistics.DataFrameColumn:

CopyEmpty()

This action copies the type of the data frame, but does not copy over its rows. The header name is retained.

Return

Libraries.Compute.Statistics.DataFrameColumn: the column of the appropriate type but without the data.

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.

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)

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

  • integer index

Return

boolean:

GetAsDateTime(integer index)

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

Parameters

  • integer index

Return

Libraries.System.DateTime:

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

  • integer index

Return

integer:

GetAsNumber(integer index)

Parameters

  • integer index

Return

number

GetAsText(integer index)

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

Parameters

  • integer index

Return

text:

GetChannel()

Return

integer

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()

GetHeader()

This gets the header for this column.

Return

text:

GetSize()

Return

integer

GetSortComparison()

We can get the comparison used by the sorting routines. By default, this is undefined. When undefined, alphabetical sorting is used.

Return

Libraries.Containers.Support.Comparison:

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:

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

IsDateTimeColumn()

This action detects whether this column ultimately stores dates/times 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 dates/times

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()

Return

boolean

IsResultCheckable(Libraries.Language.Compile.Interpreter.Result value)

Returns whether or not the result is checkable inside sub-types.This action generally should not be used.

Parameters

Return

boolean: whether or not it is valid

IsTextColumn()

This action detects whether this column ultimately stores text 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 text

IsUndefined()

This action returns a boolean on if the column is undefined.

Return

boolean: true if the undefined size is equal to the size. Meaning every row is undefined.

IsUndefined(integer row)

An AudioColumn uses an underlying AudioSamples object, which cannot have undefined items.

Parameters

  • integer row

Return

boolean:

Move(integer left, integer right)

This action moves the value in row left to the value in row right.

Parameters

  • integer left: the first index to swap
  • integer right: the second index to swap

ReplaceUndefined(text value)

If the column has undefined values, this action replaces all rows that have undefined with a value selected from text. If the text value is invalid for this column, the call is ignored.

Parameters

  • text value: The value to be replaced.

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. Attrribute: Parameter index the item to be converted

Parameters

  • integer index
  • boolean value: the value to be placed in the column

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

  • integer index
  • integer value: the value to be placed in the column

SetAsNumber(integer index, number value)

Parameters

  • integer index
  • number value

SetAsResult(integer index, Libraries.Language.Compile.Interpreter.Result value)

This action sets the index to Libraries.Language.Compile.Interpreter.Result if and only if the column accepts values of this type. If it does not, undefined is placed at this index. Attrribute: Parameter index the item to be converted

Parameters

SetAsText(integer index, text value)

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

Parameters

  • integer index
  • text value: the value to be placed in the column

SetChannel(integer channel)

Parameters

  • integer channel

SetHeader(text header)

This sets the header for this column.

Parameters

  • text header

SetSamples(Libraries.Sound.AudioSamples samples)