C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

List of all members
Compression Class Referenceabstract

Base class for compression and decompression More...

Class Declaration

References

Member Function Documentation

◆ checkInputParams()

virtual void checkInputParams ( byte *  inBlock,
size_t  size 
)
inlinevirtual

Basic checks of input block parameters

Parameters
[in]inBlockPointer to the input data block
[in]sizeSize in bytes of the input data block

◆ checkOutputParams()

virtual void checkOutputParams ( byte *  outBlock,
size_t  size 
)
inlinevirtual

Basic checks of output block parameters

Parameters
[in]outBlockPointer to output data block
[in]sizeSize in bytes of the output data block

◆ getUsedOutputDataBlockSize()

size_t getUsedOutputDataBlockSize ( )
inlinevirtual

Returns the number of bytes used after a call to the run() method

Returns
Number of used bytes

Implements CompressionIface.

◆ isOutputDataBlockFull()

bool isOutputDataBlockFull ( )
inlinevirtual

Reports whether an output data block is full after a call to the run() method

Returns
True if an output data block is full, false otherwise

Implements CompressionIface.

◆ run() [1/2]

virtual void run ( byte *  outBlock,
size_t  size,
size_t  offset 
)
pure virtual

Performs compression (or decompression) of a data block

Parameters
[out]outBlockPointer to the data block where compression (or 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 compression (or decompression) in outBlock

Implements CompressionIface.

Implemented in Decompressor< bzip2 >, Decompressor< lzo >, Decompressor< zlib >, Decompressor< rle >, Compressor< bzip2 >, Compressor< lzo >, Compressor< zlib >, and Compressor< rle >.

◆ run() [2/2]

virtual void run ( DataBlock outBlock)
pure virtual

Performs compression (or decompression) of a data block

Parameters
[out]outBlockDataBlock where compression (or decompression) results are stored

Implements CompressionIface.

Implemented in Decompressor< bzip2 >, Decompressor< lzo >, Decompressor< zlib >, Decompressor< rle >, Compressor< bzip2 >, Compressor< lzo >, Compressor< zlib >, and Compressor< rle >.

◆ setInputDataBlock() [1/2]

virtual void setInputDataBlock ( byte *  inBlock,
size_t  size,
size_t  offset 
)
pure virtual

Associates an input data block with a compressor (or decompressor)

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

Implements CompressionIface.

Implemented in Decompressor< bzip2 >, Decompressor< lzo >, Decompressor< zlib >, Decompressor< rle >, Compressor< bzip2 >, Compressor< lzo >, Compressor< zlib >, and Compressor< rle >.

◆ setInputDataBlock() [2/2]

virtual void setInputDataBlock ( DataBlock inBlock)
pure virtual

Associates an input data block with a compressor (or decompressor)

Parameters
[in]inBlockDataBlock to compress (or decompress)

Implements CompressionIface.

Implemented in Decompressor< bzip2 >, Decompressor< lzo >, Decompressor< zlib >, Decompressor< rle >, Compressor< bzip2 >, Compressor< lzo >, Compressor< zlib >, and Compressor< rle >.


The documentation for this class was generated from the following file:

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