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

binary_confusion_matrix_batch.h
1 /* file: binary_confusion_matrix_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Interface for the binary confusion matrix algorithm in the batch processing mode
21 //--
22 */
23 
24 #ifndef __BINARY_CONFUSION_MATRIX_BATCH_H__
25 #define __BINARY_CONFUSION_MATRIX_BATCH_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "algorithms/classifier/binary_confusion_matrix_types.h"
29 
30 namespace daal
31 {
32 namespace algorithms
33 {
34 namespace classifier
35 {
36 namespace quality_metric
37 {
38 namespace binary_confusion_matrix
39 {
40 
41 namespace interface1
42 {
55 template<typename algorithmFPType, Method method, CpuType cpu>
56 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
57 {
58 public:
64  BatchContainer(daal::services::Environment::env *daalEnv);
66  virtual ~BatchContainer();
70  virtual services::Status compute() DAAL_C11_OVERRIDE;
71 };
72 
86 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
87 class DAAL_EXPORT Batch : public daal::algorithms::quality_metric::Batch
88 {
89 public:
90  typedef algorithms::classifier::quality_metric::binary_confusion_matrix::Input InputType;
91  typedef algorithms::classifier::quality_metric::binary_confusion_matrix::Parameter ParameterType;
92  typedef algorithms::classifier::quality_metric::binary_confusion_matrix::Result ResultType;
93 
94  InputType input;
95  ParameterType parameter;
98  Batch()
99  {
100  initialize();
101  }
102 
109  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
110  {
111  initialize();
112  }
113 
118  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
119 
124  ResultPtr getResult() const
125  {
126  return _result;
127  }
128 
133  services::Status setResult(const ResultPtr& result)
134  {
135  DAAL_CHECK(result, services::ErrorNullResult)
136  _result = result;
137  _res = _result.get();
138  return services::Status();
139  }
140 
145  virtual void setInput(const algorithms::Input *other) DAAL_C11_OVERRIDE
146  {
147  const InputType *inputPtr = static_cast<const InputType *>(other);
148  input.set(predictedLabels, inputPtr->get(predictedLabels));
149  input.set(groundTruthLabels, inputPtr->get(groundTruthLabels));
150  }
151 
157  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
158  {
159  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
160  }
161 
162 protected:
163  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
164  {
165  return new Batch<algorithmFPType, method>(*this);
166  }
167 
168  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
169  {
170  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int) method);
171  _res = _result.get();
172  return s;
173  }
174 
175  virtual algorithms::ResultPtr getResultImpl() const DAAL_C11_OVERRIDE
176  {
177  return _result;
178  }
179 
180  void initialize()
181  {
182  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
183  _in = &input;
184  _par = &parameter;
185  _result.reset(new ResultType());
186  }
187 
188 private:
189  ResultPtr _result;
190 };
192 } // namespace interface1
193 using interface1::BatchContainer;
194 using interface1::Batch;
195 
196 }
197 }
198 }
199 }
200 }
201 #endif
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::input
InputType input
Definition: binary_confusion_matrix_batch.h:94
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: binary_confusion_matrix_batch.h:157
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::BatchContainer::~BatchContainer
virtual ~BatchContainer()
daal::batch
Definition: daal_defines.h:112
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: binary_confusion_matrix_batch.h:118
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::predictedLabels
Definition: binary_confusion_matrix_types.h:72
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::getResult
ResultPtr getResult() const
Definition: binary_confusion_matrix_batch.h:124
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::groundTruthLabels
Definition: binary_confusion_matrix_types.h:73
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::BatchContainer::BatchContainer
BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: binary_confusion_matrix_batch.h:109
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::BatchContainer::compute
virtual services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::Batch
Batch()
Definition: binary_confusion_matrix_batch.h:98
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch
Computes the confusion matrix for a binary classifier in the batch processing mode.
Definition: binary_confusion_matrix_batch.h:87
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: binary_confusion_matrix_batch.h:133
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::setInput
virtual void setInput(const algorithms::Input *other) DAAL_C11_OVERRIDE
Definition: binary_confusion_matrix_batch.h:145
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::BatchContainer
Class containing methods to compute the confusion matrix for a binary classifier. ...
Definition: binary_confusion_matrix_batch.h:56
daal::algorithms::classifier::quality_metric::binary_confusion_matrix::interface1::Batch::parameter
ParameterType parameter
Definition: binary_confusion_matrix_batch.h:95

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