GroupByOptions#

public class GroupByOptions#

Options for groupby (see cudf::groupby::groupby’s constructor).

Field Summary

DEFAULT

Method Summary

builder()

Static Fields

public static GroupByOptions DEFAULT#

Static Methods

public static Builder builder()#

public static class Builder#

Method Summary

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

Methods

public 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.

public 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.

public 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.

public 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.

public GroupByOptions build()#