ai.rapids.cudf.nvcomp

Class Decompressor

java.lang.Object

ai.rapids.cudf.nvcomp.Decompressor

public class Decompressor
extends Object

Generic single-buffer decompressor interface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Decompressor.Metadata Opaque metadata object for single-buffer decompression

Constructor Summary

Constructors

Constructor and Description
Decompressor()

Method Summary

Modifier and Type	Method and Description
static void	decompressAsync(BaseDeviceMemoryBuffer input, BaseDeviceMemoryBuffer tempBuffer, Decompressor.Metadata metadata, BaseDeviceMemoryBuffer output, Cuda.Stream stream) Asynchronously decompress a buffer.
static Decompressor.Metadata	getMetadata(BaseDeviceMemoryBuffer buffer, Cuda.Stream stream) Get the metadata associated with a compressed buffer
static long	getOutputSize(Decompressor.Metadata metadata) Get the amount of output storage space required to hold the uncompressed data.
static long	getTempSize(Decompressor.Metadata metadata) Get the amount of temporary storage space required to decompress a buffer.
static boolean	isLZ4Data(BaseDeviceMemoryBuffer buffer) Determine if a buffer is data compressed with LZ4.

Methods inherited from class java.lang.Object

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

Constructor Detail

Decompressor

public Decompressor()

Method Detail

getMetadata

public static Decompressor.Metadata getMetadata(BaseDeviceMemoryBuffer buffer,
                                                Cuda.Stream stream)

Get the metadata associated with a compressed buffer

Parameters:

buffer - compressed data buffer

stream - CUDA stream to use

Returns:

opaque metadata object

getTempSize

public static long getTempSize(Decompressor.Metadata metadata)

Get the amount of temporary storage space required to decompress a buffer.

Parameters:

metadata - metadata retrieved from the compressed data

Returns:

amount in bytes of temporary storage space required to decompress

getOutputSize

public static long getOutputSize(Decompressor.Metadata metadata)

Get the amount of output storage space required to hold the uncompressed data.

Parameters:

metadata - metadata retrieved from the compressed data

Returns:

amount in bytes of output storage space required to decompress

decompressAsync

public static void decompressAsync(BaseDeviceMemoryBuffer input,
                                   BaseDeviceMemoryBuffer tempBuffer,
                                   Decompressor.Metadata metadata,
                                   BaseDeviceMemoryBuffer output,
                                   Cuda.Stream stream)

Asynchronously decompress a buffer.

Parameters:

input - compressed data buffer

tempBuffer - temporary storage buffer

metadata - metadata retrieved from compressed data

output - output storage buffer

stream - CUDA stream to use

isLZ4Data

public static boolean isLZ4Data(BaseDeviceMemoryBuffer buffer)

Determine if a buffer is data compressed with LZ4.

Parameters:

buffer - data to examine

Returns:

true if the data is LZ4 compressed