Expr.rank

methodView source ↗

def rank(
    method: td_RankMethod = 'average',
    descending: bool = False,
    seed: int | None = None,
) -> Expr

Categories: aggregation

Compute the rank of the element values. Multiple rank types are available.

Parameters

parameter

method

the ranking type: 'average' (default), 'dense', 'max', 'min', 'ordinal' or 'random'.

parameter

descending

if the order is ascending (default) or descending.

parameter

seed

random seed when using 'random' rank type.

Examples

>>> import tabsdata as td
>>>
>>> tf: td.TableFrame ...
>>>
>>> tf.select(td.col("val"), td.col("val").rank("max").alias("rank"))
>>>
┌──────┬──────┐
│ val  ┆ rank │
│ ---  ┆ ---  │
│ f64  ┆ u32  │
╞══════╪══════╡
│ -1.0 ┆ 1    │
│ 0.0  ┆ 2    │
│ 1.1  ┆ 3    │
│ 2.0  ┆ 4    │
│ inf  ┆ 5    │
│ null ┆ null │
│ NaN  ┆ 6    │
└──────┴──────┘