Libraries.Compute.Statistics.Inputs.CellInput Documentation

There are many ways in which a statistical test, transform, or calculation could potentially get data from a DataFrame. The Inputs package lists any of these ways. ColumnInput specifically is stating that a particular class expects the data in a data frame to be a set of entire columns. The values are listed as integers and this means the column indices inside the DataFrame. For example, a correlation might expect we are comparing columns 1 and 3 or perhaps 3 or more columns in their entirety. Anything that implements this class must be able to account for the full range of this input when it does its calculations.

Inherits from: Libraries.Language.Object

Actions Documentation

AddCell(Libraries.Containers.Support.Pair<integer> cell)

This action adds a value to the end of the input.

Parameters

AddCell(integer x, integer y)

This action adds a value to the end of the input.

Parameters

  • integer x: The x value of the cell.
  • integer y: The y value of the cell.

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)

EmptyCells()

This action empty's the list, clearing out all of the items contained within it.

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)

GetCell(integer index)

This action gets the item at a given location in an array.

Parameters

  • integer index

Return

Libraries.Containers.Support.Pair: The item at the given location.

GetCellIterator()

This action gets an iterator for the object and returns that iterator.

Return

Libraries.Containers.Iterator: Returns the iterator for an object.

GetCellSize()

This action gets the size of the array.

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

IsEmptyCells()

This action returns a boolean value, true if the container is empty and false if it contains any items.

Return

boolean: Returns true when the container is empty and false when it is not.

RemoveCell(Libraries.Containers.Support.Pair<integer> index)

This action removes the first occurrence of an item that is found in the Addable object.

Parameters

Return

boolean: Returns true if the item was removed and false if it was not removed.

RemoveCellAt(integer index)

This action removes an item from an indexed object and returns that item.

Parameters

  • integer index