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

List of all members
CompressionStream Class Reference

CompressionStream class compresses input raw data by blocks. More...

Class Declaration

References

Constructor & Destructor Documentation

◆ CompressionStream()

CompressionStream ( CompressorImpl compr,
size_t  minSize = 1024 *64 
)

CompressionStream constructor

Parameters
comprPointer to a specific Compressor used for compression
minSizeOptional parameter, minimal size of internal data blocks

Member Function Documentation

◆ copyCompressedArray() [1/2]

virtual size_t copyCompressedArray ( byte *  outPtr,
size_t  outSize 
)
virtual

Copies compressed data stored in CompressionStream to an external array

Parameters
[out]outPtrPointer to the array where compressed data is stored
[in]outSizeNumber of bytes available in external memory
Returns
Size of copied data in bytes

◆ copyCompressedArray() [2/2]

virtual size_t copyCompressedArray ( DataBlock outBlock)
inlinevirtual

Copies compressed data stored in CompressionStream to an external DataBlock

Parameters
[out]outBlockReference to the DataBlock where compressed data is stored
Returns
Size of copied data in bytes

◆ getCompressedBlocksCollection()

virtual DataBlockCollectionPtr getCompressedBlocksCollection ( )
virtual

Provides access to compressed data blocks stored in CompressionStream

Returns
Pointer to an internal DataBlockCollection

◆ getCompressedDataSize()

virtual size_t getCompressedDataSize ( )
virtual

Returns the size of compressed data stored in CompressionStream

Returns
Size in bytes

◆ operator<<() [1/2]

virtual void operator<< ( DataBlock inBlock)
inlinevirtual

Writes the next DataBlock to CompressionStream and compresses it

Parameters
[in]inBlockPointer to the next DataBlock to be compressed

◆ operator<<() [2/2]

virtual void operator<< ( DataBlock  inBlock)
inlinevirtual

Writes the next DataBlock to CompressionStream and compresses it

Parameters
[in]inBlockNext DataBlock to be compressed

◆ push_back()

virtual void push_back ( DataBlock inBlock)
virtual

Writes the next DataBlock to CompressionStream and compresses it

Parameters
[in]inBlockPointer to the next DataBlock to be compressed

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

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