ai.rapids.cudf

Class Table

java.lang.Object

ai.rapids.cudf.Table

All Implemented Interfaces:

AutoCloseable

public final class Table
extends Object
implements AutoCloseable

Class to represent a collection of ColumnVectors and operations that can be performed on them collectively. The refcount on the columns will be increased once they are passed in

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Table.AggregateOperation Class representing aggregate operations
static class	Table.OrderByArg
static class	Table.TableOperation
static class	Table.TestBuilder Create a table on the GPU with data from the CPU.

Constructor Summary

Constructors

Constructor and Description
Table(ColumnVector... columns) Table class makes a copy of the array of ColumnVectors passed to it.

Method Summary

Modifier and Type	Method and Description
static Table.OrderByArg	asc(int index)
void	close()
static Table	concatenate(Table... tables) Concatenate multiple tables together to form a single table.
static Aggregate	count(int index)
static Table.OrderByArg	desc(int index)
Table	filter(ColumnVector mask) Filters this table using a column of boolean values as a mask, returning a new one.
ColumnVector	getColumn(int index) Return the ColumnVector at the specified index.
int	getNumberOfColumns()
long	getRowCount()
Table.AggregateOperation	groupBy(GroupByOptions groupByOptions, int... indices)
Table.AggregateOperation	groupBy(int... indices)
static Aggregate	max(int index)
static Aggregate	mean(int index)
static Aggregate	min(int index)
Table.TableOperation	onColumns(int... indices)
Table	orderBy(boolean areNullsSmallest, Table.OrderByArg... args) Orders the table using the sortkeys returning a new allocated table.
static Table	readCSV(Schema schema, byte[] buffer) Read CSV formatted data using the default CSVOptions.
static Table	readCSV(Schema schema, CSVOptions opts, byte[] buffer) Read CSV formatted data.
static Table	readCSV(Schema schema, CSVOptions opts, byte[] buffer, long offset, long len) Read CSV formatted data.
static Table	readCSV(Schema schema, CSVOptions opts, File path) Read a CSV file.
static Table	readCSV(Schema schema, CSVOptions opts, HostMemoryBuffer buffer, long offset, long len) Read CSV formatted data.
static Table	readCSV(Schema schema, File path) Read a CSV file using the default CSVOptions.
static Table	readORC(byte[] buffer) Read ORC formatted data.
static Table	readORC(File path) Read a ORC file using the default ORCOptions.
static Table	readORC(ORCOptions opts, byte[] buffer) Read ORC formatted data.
static Table	readORC(ORCOptions opts, byte[] buffer, long offset, long len) Read ORC formatted data.
static Table	readORC(ORCOptions opts, File path) Read a ORC file.
static Table	readORC(ORCOptions opts, HostMemoryBuffer buffer, long offset, long len) Read ORC formatted data.
static Table	readParquet(byte[] buffer) Read parquet formatted data.
static Table	readParquet(File path) Read a Parquet file using the default ParquetOptions.
static Table	readParquet(ParquetOptions opts, byte[] buffer) Read parquet formatted data.
static Table	readParquet(ParquetOptions opts, byte[] buffer, long offset, long len) Read parquet formatted data.
static Table	readParquet(ParquetOptions opts, File path) Read a Parquet file.
static Table	readParquet(ParquetOptions opts, HostMemoryBuffer buffer, long offset, long len) Read parquet formatted data.
static Aggregate	sum(int index)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

public Table(ColumnVector... columns)

Table class makes a copy of the array of ColumnVectors passed to it. The class will decrease the refcount on itself and all its contents when closed and free resources if refcount is zero

Parameters:

columns - - Array of ColumnVectors

Method Detail

getColumn

public ColumnVector getColumn(int index)

Return the ColumnVector at the specified index. If you want to keep a reference to the column around past the life time of the table, you will need to increment the reference count on the column yourself.

getRowCount

public final long getRowCount()

getNumberOfColumns

public final int getNumberOfColumns()

close

public void close()

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object

readCSV

public static Table readCSV(Schema schema,
                            File path)

Read a CSV file using the default CSVOptions.

Parameters:

schema - the schema of the file. You may use Schema.INFERRED to infer the schema.

path - the local file to read.

Returns:

the file parsed as a table on the GPU.

readCSV

public static Table readCSV(Schema schema,
                            CSVOptions opts,
                            File path)

Read a CSV file.

Parameters:

schema - the schema of the file. You may use Schema.INFERRED to infer the schema.

opts - various CSV parsing options.

path - the local file to read.

Returns:

the file parsed as a table on the GPU.

readCSV

public static Table readCSV(Schema schema,
                            byte[] buffer)

Read CSV formatted data using the default CSVOptions.

Parameters:

schema - the schema of the data. You may use Schema.INFERRED to infer the schema.

buffer - raw UTF8 formatted bytes.

Returns:

the data parsed as a table on the GPU.

readCSV

public static Table readCSV(Schema schema,
                            CSVOptions opts,
                            byte[] buffer)

Read CSV formatted data.

Parameters:

schema - the schema of the data. You may use Schema.INFERRED to infer the schema.

opts - various CSV parsing options.

buffer - raw UTF8 formatted bytes.

Returns:

the data parsed as a table on the GPU.

readCSV

public static Table readCSV(Schema schema,
                            CSVOptions opts,
                            byte[] buffer,
                            long offset,
                            long len)

Read CSV formatted data.

Parameters:

schema - the schema of the data. You may use Schema.INFERRED to infer the schema.

opts - various CSV parsing options.

buffer - raw UTF8 formatted bytes.

