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

compression.h
1 /* file: compression.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 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 compression and decompression interface.
45 //--
46 */
47 
48 #ifndef __COMPRESSION_H__
49 #define __COMPRESSION_H__
50 
51 #include "services/base.h"
52 #include "data_management/data/data_block.h"
53 #include "services/daal_defines.h"
54 #include "services/error_handling.h"
55 
56 namespace daal
57 {
58 namespace data_management
59 {
68 enum CompressionLevel
69 {
70  defaultLevel = -1,
71  level0 = 0,
72  level1,
73  level2,
74  level3,
75  level4,
76  level5,
77  level6,
78  level7,
79  level8,
80  level9,
81  lastCompressionLevel = level9
82 };
83 
88 enum CompressionMethod
89 {
90  zlib,
91  lzo,
92  rle,
93  bzip2
94 };
95 
99 namespace interface1
100 {
110 /* [CompressionParameter source code] */
111 struct DAAL_EXPORT CompressionParameter
112 {
113  CompressionLevel level;
119  CompressionParameter( CompressionLevel clevel = defaultLevel ) : level(clevel) {}
120 };
121 /* [CompressionParameter source code] */
122 
128 class DAAL_EXPORT CompressionIface
129 {
130 public:
137  virtual void setInputDataBlock( byte *inBlock, size_t size, size_t offset ) = 0;
142  virtual void setInputDataBlock( DataBlock &inBlock ) = 0;
147  virtual bool isOutputDataBlockFull() = 0;
152  virtual size_t getUsedOutputDataBlockSize() = 0;
159  virtual void run( byte *outBlock, size_t size, size_t offset ) = 0;
164  virtual void run( DataBlock &outBlock ) = 0;
165 
166  virtual ~CompressionIface() {}
167 };
168 
178 class DAAL_EXPORT Compression : public CompressionIface
179 {
180 public:
184  Compression(): _errors(new services::ErrorCollection())
185  {
186  this->_errors->setCanThrow(false);
187  _isOutBlockFull = false;
188  _usedOutBlockSize = 0;
189  }
190  virtual void setInputDataBlock( byte *inBlock, size_t size, size_t offset ) = 0;
191  virtual void setInputDataBlock( DataBlock &inBlock ) = 0;
192  bool isOutputDataBlockFull() { return _isOutBlockFull; }
193  size_t getUsedOutputDataBlockSize() { return _usedOutBlockSize; }
194  virtual void run( byte *outBlock, size_t size, size_t offset ) = 0;
195  virtual void run( DataBlock &outBlock ) = 0;
196  virtual ~Compression() {}
202  virtual void checkInputParams( byte *inBlock, size_t size )
203  {
204  if ( inBlock == NULL )
205  {
206  this->_errors->add(services::ErrorCompressionNullInputStream);
207  }
208  if ( size == 0 )
209  {
210  this->_errors->add(services::ErrorCompressionEmptyInputStream);
211  }
212  }
218  virtual void checkOutputParams( byte *outBlock, size_t size )
219  {
220  if ( outBlock == NULL )
221  {
222  this->_errors->add(services::ErrorCompressionNullOutputStream);
223  }
224  if ( size == 0 )
225  {
226  this->_errors->add(services::ErrorCompressionEmptyOutputStream);
227  }
228  }
229 
230  services::SharedPtr<services::ErrorCollection> getErrors()
231  {
232  return _errors;
233  }
234 
235 protected:
236  bool _isOutBlockFull;
237  size_t _usedOutBlockSize;
238 
239  services::SharedPtr<services::ErrorCollection> _errors;
240 };
241 
251 class DAAL_EXPORT CompressorImpl : public Compression
252 {
253 public:
257  CompressorImpl() : Compression()
258  {
259  _isInitialized = false;
260  }
261  virtual ~CompressorImpl() {}
262 
263 protected:
264  virtual void initialize() { _isInitialized = true; }
265  bool _isInitialized;
266 };
267 
277 class DAAL_EXPORT DecompressorImpl : public Compression
278 {
279 public:
283  DecompressorImpl() : Compression()
284  {
285  _isInitialized = false;
286  }
287  virtual ~DecompressorImpl() {}
288 
289 protected:
290  virtual void initialize() { _isInitialized = true; }
291  bool _isInitialized;
292 
293 };
294 
306 template<CompressionMethod dcmethod>
307 class DAAL_EXPORT Compressor : public CompressorImpl
308 {
309 public:
313  Compressor() : CompressorImpl() {}
314  virtual ~Compressor() {}
315 };
316 
328 template<CompressionMethod dcmethod>
329 class DAAL_EXPORT Decompressor : public DecompressorImpl
330 {
331 public:
335  Decompressor() : DecompressorImpl() {}
336  virtual ~Decompressor() {}
337 };
338 } // namespace interface1
339 using interface1::CompressionParameter;
340 using interface1::CompressionIface;
341 using interface1::Compression;
342 using interface1::CompressorImpl;
343 using interface1::DecompressorImpl;
344 using interface1::Compressor;
345 using interface1::Decompressor;
348 } // namespace data_management
349 } // namespace daal
350 #endif // __COMPRESSION_H
daal::data_management::level8
Definition: compression.h:79
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
Definition: algorithm_base_common.h:57
daal::data_management::interface1::CompressorImpl::CompressorImpl
CompressorImpl()
Compressor constructor
Definition: compression.h:257
daal::services::ErrorCompressionEmptyInputStream
Definition: error_indexes.h:304
daal::data_management::interface1::Compression::checkOutputParams
virtual void checkOutputParams(byte *outBlock, size_t size)
Definition: compression.h:218
daal::data_management::level2
Definition: compression.h:73
daal::data_management::level7
Definition: compression.h:78
daal::data_management::interface1::Compression::checkInputParams
virtual void checkInputParams(byte *inBlock, size_t size)
Definition: compression.h:202
daal::data_management::interface1::Decompressor::Decompressor
Decompressor()
Decompressor constructor
Definition: compression.h:335
daal::data_management::CompressionLevel
CompressionLevel
Compression levels
Definition: compression.h:68
daal::data_management::defaultLevel
Definition: compression.h:70
daal_defines.h
daal::data_management::level4
Definition: compression.h:75
daal::data_management::interface1::CompressorImpl
Base class for the Compressor.
Definition: compression.h:251
daal::data_management::level0
Definition: compression.h:71
daal::data_management::interface1::CompressionParameter::CompressionParameter
CompressionParameter(CompressionLevel clevel=defaultLevel)
Definition: compression.h:119
daal::data_management::interface1::Compression
Base class for compression and decompression
Definition: compression.h:178
daal::data_management::rle
Definition: compression.h:92
daal::data_management::interface1::CompressionIface
Abstract interface class for compression and decompression.
Definition: compression.h:128
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::CompressionMethod
CompressionMethod
Compression methods
Definition: compression.h:88
daal::data_management::interface1::Compression::getUsedOutputDataBlockSize
size_t getUsedOutputDataBlockSize()
Definition: compression.h:193
daal::data_management::level1
Definition: compression.h:72
daal::services::ErrorCompressionEmptyOutputStream
Definition: error_indexes.h:305
daal::data_management::lzo
Definition: compression.h:91
daal::data_management::interface1::CompressionParameter::level
CompressionLevel level
Definition: compression.h:113
daal::data_management::interface1::CompressionParameter
Parameters for compression and decompression.
Definition: compression.h:111
daal::data_management::level6
Definition: compression.h:77
daal::data_management::bzip2
Definition: compression.h:93
daal::algorithms::implicit_als::training::offset
Definition: implicit_als_training_types.h:174
daal::data_management::interface1::Compressor::Compressor
Compressor()
Compressor constructor
Definition: compression.h:313
daal::data_management::level3
Definition: compression.h:74
daal::data_management::interface1::DecompressorImpl
Base class for the Decompressor.
Definition: compression.h:277
daal::data_management::zlib
Definition: compression.h:90
daal::data_management::level9
Definition: compression.h:80
daal::data_management::interface1::Compression::isOutputDataBlockFull
bool isOutputDataBlockFull()
Definition: compression.h:192
daal::services::ErrorCompressionNullInputStream
Definition: error_indexes.h:301
daal::data_management::interface1::DecompressorImpl::DecompressorImpl
DecompressorImpl()
Decompressor constructor
Definition: compression.h:283
daal::data_management::interface1::Compression::Compression
Compression()
Compression constructor.
Definition: compression.h:184
daal::services::ErrorCompressionNullOutputStream
Definition: error_indexes.h:302
daal::data_management::level5
Definition: compression.h:76
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.