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

binary_confusion_matrix_types.h
1 /* file: binary_confusion_matrix_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 // Declaration of data types for computing the binary confusion matrix.
45 //--
46 */
47 
48 #ifndef __BINARY_CONFUSION_MATRIX_TYPES_H__
49 #define __BINARY_CONFUSION_MATRIX_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/homogen_numeric_table.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace classifier
59 {
68 namespace quality_metric
69 {
79 namespace binary_confusion_matrix
80 {
85 enum Method
86 {
87  defaultDense = 0
88 };
89 
94 enum InputId
95 {
96  predictedLabels,
97  groundTruthLabels,
98  lastInputId = groundTruthLabels
99 };
100 
105 enum ResultId
106 {
107  confusionMatrix,
108  binaryMetrics,
109  lastResultId = binaryMetrics
110 };
111 
116 enum BinaryMetricsId
117 {
118  accuracy,
119  precision,
120  recall,
121  fscore,
122  specificity,
123  AUC,
124  lastBinaryMetricsId = AUC
125 };
126 
130 namespace interface1
131 {
138 /* [Parameter source code] */
139 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
140 {
141  Parameter(double beta = 1.0);
142  virtual ~Parameter() {}
143 
144  double beta;
146  services::Status check() const DAAL_C11_OVERRIDE;
147 };
148 /* [Parameter source code] */
149 
154 class DAAL_EXPORT Input : public daal::algorithms::Input
155 {
156 public:
157  Input();
158  Input(const Input& other) : daal::algorithms::Input(other){}
159 
160  virtual ~Input() {}
161 
167  data_management::NumericTablePtr get(InputId id) const;
168 
174  void set(InputId id, const data_management::NumericTablePtr &value);
175 
181  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
182 };
183 typedef services::SharedPtr<Input> InputPtr;
184 
190 class DAAL_EXPORT Result : public daal::algorithms::Result
191 {
192 public:
193  DECLARE_SERIALIZABLE_CAST(Result);
194  Result();
195  virtual ~Result() {}
196 
202  data_management::NumericTablePtr get(ResultId id) const;
203 
209  void set(ResultId id, const data_management::NumericTablePtr &value);
210 
217  template<typename algorithmFPType>
218  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
219 
226  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
227 
228 protected:
230  template<typename Archive, bool onDeserialize>
231  services::Status serialImpl(Archive *arch)
232  {
233  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
234  }
235 };
236 typedef services::SharedPtr<Result> ResultPtr;
237 } // namespace interface1
238 using interface1::Parameter;
239 using interface1::Input;
240 using interface1::InputPtr;
241 using interface1::Result;
242 using interface1::ResultPtr;
243 
244 }
246 } // namespace daal::algorithms::classifier::quality_metric
247 } // namespace daal::algorithms::classifier
248 } // namespace daal::algorithms
249 } // namespace daal
250 #endif
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::defaultDense
Definition: binary_confusion_matrix_types.h:87
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::algorithms::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:331
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::groundTruthLabels
Definition: binary_confusion_matrix_types.h:97
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::ResultId
ResultId
Definition: binary_confusion_matrix_types.h:105
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Input
Base class for input objects of the binary confusion matrix algorithm.
Definition: binary_confusion_matrix_types.h:154
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::accuracy
Definition: binary_confusion_matrix_types.h:118
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::recall
Definition: binary_confusion_matrix_types.h:120
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::Method
Method
Definition: binary_confusion_matrix_types.h:85
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::AUC
Definition: binary_confusion_matrix_types.h:123
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::specificity
Definition: binary_confusion_matrix_types.h:122
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
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::classifier::quality_metric::binary_confusion_matrix::BinaryMetricsId
BinaryMetricsId
Definition: binary_confusion_matrix_types.h:116
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Result
Results obtained with the compute() method of the binary confusion matrix algorithm in the batch proc...
Definition: binary_confusion_matrix_types.h:190
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Parameter::beta
double beta
Definition: binary_confusion_matrix_types.h:144
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::confusionMatrix
Definition: binary_confusion_matrix_types.h:107
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::binaryMetrics
Definition: binary_confusion_matrix_types.h:108
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::InputId
InputId
Definition: binary_confusion_matrix_types.h:94
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::precision
Definition: binary_confusion_matrix_types.h:119
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::predictedLabels
Definition: binary_confusion_matrix_types.h:96
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::fscore
Definition: binary_confusion_matrix_types.h:121
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Parameter
Parameters for the binary confusion matrix compute() method.
Definition: binary_confusion_matrix_types.h:139

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