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

List of all members
DecompressionStream Class Reference

DecompressionStream class decompresses compressed input data by blocks. More...

Class Declaration

References

Constructor & Destructor Documentation

◆ DecompressionStream()

DecompressionStream ( DecompressorImpl decompr,
size_t  minSize = 1024 *64 
)
Parameters
decomprPointer to a specific Decompressor used for decompression
minSizeOptional parameter, minimal size of internal data blocks

Member Function Documentation

◆ copyDecompressedArray() [1/2]

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

Copies decompressed data stored in DecompressionStream to an external array

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

◆ copyDecompressedArray() [2/2]

virtual size_t copyDecompressedArray ( DataBlock outBlock)
inlinevirtual

Copies decompressed data stored in DecompressionStream to an external DataBlock

Parameters
[out]outBlockReference to the DataBlock where decompressed data is stored. Size of DataBlock must be at least getDecompressedSize() bytes

◆ getDecompressedBlocksCollection()

virtual DataBlockCollectionPtr getDecompressedBlocksCollection ( )
virtual

Provides access to decompressed data blocks stored in DecompressionStream

Returns
Pointer to internal DataBlockCollection

◆ getDecompressedDataSize()

virtual size_t getDecompressedDataSize ( )
virtual

Returns the size of decompressed data stored in DecompressionStream

Returns
Size in bytes

◆ operator<<() [1/2]

virtual void operator<< ( DataBlock inBlock)
inlinevirtual

Writes the next compressed DataBlock to DecompressionStream and decompresses it

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

◆ operator<<() [2/2]

virtual void operator<< ( DataBlock  inBlock)
inlinevirtual

Writes the next compressed DataBlock to DecompressionStream and decompresses it

Parameters
[in]inBlockNext DataBlock to be decompressed

◆ push_back()

virtual void push_back ( DataBlock inBlock)
virtual

Writes the next compressed DataBlock to DecompressionStream and decompresses it

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

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

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