mTopRange#

swordfish.function.mTopRange()#

For each element Xi in a sliding window of X, count the continuous nearest neighbors to its left that are smaller than Xi. Null values are treated as the minimum values.

If X is a matrix, conduct the aforementioned calculation within each column of X.

Parameters:
  • X (Constant) – A vector/matrix/table/tuple (with scalars or equal-length vectors)/dictionary.

  • window (Constant) – An integer no smaller than 2 or a scalar of DURATION type indicating the size of the sliding window. Note: The window size is capped at 102400 when m-functions are used in the streaming engines.

  • minPeriods (Constant, optional) – A positive integer indicating the minimum number of observations in a window required to be not null (otherwise the result is NULL).