offset - the starting offset into buffer.

len - the number of bytes to parse.

Returns:

the data parsed as a table on the GPU.

readCSV

public static Table readCSV(Schema schema,
                            CSVOptions opts,
                            HostMemoryBuffer buffer,
                            long offset,
                            long len)

Read CSV formatted data.

Parameters:

schema - the schema of the data. You may use Schema.INFERRED to infer the schema.

opts - various CSV parsing options.

buffer - raw UTF8 formatted bytes.

offset - the starting offset into buffer.

len - the number of bytes to parse.

Returns:

the data parsed as a table on the GPU.

readParquet

public static Table readParquet(File path)

Read a Parquet file using the default ParquetOptions.

Parameters:

path - the local file to read.

Returns:

the file parsed as a table on the GPU.

readParquet

public static Table readParquet(ParquetOptions opts,
                                File path)

Read a Parquet file.

Parameters:

opts - various parquet parsing options.

path - the local file to read.

Returns:

the file parsed as a table on the GPU.

readParquet

public static Table readParquet(byte[] buffer)

Read parquet formatted data.

Parameters:

buffer - raw parquet formatted bytes.

Returns:

the data parsed as a table on the GPU.

readParquet

public static Table readParquet(ParquetOptions opts,
                                byte[] buffer)

Read parquet formatted data.

Parameters:

opts - various parquet parsing options.

buffer - raw parquet formatted bytes.

Returns:

the data parsed as a table on the GPU.

readParquet

public static Table readParquet(ParquetOptions opts,
                                byte[] buffer,
                                long offset,
                                long len)

Read parquet formatted data.

Parameters:

opts - various parquet parsing options.

buffer - raw parquet formatted bytes.

offset - the starting offset into buffer.

len - the number of bytes to parse.

Returns:

the data parsed as a table on the GPU.

readParquet

public static Table readParquet(ParquetOptions opts,
                                HostMemoryBuffer buffer,
                                long offset,
                                long len)

Read parquet formatted data.

Parameters:

opts - various parquet parsing options.

buffer - raw parquet formatted bytes.

offset - the starting offset into buffer.

len - the number of bytes to parse.

Returns:

the data parsed as a table on the GPU.

readORC

public static Table readORC(File path)

Read a ORC file using the default ORCOptions.

Parameters:

path - the local file to read.

Returns:

the file parsed as a table on the GPU.

readORC

public static Table readORC(ORCOptions opts,
                            File path)

Read a ORC file.

Parameters:

opts - ORC parsing options.

path - the local file to read.

Returns:

the file parsed as a table on the GPU.

readORC

public static Table readORC(byte[] buffer)

Read ORC formatted data.

Parameters:

buffer - raw ORC formatted bytes.

Returns:

the data parsed as a table on the GPU.

readORC

public static Table readORC(ORCOptions opts,
                            byte[] buffer)

Read ORC formatted data.

Parameters:

opts - various ORC parsing options.

buffer - raw ORC formatted bytes.

Returns:

the data parsed as a table on the GPU.

readORC

public static Table readORC(ORCOptions opts,
                            byte[] buffer,
                            long offset,
                            long len)

Read ORC formatted data.

Parameters:

opts - various ORC parsing options.

buffer - raw ORC formatted bytes.

offset - the starting offset into buffer.

len - the number of bytes to parse.

Returns:

the data parsed as a table on the GPU.

readORC

public static Table readORC(ORCOptions opts,
                            HostMemoryBuffer buffer,
                            long offset,
                            long len)

Read ORC formatted data.

Parameters:

opts - various ORC parsing options.

buffer - raw ORC formatted bytes.

offset - the starting offset into buffer.

len - the number of bytes to parse.

Returns:

the data parsed as a table on the GPU.

concatenate

public static Table concatenate(Table... tables)

Concatenate multiple tables together to form a single table. The schema of each table (i.e.: number of columns and types of each column) must be equal across all tables and will determine the schema of the resulting table.

orderBy

public Table orderBy(boolean areNullsSmallest,
                     Table.OrderByArg... args)

Orders the table using the sortkeys returning a new allocated table. The caller is responsible for cleaning up the ColumnVector returned as part of the output Table

Example usage: orderBy(true, Table.asc(0), Table.desc(3)...);

Parameters:

areNullsSmallest - - represents if nulls are to be considered smaller than non-nulls.

args - - Suppliers to initialize sortKeys.

Returns:

Sorted Table

asc

public static Table.OrderByArg asc(int index)

desc

public static Table.OrderByArg desc(int index)

count

public static Aggregate count(int index)

max

public static Aggregate max(int index)

min

public static Aggregate min(int index)

sum

public static Aggregate sum(int index)

mean

public static Aggregate mean(int index)

groupBy

public Table.AggregateOperation groupBy(GroupByOptions groupByOptions,
                                        int... indices)

groupBy

public Table.AggregateOperation groupBy(int... indices)

onColumns

public Table.TableOperation onColumns(int... indices)

filter

public Table filter(ColumnVector mask)

Filters this table using a column of boolean values as a mask, returning a new one.

Given a mask column, each element `i` from the input columns is copied to the output columns if the corresponding element `i` in the mask is non-null and `true`. This operation is stable: the input order is preserved.

This table and mask columns must have the same number of rows.

The output table has size equal to the number of elements in boolean_mask that are both non-null and `true`.

If the original table row count is zero, there is no error, and an empty table is returned.

Parameters:

mask - column of type DType.BOOL8 used as a mask to filter the input column

Returns:

table containing copy of all elements of this table passing the filter defined by the boolean mask