## 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
//Load a comma separated file
DataFrame frame
frame:Load("Data.csv")
CalculateRanks ranks
DataFrameColumn column = frame:GetColumn(0)
column:Calculate(ranks)
output ranks:GetRanks():ToText()
```

*Inherits from: *Libraries.Language.Object, Libraries.Compute.Statistics.DataFrameColumnCalculation

## Summary

### Actions Summary Table

Actions | Description |
---|---|

Add(Libraries.Language.Types.Integer value) | The type doesn't happen to matter for this kind of operati |

Add(Libraries.Language.Types.Boolean value) | get the item and its ind |

Add(Libraries.Language.Types.Number value) | The type doesn't happen to matter for this kind of operati |

Add(Libraries.Language.Types.Text value) | iterate first to last and set to the min, max, or avera |

Add(Libraries.Language.Object value) | this is the first tie, otherwise keep goi |

AverageTies() | |

Calculate(Libraries.Compute.Statistics.DataFrameColumn column) | This action can calculate the equation from a particular column. |

Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |

Empty() | This Calculation can be re-used if the Empty action is called before passing it to another column. |

End(Libraries.Compute.Statistics.DataFrameColumn column) | |

Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |

GetCompareValues() | |

GetFirstRank() | This Calculation can be re-used if the Empty action is called before passing it to another column. |

GetHashCode() | This action gets the hash code for an object. |

GetRanks() | This action returns the final result of the operation. |

GetSortSmallToLarge() | |

IsAverageTies() | This action returns the final result of the operation. |

IsIterable() | If this action returns true, each element of the column will be sent to this calculation one by one. |

IsMaximumTies() | |

IsMinimumTies() | |

MaximumTies() | |

MinimumTies() | |

SetCompareValues(boolean compareValues) | |

SetFirstRank(integer firstRank) | |

SetSortSmallToLarge(boolean sortSmallToLarge) | |

Start(Libraries.Compute.Statistics.DataFrameColumn column) |

## Actions Documentation

### Add(Libraries.Language.Types.Integer value)

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

#### Parameters

### Add(Libraries.Language.Types.Boolean value)

get the item and its ind

#### Parameters

### Add(Libraries.Language.Types.Number value)

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

#### Parameters

### Add(Libraries.Language.Types.Text value)

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

#### Parameters

### Add(Libraries.Language.Object value)

this is the first tie, otherwise keep goi

#### Parameters

### AverageTies()

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

#### Parameters

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

- Libraries.Language.Object: The object to compare to.

#### Return

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

### Empty()

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

### End(Libraries.Compute.Statistics.DataFrameColumn column)

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

- Libraries.Language.Object: The to be compared.

#### Return

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

### GetCompareValues()

#### Return

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.

#### Return

integer:

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

### GetRanks()

This action returns the final result of the operation.

#### Return

Libraries.Compute.Statistics.DataFrameColumn:

### GetSortSmallToLarge()

#### Return

boolean

### IsAverageTies()

This action returns the final result of the operation.

#### Return

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.

#### Return

boolean:

### IsMaximumTies()

#### Return

boolean

### IsMinimumTies()

#### Return

boolean