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 Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
WindowOptions	build()
WindowOptions.Builder	currentRowFollowing()
WindowOptions.Builder	currentRowPreceding()
WindowOptions.Builder	following(Scalar following) Set the relative number following the current row for range window
WindowOptions.Builder	minPeriods(int minPeriods) Set the minimum number of observation required to evaluate an element.
WindowOptions.Builder	orderByAscending()
WindowOptions.Builder	orderByColumnIndex(int index)
WindowOptions.Builder	orderByDescending()
WindowOptions.Builder	preceding(Scalar preceding) Set the relative number preceding the current row for range window
WindowOptions.Builder	timestampAscending() Deprecated. Use orderByAscending()
WindowOptions.Builder	timestampColumnIndex(int index) Deprecated. Use orderByColumnIndex(int index)
WindowOptions.Builder	timestampDescending() Deprecated. Use orderByDescending()
WindowOptions.Builder	unboundedFollowing()
WindowOptions.Builder	unboundedPreceding()
WindowOptions.Builder	window(ColumnVector precedingCol, ColumnVector followingCol) Set the size of the window, one entry per row.
WindowOptions.Builder	window(Scalar precedingScalar, Scalar followingScalar) Set the size of the range window.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

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 preceding the current row and precedingCol will be live outside of WindowOptions.

followingCol - the number of rows following the current row and following will be live outside of WindowOptions.

window

public WindowOptions.Builder window(Scalar precedingScalar,
                                    Scalar followingScalar)

Set the size of the range window.

Parameters:

precedingScalar - the relative number preceding the current row and the precedingScalar will be live outside of WindowOptions.

followingScalar - the relative number following the current row and the 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)

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()