Package ai.rapids.cudf

Interface Summary

Interface	Description
ArrowIPCOptions.NeedGpu
ArrowIPCWriterOptions.DoneOnGpu
BinaryOperable
ColumnVector.EventHandler	Interface to handle events for this ColumnVector.
ColumnWriterOptions.ByteArrayProducer
ColumnWriterOptions.IntArrayProducer
HostBufferConsumer	Provides a set of APIs for consuming host buffers.
HostBufferProvider	Provides a set of APIs for providing host buffers to be read.
HostColumnVector.EventHandler	Interface to handle events for this HostColumnVector.
HostMemoryAllocator
MemoryBuffer.EventHandler	Interface to handle events for this MemoryBuffer.
RmmDeviceMemoryResource	A resource that allocates/deallocates device memory.
RmmEventHandler
StreamedTableReader	Provides an interface for reading multiple tables from a single input source.

Class Summary

Class	Description
Aggregation128Utils	Utility methods for breaking apart and reassembling 128-bit values during aggregations to enable hash-based aggregations and detect overflows.
AggregationOverWindow	An Aggregation instance that also holds a column number and window metadata so the aggregation can be done over a specific window.
ArrowColumnBuilder	Column builder from Arrow data.
ArrowIPCOptions	Options for reading data in Arrow IPC format
ArrowIPCOptions.Builder
ArrowIPCWriterOptions	Settings for writing Arrow IPC data.
ArrowIPCWriterOptions.Builder
AssertEmptyNulls	This class is a Helper class to assert there are no non-empty nulls in a ColumnView The reason for the existence of this class is so that we can turn the asserts on/off when needed by passing "-da:ai.rapids.cudf.AssertEmptyNulls".
AvroOptions	Options for reading an Avro file
AvroOptions.Builder
BaseDeviceMemoryBuffer	Base class for all MemoryBuffers that are in device memory.
ChunkedPack	JNI interface to cudf::chunked_pack.
CloseableArray<T extends AutoCloseable>	Utility class that wraps an array of closeable instances and can be closed
ColumnFilterOptions	Base options class for input formats that can filter columns.
ColumnFilterOptions.Builder<T extends ColumnFilterOptions.Builder>
ColumnVector	This class represents the immutable vector of data.
ColumnVector.OffHeapState	Holds the off heap state of the column vector so we can clean it up, even if it is leaked.
ColumnView	This class represents the column_view of a column analogous to its cudf cpp counterpart.
ColumnWriterOptions	Per column settings for writing Parquet/ORC files.
ColumnWriterOptions.AbstractStructBuilder<T extends ColumnWriterOptions.AbstractStructBuilder,V extends ColumnWriterOptions>
ColumnWriterOptions.ListBuilder
ColumnWriterOptions.ListColumnWriterOptions
ColumnWriterOptions.NestedBuilder<T extends ColumnWriterOptions.NestedBuilder,V extends ColumnWriterOptions>
ColumnWriterOptions.StructBuilder
ColumnWriterOptions.StructColumnWriterOptions
CompressionMetadataWriterOptions
CompressionMetadataWriterOptions.Builder<T extends CompressionMetadataWriterOptions.Builder,V extends CompressionMetadataWriterOptions>
ContigSplitGroupByResult	Used to save groups and uniq key table for `Table.contiguousSplitGroupsAndGenUniqKeys` Each row in uniq key table is corresponding to a group Resource management note: This class is the owner of `groups` and `uniqKeysTable`(or uniqKeyColumns if table is not constructed) 1: Use `closeGroups` and `closeUniqKeyTable` to close the resources separately if you want to close eagerly.
ContiguousTable	A table that is backed by a single contiguous device buffer.
CSVOptions	Options for reading a CSV file
CSVOptions.Builder
CSVWriterOptions	Options for writing a CSV file
CSVWriterOptions.Builder
Cuda
Cuda.Event
Cuda.Stream	A class representing a CUDA stream
CudaMemInfo	Represent free and total device memory.
CudaMemoryBuffer	This class represents data allocated using `cudaMalloc` directly instead of the default RMM memory resource.
Cudf
CuFile	JNI wrapper for accessing the cuFile API.
CuFileBuffer	Represents a cuFile buffer.
CuFileReadHandle	Represents a cuFile file handle for reading.
CuFileWriteHandle	Represents a cuFile file handle for reading.
DataSource	Base class that can be used to provide data dynamically to CUDF.
DecimalUtils
DefaultHostMemoryAllocator
DeviceMemoryBuffer	This class represents data in some form on the GPU.
DeviceMemoryBufferView	This class represents data in some form on the GPU.
DType
GatherMap	This class tracks the data associated with a gather map, a buffer of INT32 elements that index a source table and can be passed to a table gather operation.
GetJsonObjectOptions
GetJsonObjectOptions.Builder
GroupByAggregation	An aggregation that can be used for a reduce.
GroupByAggregationOnColumn	A GroupByAggregation for a specific column in a table.
GroupByOptions	Options for groupby (see cudf::groupby::groupby's constructor)
GroupByOptions.Builder
GroupByScanAggregation	An aggregation that can be used for a grouped scan.
GroupByScanAggregationOnColumn	A GroupByScanAggregation for a specific column in a table.
HashJoin	This class represents a hash table built from the join keys of the right-side table for a join operation.
HostColumnVector	Similar to a ColumnVector, but the data is stored in host memory and accessible directly from the JVM.
HostColumnVector.BasicType
HostColumnVector.Builder
HostColumnVector.ColumnBuilder	Build
HostColumnVector.DataType
HostColumnVector.ListType
HostColumnVector.StructData
HostColumnVector.StructType
HostColumnVectorCore	A class that holds Host side Column Vector APIs and the OffHeapState.
HostColumnVectorCore.OffHeapState	Holds the off heap state of the column vector so we can clean it up, even if it is leaked.
HostMemoryBuffer	This class holds an off-heap buffer in the host/CPU memory.
HostUDFWrapper	A wrapper around native host UDF aggregations.
JCudfSerialization	Serialize and deserialize CUDF tables and columns using a custom format.
JCudfSerialization.HostConcatResult	Class to hold the header and buffer pair result from host-side concatenation
JCudfSerialization.SerializedColumnHeader	Holds the metadata about a serialized column.
JCudfSerialization.SerializedTableHeader	Holds the metadata about a serialized table.
JCudfSerialization.TableAndRowCountPair	Holds the result of deserializing a table.
JSONOptions	Options for reading in JSON encoded data.
JSONOptions.Builder
MemoryBuffer	Abstract class for representing the Memory Buffer NOTE: MemoryBuffer is public to make it easier to work with the class hierarchy, subclassing beyond what is included in CUDF is not recommended and not supported.
MemoryBuffer.MemoryBufferCleaner
MemoryCleaner	ColumnVectors may store data off heap, and because of complicated processing the life time of an individual vector can vary a lot.
MemoryCleaner.Cleaner	API that can be used to clean up the resources for a vector, even if there was a leak
MixedJoinSize	This class tracks size information associated with a mixed table join.
MultiBufferDataSource	This is a DataSource that can take multiple HostMemoryBuffers.
NativeDepsLoader	This class will load the native dependencies.
NvtxRange	This class supports push/pop NVTX profiling ranges, or "scoped" ranges.
NvtxUniqueRange	This class supports start/end NVTX profiling ranges.
ORCChunkedReader	Provide an interface for reading an ORC file in an iterative manner.
ORCOptions	Options for reading a ORC file
ORCOptions.Builder
ORCWriterOptions	This class represents settings for writing ORC files.
ORCWriterOptions.Builder
OrderByArg	Provides the ordering for specific columns.
PackedColumnMetadata	Metadata for a table that is backed by a single contiguous device buffer.
ParquetChunkedReader	Provide an interface for reading a Parquet file in an iterative manner.
ParquetOptions	Options for reading a parquet file
ParquetOptions.Builder
ParquetWriterOptions	This class represents settings for writing Parquet files.
ParquetWriterOptions.Builder
PartitionedTable	Class to provide a PartitionedTable
PinnedMemoryPool	This is the JNI interface to a rmm::pool_memory_resource.
Range	Helper utility for creating ranges.
ReductionAggregation	An aggregation that can be used for a reduce.
RegexProgram	Regex program class, closely following cudf::strings::regex_program.
ReplacePolicyWithColumn	A replacement policy for a specific column
Rmm	This is the binding class for rmm lib.
Rmm.LogConf	What to send RMM alloc and free logs to.
RmmAllocationMode
RmmArenaMemoryResource<C extends RmmDeviceMemoryResource>	A device memory resource that will pre-allocate a pool of resources and sub-allocate from this pool to improve memory performance.
RmmCudaAsyncMemoryResource	A device memory resource that uses `cudaMallocAsync` and `cudaFreeAsync` for allocation and deallocation.
RmmCudaMemoryResource	A device memory resource that uses `cudaMalloc` and `cudaFree` for allocation and deallocation.
RmmEventHandlerResourceAdaptor<C extends RmmDeviceMemoryResource>	A device memory resource that will give callbacks in specific situations.
RmmLimitingResourceAdaptor<C extends RmmDeviceMemoryResource>	A device memory resource that will limit the maximum amount allocated.
RmmLoggingResourceAdaptor<C extends RmmDeviceMemoryResource>	A device memory resource that will log interactions.
RmmManagedMemoryResource	A device memory resource that uses `cudaMallocManaged` and `cudaFreeManaged` for allocation and deallocation.
RmmPoolMemoryResource<C extends RmmDeviceMemoryResource>	A device memory resource that will pre-allocate a pool of resources and sub-allocate from this pool to improve memory performance.
RmmTrackingResourceAdaptor<C extends RmmDeviceMemoryResource>	A device memory resource that will track some basic statistics about the memory usage.
RmmWrappingDeviceMemoryResource<C extends RmmDeviceMemoryResource>	A resource that wraps another RmmDeviceMemoryResource
RollingAggregation	An aggregation that can be used on rolling windows.
RollingAggregationOnColumn	A RollingAggregation for a specific column in a table.
Scalar	A single scalar value.
ScanAggregation	An aggregation that can be used for a scan.
Schema	The schema of data to be read in.
Schema.Builder
SegmentedReductionAggregation	An aggregation that can be used for a reduce.
Table	Class to represent a collection of ColumnVectors and operations that can be performed on them collectively.
Table.GroupByOperation	Class representing groupby operations
Table.TableOperation
Table.TestBuilder	Create a table on the GPU with data from the CPU.
TableDebug
TableDebug.Builder
TableWithMeta	A table along with some metadata about the table.
TableWithMeta.NestedChildren
TableWriter	Provides an interface for writing out Table information in multiple steps.
TableWriter.WriteStatistics
WindowOptions	Options for rolling windows.
WindowOptions.Builder

Enum Summary

Enum	Description
BinaryOp	Mathematical binary operations.
BufferType	Types of buffers supported by ColumnVectors and HostColumnVectors
CaptureGroups	Capture groups setting, closely following cudf::strings::capture_groups.
ColumnView.FindOptions	Enum to choose behaviour of listIndexOf functions: 1.
CompressionType	Enumeration of compression formats.
CudaComputeMode	This is the Java mapping of CUDA device compute modes.
CudaException.CudaError	The Java mirror of cudaError, which facilities the tracking of CUDA errors in JVM.
DateTimeComponent	Types of datetime components that may be extracted.
DateTimeRoundingFrequency
DType.DTypeEnum
HashType	Hash algorithm identifiers, mirroring native enum cudf::hash_id
NaNEquality	How should NaNs be compared in an operation.
NullEquality	How should nulls be compared in an operation.
NullPolicy	Specify whether to include nulls or exclude nulls in an operation.
NvtxColor
OutOfBoundsPolicy	Policy to account for possible out-of-bounds indices `NULLIFY` means to nullify output values corresponding to out-of-bounds gather map values.
PadSide
ParquetWriterOptions.StatisticsFrequency
QuantileMethod	Interpolation method to use when the desired quantile lies between two data points i and j.
QuoteStyle	Quote style for CSV records, closely following cudf::io::quote_style.
RegexFlag	Regex flags setting, closely following cudf::strings::regex_flags.
ReplacePolicy	Policy to specify the position of replacement values relative to null rows.
RoundMode	Rounding modes supported in round method.
ScanType	Scan operation type.
Table.DuplicateKeepOption	Enum to specify which of duplicate rows/elements will be copied to the output.
TableDebug.Output
UnaryOp	Mathematical unary operations.

Exception Summary

Exception	Description
CudaException	Exception from the cuda language/library.
CudaFatalException	CudaFatalException is a kind of CudaException which leaves the process in an inconsistent state and any further CUDA work will return the same error.
CudfColumnSizeOverflowException	Exception thrown when CUDF operation results in a column size exceeding CUDF column size limits
CudfException	Exception thrown by cudf itself.
RmmException	Exception from RMM allocator.