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

lzocompression.h
1 /* file: lzocompression.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the LZO1X_11 compression and decompression interface.
45 //--
46 */
47 
48 #ifndef __LZOCOMPRESSION_H__
49 #define __LZOCOMPRESSION_H__
50 #include "data_management/compression/compression.h"
51 
52 namespace daal
53 {
54 namespace data_management
55 {
56 
57 namespace interface1
58 {
73 /* [LzoCompressionParameter source code] */
74 class DAAL_EXPORT LzoCompressionParameter : public data_management::CompressionParameter
75 {
76 public:
82  LzoCompressionParameter( size_t _preHeadBytes = 0, size_t _postHeadBytes = 0 ) :
83  data_management::CompressionParameter(defaultLevel), preHeadBytes(_preHeadBytes), postHeadBytes(_postHeadBytes)
84  {}
85  ~LzoCompressionParameter() {}
86 
87  size_t preHeadBytes;
88  size_t postHeadBytes;
89 };
90 /* [LzoCompressionParameter source code] */
91 
102 template<> class DAAL_EXPORT Compressor<lzo> : public data_management::CompressorImpl
103 {
104 public:
108  Compressor();
109  ~Compressor();
116  void setInputDataBlock( byte *inBlock, size_t size, size_t offset );
121  void setInputDataBlock( DataBlock &inBlock )
122  {
123  setInputDataBlock( inBlock.getPtr(), inBlock.getSize(), 0 );
124  }
125 
132  void run( byte *outBlock, size_t size, size_t offset );
137  void run( DataBlock &outBlock )
138  {
139  run( outBlock.getPtr(), outBlock.getSize(), 0 );
140  }
141 
142  LzoCompressionParameter parameter;
144 protected:
145  void initialize();
146 
147 private:
148  void *_next_in;
149  size_t _avail_in;
150  void *_next_out;
151  size_t _avail_out;
152  void *_p_lzo_state;
153  size_t _preHeadBytes;
154  size_t _postHeadBytes;
155 
156  void finalizeCompression();
157 };
158 
169 template<> class DAAL_EXPORT Decompressor<lzo> : public data_management::DecompressorImpl
170 {
171 public:
175  Decompressor();
176  ~Decompressor();
183  void setInputDataBlock( byte *inBlock, size_t size, size_t offset );
184 
189  void setInputDataBlock( DataBlock &inBlock )
190  {
191  return setInputDataBlock( inBlock.getPtr(), inBlock.getSize(), 0 );
192  }
193 
200  void run( byte *outBlock, size_t size, size_t offset );
201 
206  void run( DataBlock &outBlock )
207  {
208  run( outBlock.getPtr(), outBlock.getSize(), 0 );
209  }
210 
211  LzoCompressionParameter parameter;
213 protected:
214  void initialize();
215 
216 private:
217  void *_next_in;
218  size_t _avail_in;
219  void *_next_out;
220  size_t _avail_out;
221  void *_p_lzo_state;
222  size_t _preHeadBytes;
223  size_t _postHeadBytes;
224 
225  void *_internalBuff;
226  size_t _internalBuffOff;
227  size_t _internalBuffLen;
228 
229  void finalizeCompression();
230 };
232 } // namespace interface1
233 using interface1::LzoCompressionParameter;
234 using interface1::Compressor;
235 using interface1::Decompressor;
236 
237 } //namespace data_management
238 } //namespace daal
239 #endif //__LZOCOMPRESSION_H
daal::data_management::interface1::Compressor
Compressor class compresses an input data block and writes results into an output data block...
Definition: compression.h:307
daal::data_management::interface1::LzoCompressionParameter::LzoCompressionParameter
LzoCompressionParameter(size_t _preHeadBytes=0, size_t _postHeadBytes=0)
Definition: lzocompression.h:82
daal::data_management::interface1::LzoCompressionParameter::preHeadBytes
size_t preHeadBytes
Definition: lzocompression.h:87
daal
Definition: algorithm_base_common.h:57
daal::data_management::defaultLevel
Definition: compression.h:70
daal::data_management::interface1::DataBlock::getPtr
virtual byte * getPtr() const DAAL_C11_OVERRIDE
Definition: data_block.h:149
daal::data_management::interface1::CompressorImpl
Base class for the Compressor.
Definition: compression.h:251
daal::data_management::interface1::DataBlock::getSize
virtual size_t getSize() const DAAL_C11_OVERRIDE
Definition: data_block.h:159
daal::data_management::interface1::Decompressor< lzo >::parameter
LzoCompressionParameter parameter
Definition: lzocompression.h:211
daal::data_management::interface1::LzoCompressionParameter
Parameter for LZO compression and decompression. LZO compressed block header consists of four section...
Definition: lzocompression.h:74
daal::data_management::interface1::LzoCompressionParameter::postHeadBytes
size_t postHeadBytes
Definition: lzocompression.h:88
daal::data_management::interface1::Decompressor
Decompressor class decompresses an input data block and writes results into an output data block...
Definition: compression.h:329
daal::data_management::interface1::Compressor< lzo >::parameter
LzoCompressionParameter parameter
Definition: lzocompression.h:142
daal::data_management::lzo
Definition: compression.h:91
daal::data_management::interface1::CompressionParameter
Parameters for compression and decompression.
Definition: compression.h:111
daal::data_management::interface1::Decompressor< lzo >::setInputDataBlock
void setInputDataBlock(DataBlock &inBlock)
Definition: lzocompression.h:189
daal::data_management::interface1::Compressor< lzo >::setInputDataBlock
void setInputDataBlock(DataBlock &inBlock)
Definition: lzocompression.h:121
daal::data_management::interface1::DecompressorImpl
Base class for the Decompressor.
Definition: compression.h:277
daal::data_management::interface1::Compressor< lzo >::run
void run(DataBlock &outBlock)
Definition: lzocompression.h:137
daal::data_management::interface1::Decompressor< lzo >::run
void run(DataBlock &outBlock)
Definition: lzocompression.h:206
daal::data_management::interface1::DataBlock
Class that stores a pointer to a byte array and its size. Not responsible for memory management...
Definition: data_block.h:109

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