Package ai.rapids.cudf

Class WindowOptions.Builder

java.lang.Object
ai.rapids.cudf.WindowOptions.Builder
Enclosing class:
WindowOptions
public static class WindowOptions.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • minPeriods

      public WindowOptions.Builder minPeriods(int minPeriods)
      Set the minimum number of observation required to evaluate an element. If there are not enough elements for a given window a null is placed in the result instead.

    • window

      public WindowOptions.Builder window(ColumnVector precedingCol, ColumnVector followingCol)
      Set the size of the window, one entry per row. This does not take ownership of the columns passed in so you have to be sure that the lifetime of the column outlives this operation.
      Parameters:
      precedingCol - the number of rows in the window before and including the current row. precedingCol will be live outside of WindowOptions.
      followingCol - the number of rows in the window after the current row. followingCol will be live outside of WindowOptions.

    • window

      public WindowOptions.Builder window(Scalar precedingScalar, Scalar followingScalar)
      Set the size of the range window. This does not take ownership of the scalars passed in so you have to be sure that the lifetime of the scalars outlives this operation.
      Parameters:
      precedingScalar - the number of rows in the window before and including the current row. precedingScalar will be live outside of WindowOptions.
      followingScalar - the number of rows in the window after the current row. followingScalar will be live outside of WindowOptions.

    • timestampColumnIndex

      @Deprecated public WindowOptions.Builder timestampColumnIndex(int index)
      Deprecated.
      Use orderByColumnIndex(int index)

    • orderByColumnIndex

      public WindowOptions.Builder orderByColumnIndex(int index)

    • orderByColumns

      public WindowOptions.Builder orderByColumns(int[] indices, boolean[] ascending, boolean[] nullsFirst)
      Specify multiple order-by columns for a multi-column RANGE window. All three arrays must be non-empty and of equal length; entry i describes the i-th order-by column.

      Multi-column RANGE windows support only peer-frame bounds (UNBOUNDED and CURRENT_ROW); bounded scalar ranges are not supported across multiple order-by columns. Unlike the single-column order-by methods, null placement is not deduced from the data and must be stated explicitly here. This API is mutually exclusive with the single-column order-by setters; mixing them in one builder is rejected by build().

      Parameters:
      indices - input-table column indices of the order-by columns, in order.
      ascending - per-column sort direction (true == ascending).
      nullsFirst - per-column null placement (true == nulls ordered before non-null values).

    • timestampAscending

      @Deprecated public WindowOptions.Builder timestampAscending()
      Deprecated.
      Use orderByAscending()

    • orderByAscending

      public WindowOptions.Builder orderByAscending()

    • orderByDescending

      public WindowOptions.Builder orderByDescending()

    • timestampDescending

      @Deprecated public WindowOptions.Builder timestampDescending()
      Deprecated.
      Use orderByDescending()

    • currentRowPreceding

      public WindowOptions.Builder currentRowPreceding()

    • currentRowFollowing

      public WindowOptions.Builder currentRowFollowing()

    • unboundedPreceding

      public WindowOptions.Builder unboundedPreceding()

    • unboundedFollowing

      public WindowOptions.Builder unboundedFollowing()

    • preceding

      public WindowOptions.Builder preceding(Scalar preceding)
      Set the relative number preceding the current row for range window
      Returns:
      this for chaining

    • following

      public WindowOptions.Builder following(Scalar following)
      Set the relative number following the current row for range window
      Returns:
      this for chaining

    • build

      public WindowOptions build()