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

algorithm_quality_metric_set_types.h
1 /* file: algorithm_quality_metric_set_types.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 // Interface for the quality metric set.
45 //--
46 */
47 
48 #ifndef __ALGORITHM_QUALITY_METRIC_SET_TYPES_H__
49 #define __ALGORITHM_QUALITY_METRIC_SET_TYPES_H__
50 
51 #include "data_management/data/input_collection.h"
52 #include "algorithms/algorithm_quality_metric_batch.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace quality_metric_set
59 {
60 
64 namespace interface1
65 {
74 class DAAL_EXPORT InputAlgorithmsCollection
75 {
76 public:
81  InputAlgorithmsCollection(size_t n = 0);
82 
83  virtual ~InputAlgorithmsCollection();
84 
90  const services::SharedPtr<quality_metric::Batch>& operator[](size_t k) const;
91 
98  services::SharedPtr<quality_metric::Batch>& operator[](size_t k);
99 
104  size_t size() const;
105 
109  void clear();
110 
116  size_t getKeyByIndex(int idx);
117 
118 protected:
119  services::Collection<services::SharedPtr<quality_metric::Batch> > _qualityMetrics;
120  services::Collection<size_t> _keys;
121  services::SharedPtr<quality_metric::Batch> *nullPtr;
122 };
123 
128 class DAAL_EXPORT InputDataCollection : public data_management::KeyValueInputCollection
129 {
130 public:
131  InputDataCollection();
132 
138  void add(size_t k, const algorithms::InputPtr& ptr);
139 
145  algorithms::InputPtr getInput(size_t key) const;
146 
147  virtual ~InputDataCollection() {}
148 };
149 typedef services::SharedPtr<InputDataCollection> InputDataCollectionPtr;
150 
155 class DAAL_EXPORT ResultCollection : public data_management::KeyValueDataCollection
156 {
157 public:
158  ResultCollection();
159 
160  void add(size_t key, const algorithms::ResultPtr& ptr);
161 
162  algorithms::ResultPtr getResult(size_t key) const;
163 
164  virtual ~ResultCollection() {}
165 };
166 typedef services::SharedPtr<ResultCollection> ResultCollectionPtr;
168 } // namespace interface1
169 using interface1::InputAlgorithmsCollection;
170 using interface1::InputDataCollection;
171 using interface1::InputDataCollectionPtr;
172 using interface1::ResultCollection;
173 using interface1::ResultCollectionPtr;
174 
175 } // namespace quality_metric_set
176 } // namespace algorithms
177 } // namespace daal
178 #endif
daal
Definition: algorithm_base_common.h:57
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::algorithms::quality_metric_set::interface1::InputDataCollection
Class that implements functionality of the collection of input objects of the quality metrics algorit...
Definition: algorithm_quality_metric_set_types.h:128
daal::algorithms::quality_metric_set::interface1::InputAlgorithmsCollection
Class that implements functionality of the collection of quality metrics algorithms.
Definition: algorithm_quality_metric_set_types.h:74
daal::algorithms::quality_metric_set::interface1::ResultCollection
Class that implements functionality of the collection of result objects of the quality metrics algori...
Definition: algorithm_quality_metric_set_types.h:155
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.