ai.rapids.cudf.nvcomp

Class LZ4Compressor

java.lang.Object

ai.rapids.cudf.nvcomp.LZ4Compressor

public class LZ4Compressor
extends Object

Single-buffer compressor implementing LZ4

Constructor Summary

Constructors

Constructor and Description
LZ4Compressor()

Method Summary

Modifier and Type	Method and Description
static long	compress(BaseDeviceMemoryBuffer input, CompressionType inputType, long chunkSize, BaseDeviceMemoryBuffer tempBuffer, BaseDeviceMemoryBuffer output, Cuda.Stream stream) Compress a buffer with LZ4.
static void	compressAsync(HostMemoryBuffer compressedSizeOutputBuffer, BaseDeviceMemoryBuffer input, CompressionType inputType, long chunkSize, BaseDeviceMemoryBuffer tempBuffer, BaseDeviceMemoryBuffer output, Cuda.Stream stream) Asynchronously compress a buffer with LZ4.
static long	getOutputSize(BaseDeviceMemoryBuffer input, CompressionType inputType, long chunkSize, BaseDeviceMemoryBuffer tempBuffer) Calculate the amount of output storage space required to compress a buffer.
static long	getTempSize(BaseDeviceMemoryBuffer input, CompressionType inputType, long chunkSize) Calculate the amount of temporary storage space required to compress a buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

LZ4Compressor

public LZ4Compressor()

Method Detail

getTempSize

public static long getTempSize(BaseDeviceMemoryBuffer input,
                               CompressionType inputType,
                               long chunkSize)

Calculate the amount of temporary storage space required to compress a buffer.

Parameters:

input - buffer to compress

inputType - type of data within the buffer

chunkSize - compression chunk size to use

Returns:

amount in bytes of temporary storage space required to compress the buffer

getOutputSize

public static long getOutputSize(BaseDeviceMemoryBuffer input,
                                 CompressionType inputType,
                                 long chunkSize,
                                 BaseDeviceMemoryBuffer tempBuffer)

Calculate the amount of output storage space required to compress a buffer.

Parameters:

input - buffer to compress

inputType - type of data within the buffer

chunkSize - compression chunk size to use

tempBuffer - temporary storage space

Returns:

amount in bytes of output storage space required to compress the buffer

compress

public static long compress(BaseDeviceMemoryBuffer input,
                            CompressionType inputType,
                            long chunkSize,
                            BaseDeviceMemoryBuffer tempBuffer,
                            BaseDeviceMemoryBuffer output,
                            Cuda.Stream stream)

Compress a buffer with LZ4.

Parameters:

input - buffer to compress

inputType - type of data within the buffer

chunkSize - compression chunk size to use

tempBuffer - temporary storage space

output - buffer that will contain the compressed result

stream - CUDA stream to use

Returns:

size of the resulting compressed data stored to the output buffer

compressAsync

public static void compressAsync(HostMemoryBuffer compressedSizeOutputBuffer,
                                 BaseDeviceMemoryBuffer input,
                                 CompressionType inputType,
                                 long chunkSize,
                                 BaseDeviceMemoryBuffer tempBuffer,
                                 BaseDeviceMemoryBuffer output,
                                 Cuda.Stream stream)

Asynchronously compress a buffer with LZ4. The compressed size output buffer must be pinned memory for this operation to be truly asynchronous. Note that the caller must synchronize on the specified CUDA stream in order to safely examine the compressed output size!

Parameters:

compressedSizeOutputBuffer - host memory where the compressed output size will be stored

input - buffer to compress

inputType - type of data within the buffer

chunkSize - compression chunk size to use

tempBuffer - temporary storage space

output - buffer that will contain the compressed result

stream - CUDA stream to use