Computes the rolling unique kth largest value forward or backward of the current row. |
For purposes of this calculation, two instances of the same value are treated at one value for k. So, if your dataset contains four rows with column values 10
, 9
, 9
, and 8
, then KTHLARGESTUNIQUE
returns 9
for k=2
and 8
for k=3
.
ROLLINGKTHLARGESTUNIQUE
computes the KTHLARGESTUNIQUE
value across a defined window of values within a column.
The row from which to extract a value is determined by the order in which the rows are organized based on the order
parameter.
If you are working on a randomly generated sample of your dataset, the values that you see for this function might not correspond to the values that are generated on the full dataset during job execution.
-1
and 0
, which computes the rolling function from the current row back to the first row of the dataset.For more information on a non-rolling version of this function, see KTHLARGESTUNIQUE Function.
Column example:
derive type:single value:ROLLINGKTHLARGESTUNIQUE(myCol, 2) |
Output: Generates a new column containing the rolling second largest unique value in the myCol
column from the first row of the dataset to the current one.
Rows before example:
window value:ROLLINGKTHLARGESTUNIQUE(myNumber, 2, 3) |
Output: Generates the new column, which contains the rolling second largest unique value of the current row and the two previous row values in the myNumber
column.
Rows before and after example:
window value:value:ROLLINGKTHLARGESTUNIQUE(myNumber, 4, 3, 2) |
Output: Generates the new column, which contains the rolling fourth largest unique value of the two previous row values, the current row value, and the two rows after the current one in the myNumber
column.
window value:value:ROLLINGKTHLARGESTUNIQUE(col_ref, rowsBefore_integer, rowsAfter_integer) order: order_col [group: group_col] |
Argument | Required? | Data Type | Description |
---|---|---|---|
col_ref | Y | string | Name of column whose values are applied to the function |
k_integer | Y | integer (positive) | The ranking of the unique value to extract from the source column |
rowsBefore_integer | N | integer | Number of rows before the current one to include in the computation |
rowsAfter_integer | N | integer | Number of rows after the current one to include in the computation |
For more information on the order
and group
parameters, see Window Transform.
Name of the column whose values are used to compute the function.
Required? | Data Type | Example Value |
---|---|---|
Yes | String (column reference to Integer or Decimal values) | myColumn |
Integer representing the ranking of the unique value to extract from the source column. Duplicate values are treated as a single value for purposes of this function's calculation.
NOTE: The value for |
k=1
represents the maximum value in the column. k
.
Required? | Data Type | Example Value |
---|---|---|
Yes | Integer (positive) | 4
|
Integers representing the number of rows before or after the current one from which to compute the rolling function, including the current row. For example, if the first value is 5
, the current row and the four rows after it are used in the computation. Negative values for rowsAfter_integer
compute the rolling function from rows preceding the current one.
rowBefore=1
generates the current row value only.rowBefore=-1
uses all rows preceding the current one.rowsAfter
is not specified, then the value 0
is applied.group
parameter is applied, then these parameter values should be no more than the maximum number of rows in the groups.Required? | Data Type | Example Value |
---|---|---|
No | Integer | 4 |