C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

Classes | Functions | Variables
Data Compression

Contains classes for data compression and decompression. More...

Classes

class  Bzip2CompressionParameter
 Parameter for bzip2 compression and decompression. More...
 
class  Compressor< bzip2 >
 Implementation of the Compressor class for the bzip2 compression method. More...
 
class  Decompressor< bzip2 >
 Specialization of Decompressor class for Bzip2 compression method. More...
 
class  LzoCompressionParameter
 Parameter for LZO compression and decompression. LZO compressed block header consists of four sections: 1) optional, 2) uncompressed data size (4 bytes), 3) compressed data size (4 bytes), 4) optional. More...
 
class  RleCompressionParameter
 Parameter for run-length encoding and decoding. A RLE encoded block may contain a header that consists of two sections: 1) decoded data size (4 bytes) and 2) encoded data size (4 bytes) More...
 
class  ZlibCompressionParameter
 Parameter for zlib compression and decompression. More...
 

Functions

 Bzip2CompressionParameter (CompressionLevel clevel=defaultLevel)
 
 Compressor ()
 Compressor<bzip2> constructor.
 
void setInputDataBlock (byte *inBlock, size_t size, size_t offset)
 
void setInputDataBlock (DataBlock &inBlock)
 
void run (byte *outBlock, size_t size, size_t offset)
 
void run (DataBlock &outBlock)
 
 Decompressor ()
 Decompressor<bzip2> constructor.
 
void setInputDataBlock (byte *inBlock, size_t size, size_t offset)
 
void setInputDataBlock (DataBlock &inBlock)
 
void run (byte *outBlock, size_t size, size_t offset)
 
void run (DataBlock &outBlock)
 

Variables

Bzip2CompressionParameter parameter
 
Bzip2CompressionParameter parameter
 
enum  CompressionLevel {
  defaultLevel = -1, level0 = 0, level1, level2,
  level3, level4, level5, level6,
  level7, level8, level9
}
 Compression levels More...
 
enum  CompressionMethod { zlib, lzo, rle, bzip2 }
 Compression methods More...
 
typedef services::Collection
< services::SharedPtr
< DataBlock > > 
DataBlockCollection
 Collection of DataBlock-type elements.
 

Enumeration Type Documentation

enum CompressionLevel

Enumerator
defaultLevel 

Default compression level

level0 

Minimum compression level, maximum speed

level1 


level2 


level3 


level4 


level5 


level6 


level7 


level8 


level9 

Maximum compression level, minimum speed

enum CompressionMethod

Enumerator
zlib 

DEFLATE compression method with a ZLIB block header or a simple GZIP block header

lzo 

LZO1X compatible compression method

rle 

Run-Length Encoding method

bzip2 

BZIP2 compression method

Function Documentation

Bzip2CompressionParameter ( CompressionLevel  clevel = defaultLevel)
inline

Bzip2CompressionParameter Constructor

Parameters
[in]clevelCompression level, CompressionLevel. defaultLevel is equal to bzip2 compression level 9
void run ( byte *  outBlock,
size_t  size,
size_t  offset 
)

Performs bzip2 compression of a data block

Parameters
[out]outBlockPointer to the data block where compression results are stored. Must be at least size+offset bytes
[in]sizeNumber of bytes available in outBlock
[in]offsetOffset in bytes, the starting position for compression in outBlock
void run ( DataBlock outBlock)
inline

Performs bzip2 compression of a data block

Parameters
[out]outBlockReference to the data block where compression results are stored
void run ( byte *  outBlock,
size_t  size,
size_t  offset 
)

Performs bzip2 decompression of a data block

Parameters
[out]outBlockPointer to the data block where decompression results are stored. Must be at least size+offset bytes
[in]sizeNumber of bytes available in outBlock
[in]offsetOffset in bytes, the starting position for decompression in outBlock
void run ( DataBlock outBlock)
inline

Performs bzip2 decompression of a data block

Parameters
[out]outBlockReference to the data block where decompression results are stored
void setInputDataBlock ( byte *  inBlock,
size_t  size,
size_t  offset 
)

Associates an input data block with a compressor

Parameters
[in]inBlockPointer to the data block to compress. Must be at least size+offset bytes
[in]sizeNumber of bytes to compress in inBlock
[in]offsetOffset in bytes, the starting position for compression in inBlock
void setInputDataBlock ( DataBlock inBlock)
inline

Associates an input data block with a compressor

Parameters
[in]inBlockReference to the data block to compress
void setInputDataBlock ( byte *  inBlock,
size_t  size,
size_t  offset 
)

Associates an input data block with a decompressor

Parameters
[in]inBlockPointer to the data block to decompress. Must be at least size+offset bytes
[in]sizeNumber of bytes to decompress in inBlock
[in]offsetOffset in bytes, the starting position for decompression in inBlock
void setInputDataBlock ( DataBlock inBlock)
inline

Associates an input data block with a decompressor

Parameters
[in]inBlockReference to the data block to decompress

Variable Documentation

Bzip2CompressionParameter parameter

Bzip2 compression parameters structure

Bzip2CompressionParameter parameter

Bzip2 compression parameters structure

For more complete information about compiler optimizations, see our Optimization Notice.