C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 5

binary_confusion_matrix_types.h
1 /* file: binary_confusion_matrix_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Declaration of data types for computing the binary confusion matrix.
19 //--
20 */
21 
22 #ifndef __BINARY_CONFUSION_MATRIX_TYPES_H__
23 #define __BINARY_CONFUSION_MATRIX_TYPES_H__
24 
25 #include "algorithms/algorithm.h"
26 #include "data_management/data/homogen_numeric_table.h"
27 
28 namespace daal
29 {
30 namespace algorithms
31 {
32 namespace classifier
33 {
42 namespace quality_metric
43 {
53 namespace binary_confusion_matrix
54 {
59 enum Method
60 {
61  defaultDense = 0
62 };
63 
68 enum InputId
69 {
70  predictedLabels,
71  groundTruthLabels,
72  lastInputId = groundTruthLabels
73 };
74 
79 enum ResultId
80 {
81  confusionMatrix,
82  binaryMetrics,
83  lastResultId = binaryMetrics
84 };
85 
90 enum BinaryMetricsId
91 {
92  accuracy,
93  precision,
94  recall,
95  fscore,
96  specificity,
97  AUC,
98  lastBinaryMetricsId = AUC
99 };
100 
104 namespace interface1
105 {
112 /* [Parameter source code] */
113 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
114 {
115  Parameter(double beta = 1.0);
116  virtual ~Parameter() {}
117 
118  double beta;
120  services::Status check() const DAAL_C11_OVERRIDE;
121 };
122 /* [Parameter source code] */
123 
128 class DAAL_EXPORT Input : public daal::algorithms::Input
129 {
130 public:
131  Input();
132  Input(const Input& other) : daal::algorithms::Input(other){}
133 
134  virtual ~Input() {}
135 
141  data_management::NumericTablePtr get(InputId id) const;
142 
148  void set(InputId id, const data_management::NumericTablePtr &value);
149 
155  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
156 };
157 typedef services::SharedPtr<Input> InputPtr;
158 
164 class DAAL_EXPORT Result : public daal::algorithms::Result
165 {
166 public:
167  DECLARE_SERIALIZABLE_CAST(Result);
168  Result();
169  virtual ~Result() {}
170 
176  data_management::NumericTablePtr get(ResultId id) const;
177 
183  void set(ResultId id, const data_management::NumericTablePtr &value);
184 
191  template<typename algorithmFPType>
192  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
193 
200  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
201 
202 protected:
204  template<typename Archive, bool onDeserialize>
205  services::Status serialImpl(Archive *arch)
206  {
207  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
208  }
209 };
210 typedef services::SharedPtr<Result> ResultPtr;
211 } // namespace interface1
212 using interface1::Parameter;
213 using interface1::Input;
214 using interface1::InputPtr;
215 using interface1::Result;
216 using interface1::ResultPtr;
217 
218 }
220 } // namespace daal::algorithms::classifier::quality_metric
221 } // namespace daal::algorithms::classifier
222 } // namespace daal::algorithms
223 } // namespace daal
224 #endif
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::defaultDense
Definition: binary_confusion_matrix_types.h:61
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::Method
Method
Definition: binary_confusion_matrix_types.h:59
daal
Definition: algorithm_base_common.h:31
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::fscore
Definition: binary_confusion_matrix_types.h:95
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:128
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::accuracy
Definition: binary_confusion_matrix_types.h:92
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::precision
Definition: binary_confusion_matrix_types.h:93
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::recall
Definition: binary_confusion_matrix_types.h:94
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::predictedLabels
Definition: binary_confusion_matrix_types.h:70
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::BinaryMetricsId
BinaryMetricsId
Definition: binary_confusion_matrix_types.h:90
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::InputId
InputId
Definition: binary_confusion_matrix_types.h:68
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:164
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Parameter::beta
double beta
Definition: binary_confusion_matrix_types.h:118
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::specificity
Definition: binary_confusion_matrix_types.h:96
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::binaryMetrics
Definition: binary_confusion_matrix_types.h:82
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::confusionMatrix
Definition: binary_confusion_matrix_types.h:81
daal::algorithms::math::abs::value
Definition: abs_types.h:86
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::ResultId
ResultId
Definition: binary_confusion_matrix_types.h:79
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::groundTruthLabels
Definition: binary_confusion_matrix_types.h:71
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Parameter
Parameters for the binary confusion matrix compute() method.
Definition: binary_confusion_matrix_types.h:113
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::AUC
Definition: binary_confusion_matrix_types.h:97

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