RollingMax
RollingMax calculates a window-based rolling maximum in an updateBy table operation. The rolling maximum can be calculated using forward and/or backward windows.
Syntax
RollingMax(revTicks, fwdTicks, pairs)
RollingMax(revTicks, pairs)
RollingMax(timestampCol, revTime, fwdTime, pairs)
RollingMax(timestampCol, revTime, pairs)
RollingMax(timestampCol, revDuration, pairs)
RollingMax(timestampCol, revDuration, fwdDuration, pairs)
Parameters
| Parameter | Type | Description |
|---|---|---|
| revTicks | long | The look-behind window size in ticks (rows). If positive, it defines the maximum number of rows before the current row that will be used. If negative, it defines the minimum number of rows after the current row that will be used. |
| fwdTicks | long | The look-forward window size in ticks (rows). If positive, it defines the maximum number of rows after the current row that will be used. If negative, it defines the minimum number of rows before the current row that will be used. |
| pairs | String... | The input/output column name pairs. |
| timestampCol | String | The name of the timestamp column. |
| revDuration | Duration | The look-behind window size in Duration. |
| fwdDuration | Duration | The look-forward window size in Duration. |
| revTime | long | The look-behind window size in nanoseconds. |
| fwdTime | long | The look-forward window size in nanoseconds. |
Returns
An UpdateByOperation to be used in an updateBy table operation.
Examples
The following example performs an updateBy on the source table using four row-based RollingMax operations. Each of the last three operations uses different revTicks and fwdTicks values to show how they affect the output.
rng = new Random()
source = emptyTable(10).update("X = rng.nextInt(25)")
opRollMax = RollingMax(3, "RollingMaximum = X")
opPrior = RollingMax(3, -1, "WindowPrior = X")
opPosterior = RollingMax(-1, 3, "WindowPosterior = X")
opMiddle = RollingMax(1, 1, "WindowMiddle = X")
result = source.updateBy([opRollMax, opPrior, opPosterior, opMiddle])
- source
- result