ai.rapids.cudf

Class GroupByOptions.Builder

java.lang.Object

ai.rapids.cudf.GroupByOptions.Builder

Enclosing class:

GroupByOptions

public static class GroupByOptions.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GroupByOptions	build()
GroupByOptions.Builder	withIgnoreNullKeys(boolean ignoreNullKeys) If true, the cudf groupby will ignore grouping keys that are null.
GroupByOptions.Builder	withKeysDescending(boolean... keysDescending) If `keysSorted == true`, indicates whether each column is ascending/descending.
GroupByOptions.Builder	withKeysNullSmallest(boolean... keysNullSmallest) If `keysSorted == true`, indicates the ordering of null values in each column.
GroupByOptions.Builder	withKeysSorted(boolean keysSorted) Indicates whether rows in `keys` are already sorted.

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

withIgnoreNullKeys

public GroupByOptions.Builder withIgnoreNullKeys(boolean ignoreNullKeys)

If true, the cudf groupby will ignore grouping keys that are null. The default value is false, so a null in the grouping column will produce a group.

withKeysSorted

public GroupByOptions.Builder withKeysSorted(boolean keysSorted)

Indicates whether rows in `keys` are already sorted. The default value is false. If the `keys` are already sorted, better performance may be achieved by passing `keysSorted == true` and indicating the ascending/descending order of each column and null order by calling `withKeysDescending` and `withKeysNullSmallest`, respectively.

withKeysDescending

public GroupByOptions.Builder withKeysDescending(boolean... keysDescending)

If `keysSorted == true`, indicates whether each column is ascending/descending. If empty or null, assumes all columns are ascending. Ignored if `keysSorted == false`.

withKeysNullSmallest

public GroupByOptions.Builder withKeysNullSmallest(boolean... keysNullSmallest)

If `keysSorted == true`, indicates the ordering of null values in each column. If empty or null, assumes all columns use 'null smallest'. Ignored if `keysSorted == false`.

build

public GroupByOptions build()