## Libraries.Compute.Statistics.Calculations.CalculateRanks Documentation

This class calculates, for each data point in a column, the overall rank that item has in the data set.

Example Code

``````use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Calculations.CalculateRanks

DataFrame frame
CalculateRanks ranks
DataFrameColumn column = frame:GetColumn(0)
column:Calculate(ranks)

output ranks:GetRanks():ToText()
``````

## Actions Documentation

The type doesn't happen to matter for this kind of operation

#### Parameters

get the item and its index

#### Parameters

The type doesn't happen to matter for this kind of operation

#### Parameters

iterate first to last and set to the min, max, or average

#### Parameters

this is the first tie, otherwise keep going

### 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.

### 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.

#### 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)
``````

### Empty()

This Calculation can be re-used if the Empty action is called before passing it to another column. Otherwise, it retains its data.

### Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

#### 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)
``````

boolean

### GetFirstRank()

This Calculation can be re-used if the Empty action is called before passing it to another column. Otherwise, it retains its data.

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

### GetRanks()

This action returns the final result of the operation.

boolean

### IsAverageTies()

This action returns the final result of the operation.

boolean:

### 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.

boolean:

boolean

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.

boolean:

### SetCompareValues(boolean compareValues)

#### Parameters

• boolean compareValues

### SetFirstRank(integer firstRank)

#### Parameters

• integer firstRank

### SetSortSmallToLarge(boolean sortSmallToLarge)

#### Parameters

• boolean sortSmallToLarge