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

multiclass_confusion_matrix_types.h
1 /* file: multiclass_confusion_matrix_types.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 // Declaration of data types for multi-class confusion matrix.
45 //--
46 */
47 
48 #ifndef __MULTICLASS_CONFUSION_MATRIX_TYPES_H__
49 #define __MULTICLASS_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 {
63 namespace quality_metric
64 {
74 namespace multiclass_confusion_matrix
75 {
80 enum Method
81 {
82  defaultDense = 0
83 };
84 
89 enum InputId
90 {
91  predictedLabels,
92  groundTruthLabels,
93  lastInputId = groundTruthLabels
94 };
95 
100 enum ResultId
101 {
102  confusionMatrix,
103  multiClassMetrics,
104  lastResultId = multiClassMetrics
105 };
106 
111 enum MultiClassMetricsId
112 {
113  averageAccuracy,
114  errorRate,
115  microPrecision,
116  microRecall,
117  microFscore,
118  macroPrecision,
119  macroRecall,
120  macroFscore
121 };
122 
126 namespace interface1
127 {
134 /* [Parameter source code] */
135 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
136 {
137  Parameter(size_t nClasses = 0, double beta = 1.0);
138  virtual ~Parameter() {}
139 
140  size_t nClasses;
141  double beta;
143  services::Status check() const DAAL_C11_OVERRIDE;
144 };
145 /* [Parameter source code] */
146 
151 class DAAL_EXPORT Input : public daal::algorithms::Input
152 {
153 public:
154  Input();
155  Input(const Input& other) : daal::algorithms::Input(other){}
156 
157  virtual ~Input() {}
158 
164  data_management::NumericTablePtr get(InputId id) const;
165 
171  void set(InputId id, const data_management::NumericTablePtr &value);
172 
178  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
179 };
180 typedef services::SharedPtr<Input> InputPtr;
181 
187 class DAAL_EXPORT Result : public daal::algorithms::Result
188 {
189 public:
190  DECLARE_SERIALIZABLE_CAST(Result);
191  Result();
192  virtual ~Result() {}
193 
199  data_management::NumericTablePtr get(ResultId id) const;
200 
206  void set(ResultId id, const data_management::NumericTablePtr &value);
207 
214  template<typename algorithmFPType>
215  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
216 
223  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
224 
225 protected:
227  template<typename Archive, bool onDeserialize>
228  services::Status serialImpl(Archive *arch)
229  {
230  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
231  }
232 };
233 typedef services::SharedPtr<Result> ResultPtr;
234 } // namespace interface1
235 using interface1::Parameter;
236 using interface1::Input;
237 using interface1::InputPtr;
238 using interface1::Result;
239 using interface1::ResultPtr;
240 
241 } // namespace daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix
243 } // namespace daal::algorithms::classifier::quality_metric
244 } // namespace daal::algorithms::classifier
245 } // namespace daal::algorithms
246 } // namespace daal
247 #endif
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::macroPrecision
Definition: multiclass_confusion_matrix_types.h:118
daal
Definition: algorithm_base_common.h:57
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::macroRecall
Definition: multiclass_confusion_matrix_types.h:119
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::confusionMatrix
Definition: multiclass_confusion_matrix_types.h:102
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::microRecall
Definition: multiclass_confusion_matrix_types.h:116
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::microPrecision
Definition: multiclass_confusion_matrix_types.h:115
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::predictedLabels
Definition: multiclass_confusion_matrix_types.h:91
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::interface1::Parameter::nClasses
size_t nClasses
Definition: multiclass_confusion_matrix_types.h:140
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::interface1::Parameter
Parameters for the compute() method of the multi-class confusion matrix.
Definition: multiclass_confusion_matrix_types.h:135
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::microFscore
Definition: multiclass_confusion_matrix_types.h:117
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::Method
Method
Definition: multiclass_confusion_matrix_types.h:80
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::averageAccuracy
Definition: multiclass_confusion_matrix_types.h:113
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::multiClassMetrics
Definition: multiclass_confusion_matrix_types.h:103
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::interface1::Input
Base class for the input objects of the confusion matrix algorithm in the training stage of the class...
Definition: multiclass_confusion_matrix_types.h:151
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::interface1::Result
Results obtained with the compute() method of the multi-class confusion matrix algorithm in the batch...
Definition: multiclass_confusion_matrix_types.h:187
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::defaultDense
Definition: multiclass_confusion_matrix_types.h:82
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::interface1::Parameter::beta
double beta
Definition: multiclass_confusion_matrix_types.h:141
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::errorRate
Definition: multiclass_confusion_matrix_types.h:114
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::macroFscore
Definition: multiclass_confusion_matrix_types.h:120
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::InputId
InputId
Definition: multiclass_confusion_matrix_types.h:89
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::groundTruthLabels
Definition: multiclass_confusion_matrix_types.h:92
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::MultiClassMetricsId
MultiClassMetricsId
Definition: multiclass_confusion_matrix_types.h:111
daal::algorithms::classifier::quality_metric::multiclass_confusion_matrix::ResultId
ResultId
Definition: multiclass_confusion_matrix_types.h:100

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