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

data_collection.h
1 /* file: data_collection.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 #ifndef __DATA_COLLECTION_H__
43 #define __DATA_COLLECTION_H__
44 
45 #include "services/daal_defines.h"
46 #include "data_management/data/data_serialize.h"
47 #include "data_management/data/data_archive.h"
48 #include "services/daal_shared_ptr.h"
49 #include "services/collection.h"
50 
51 namespace daal
52 {
53 namespace data_management
54 {
55 
56 namespace interface1
57 {
64 typedef services::SharedPtr<SerializationIface> SerializationIfacePtr;
65 
71 class DAAL_EXPORT DataCollection : public SerializationIface, private services::Collection<SerializationIfacePtr >
72 {
73 public:
74  DECLARE_SERIALIZABLE_TAG();
75 
76  typedef services::Collection<SerializationIfacePtr> super;
77 
78  DAAL_CAST_OPERATOR(DataCollection);
79 
81  DataCollection();
82 
84  DataCollection(const DataCollection &other);
85 
90  DataCollection(size_t n);
91 
92  virtual ~DataCollection() {};
93 
99  const SerializationIfacePtr &operator[](size_t index) const;
100 
106  SerializationIfacePtr &operator[](size_t index);
107 
113  SerializationIfacePtr &get(size_t index);
114 
120  const SerializationIfacePtr &get(size_t index) const;
121 
126  DataCollection &push_back(const SerializationIfacePtr &x);
127 
132  DataCollection &operator << (const SerializationIfacePtr &x);
133 
138  size_t size() const;
139 
143  void clear();
144 
149  void erase(size_t pos);
150 
155  bool resize(size_t newCapacity);
156 
157  services::Status serializeImpl(interface1::InputDataArchive *arch) DAAL_C11_OVERRIDE
158  {
159  return serialImpl<interface1::InputDataArchive, false>( arch );
160  }
161 
162  services::Status deserializeImpl(const interface1::OutputDataArchive *arch) DAAL_C11_OVERRIDE
163  {
164  return serialImpl<const interface1::OutputDataArchive, true>( arch );
165  }
166 
167  template<typename Archive, bool onDeserialize>
168  services::Status serialImpl(Archive *arch)
169  {
170  size_t size = _size;
171 
172  arch->set(size);
173 
174  if( onDeserialize )
175  {
176  resize(size);
177  }
178 
179  _size = size;
180 
181  for(size_t i = 0; i < _size; i++)
182  {
183  arch->setSharedPtrObj(_array[i]);
184  }
185 
186  return services::Status();
187  }
188 };
189 typedef services::SharedPtr<DataCollection> DataCollectionPtr;
190 
196 template<typename T>
197 class DAAL_EXPORT KeyValueCollection
198 {
199 public:
200  DAAL_CAST_OPERATOR(KeyValueCollection);
201 
203  KeyValueCollection() {}
205  KeyValueCollection(const KeyValueCollection &other) : _keys(other._keys), _values(other._values) {}
206 
207  KeyValueCollection(const services::Collection<size_t> &keys, const services::Collection<services::SharedPtr<T> > &values)
208  {
209  for(size_t i = 0; i < keys.size(); i++)
210  {
211  _keys.push_back(keys[i]);
212  _values.push_back(values[i]);
213  }
214  }
215 
216  virtual ~KeyValueCollection()
217  {}
218 
224  const services::SharedPtr<T> &operator[] (size_t k) const
225  {
226  size_t i;
227  for( i = 0; i < _keys.size(); i++ )
228  {
229  if( _keys[i] == k )
230  {
231  return _values[i];
232  }
233  }
234  return _nullPtr;
235  }
236 
242  services::SharedPtr<T> &operator[] (size_t k);
243 
249  size_t getKeyByIndex(int idx) const
250  {
251  return _keys[idx];
252  }
253 
259  services::SharedPtr<T> &getValueByIndex(int idx)
260  {
261  return _values[idx];
262  }
263 
269  const services::SharedPtr<T> getValueByIndex(int idx) const
270  {
271  return _values[idx];
272  }
273 
278  size_t size() const
279  {
280  return _keys.size();
281  }
282 
286  void clear()
287  {
288  _keys.clear();
289  _values.clear();
290  }
291 
292 protected:
293  services::Collection<size_t> _keys;
294  services::Collection<services::SharedPtr<T> > _values;
295  services::SharedPtr<T> _nullPtr;
296 };
297 
303 template<typename T>
304 class DAAL_EXPORT SerializableKeyValueCollection : public SerializationIface, public KeyValueCollection<T>
305 {
306 public:
307  DECLARE_SERIALIZABLE_TAG();
308 
309  DAAL_CAST_OPERATOR(SerializableKeyValueCollection);
310 
312  SerializableKeyValueCollection() : KeyValueCollection<T>() {}
314  SerializableKeyValueCollection(const SerializableKeyValueCollection &other) : KeyValueCollection<T>(other) {}
315 
316  SerializableKeyValueCollection(const services::Collection<size_t> &keys, const services::Collection<services::SharedPtr<T> > &values) : KeyValueCollection<T>(keys, values) {}
317 
318  virtual ~SerializableKeyValueCollection() {}
319 
321  services::Status serializeImpl(interface1::InputDataArchive *arch) DAAL_C11_OVERRIDE
322  {
323  return serialImpl<interface1::InputDataArchive, false>( arch );
324  }
325 
327  services::Status deserializeImpl(const interface1::OutputDataArchive *arch) DAAL_C11_OVERRIDE
328  {
329  return serialImpl<const interface1::OutputDataArchive, true>( arch );
330  }
331 
333  template<typename Archive, bool onDeserialize>
334  services::Status serialImpl( Archive *arch )
335  {
336  size_t size = this->_values.size();
337 
338  arch->set(size);
339 
340  if( onDeserialize )
341  {
342  this->_values.resize(size);
343  this->_keys.resize(size);
344  }
345 
346  for(size_t i = 0; i < size; i++)
347  {
348  if( onDeserialize )
349  {
350  this->_values.push_back(this->_nullPtr);
351  this->_keys.push_back(0);
352  }
353  arch->setSharedPtrObj(this->_values[i]);
354  arch->set(this->_keys[i]);
355  }
356 
357  return services::Status();
358  }
359 };
360 
361 typedef SerializableKeyValueCollection<SerializationIface> KeyValueDataCollection;
362 typedef services::SharedPtr<KeyValueDataCollection> KeyValueDataCollectionPtr;
363 typedef services::SharedPtr<const KeyValueDataCollection> KeyValueDataCollectionConstPtr;
365 } // namespace interface1
366 using interface1::DataCollection;
367 using interface1::DataCollectionPtr;
368 using interface1::KeyValueCollection;
369 using interface1::SerializableKeyValueCollection;
370 using interface1::KeyValueDataCollection;
371 using interface1::KeyValueDataCollectionPtr;
372 using interface1::KeyValueDataCollectionConstPtr;
373 using interface1::SerializationIfacePtr;
374 
375 }
376 }
377 
378 #endif
daal::data_management::interface1::KeyValueCollection::KeyValueCollection
KeyValueCollection()
Definition: data_collection.h:203
daal::data_management::interface1::DataCollection::deserializeImpl
services::Status deserializeImpl(const interface1::OutputDataArchive *arch) DAAL_C11_OVERRIDE
Definition: data_collection.h:162
daal::data_management::interface1::KeyValueCollection::getValueByIndex
services::SharedPtr< T > & getValueByIndex(int idx)
Definition: data_collection.h:259
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::data_management::interface1::InputDataArchive
Provides methods to create an archive data object (serialized) and access this object.
Definition: data_archive.h:715
daal::data_management::interface1::SerializableKeyValueCollection
Class that provides functionality of a key-value container for objects derived from the Serialization...
Definition: data_collection.h:304
daal::data_management::interface1::DataCollection
Class that provides functionality of Collection container for objects derived from SerializationIface...
Definition: data_collection.h:71
daal::data_management::interface1::KeyValueCollection
Class that provides functionality of a key-value container for objects derived from the T with a key ...
Definition: data_collection.h:197
daal::data_management::interface1::KeyValueCollection::clear
void clear()
Definition: data_collection.h:286
daal_defines.h
daal::data_management::interface1::SerializableKeyValueCollection::SerializableKeyValueCollection
SerializableKeyValueCollection(const SerializableKeyValueCollection &other)
Definition: data_collection.h:314
daal::data_management::interface1::KeyValueCollection::getKeyByIndex
size_t getKeyByIndex(int idx) const
Definition: data_collection.h:249
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::data_management::interface1::OutputDataArchive
Provides methods to restore an object from its serialized counterpart and access the restored object...
Definition: data_archive.h:978
daal::data_management::interface1::KeyValueCollection::getValueByIndex
const services::SharedPtr< T > getValueByIndex(int idx) const
Definition: data_collection.h:269
daal::data_management::interface1::SerializableKeyValueCollection::SerializableKeyValueCollection
SerializableKeyValueCollection()
Definition: data_collection.h:312
daal::services::interface1::Collection::size
size_t size() const
Definition: collection.h:144
daal::data_management::interface1::DataCollection::serializeImpl
services::Status serializeImpl(interface1::InputDataArchive *arch) DAAL_C11_OVERRIDE
Definition: data_collection.h:157
daal::data_management::interface1::KeyValueCollection::KeyValueCollection
KeyValueCollection(const KeyValueCollection &other)
Definition: data_collection.h:205
daal::data_management::interface1::KeyValueCollection::size
size_t size() const
Definition: data_collection.h:278
daal::data_management::interface1::SerializationIface
Abstract interface class that defines the interface for serialization and deserialization.
Definition: data_serialize.h:76
daal::algorithms::kernel_function::values
Definition: kernel_function_types.h:96
daal::services::interface1::Collection
Class that implements functionality of the Collection container.
Definition: collection.h:69

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