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

adaboost_predict.h
1 /* file: adaboost_predict.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 // Implementation of the interface for AdaBoost model-based prediction
45 //--
46 */
47 
48 #ifndef __ADA_BOOST_PREDICT_H__
49 #define __ADA_BOOST_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/boosting/boosting_predict.h"
53 #include "algorithms/boosting/adaboost_model.h"
54 #include "algorithms/boosting/adaboost_predict_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace adaboost
61 {
65 namespace prediction
66 {
76 enum Method
77 {
78  defaultDense = 0
79 };
80 
84 namespace interface1
85 {
95 template<typename algorithmFPType, Method method, CpuType cpu>
96 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
97 {
98 public:
103  BatchContainer(daal::services::Environment::env *daalEnv);
105  ~BatchContainer();
109  services::Status compute() DAAL_C11_OVERRIDE;
110 };
111 
132 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
133 class Batch : public boosting::prediction::Batch
134 {
135 public:
136  typedef boosting::prediction::Batch super;
137 
138  typedef algorithms::adaboost::prediction::Input InputType;
139  typedef algorithms::adaboost::Parameter ParameterType;
140  typedef typename super::ResultType ResultType;
141 
142  InputType input;
143  ParameterType parameter;
145  Batch()
146  {
147  initialize();
148  }
149 
156  Batch(const Batch<algorithmFPType, method> &other) : boosting::prediction::Batch(other),
157  input(other.input), parameter(other.parameter)
158  {
159  initialize();
160  }
161 
162  ~Batch() {}
163 
168  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
169 
174  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
175 
181  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
182  {
183  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
184  }
185 
186 protected:
187  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
188  {
189  return new Batch<algorithmFPType, method>(*this);
190  }
191 
192  services::Status allocateResult() DAAL_C11_OVERRIDE
193  {
194  services::Status s = _result->allocate<algorithmFPType>(&input, 0, 0);
195  _res = _result.get();
196  return s;
197  }
198 
199  void initialize()
200  {
201  _in = &input;
202  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
203  _par = &parameter;
204  }
205 };
206 } // namespace interface1
207 using interface1::BatchContainer;
208 using interface1::Batch;
209 
211 } // namespace daal::algorithms::adaboost::prediction
212 }
213 }
214 } // namespace daal
215 #endif
daal::algorithms::classifier::prediction::interface1::Result
Provides methods to access prediction results obtained with the compute() method of the classifier pr...
Definition: classifier_predict_types.h:190
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
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::neural_networks::prediction::prediction
Definition: neural_networks_prediction_result.h:79
daal::algorithms::adaboost::prediction::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: adaboost_predict.h:168
daal::algorithms::PredictionContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the algor...
Definition: prediction.h:66
daal::algorithms::adaboost::prediction::interface1::Input
Input objects in the prediction stage of the adaboost algorithm.
Definition: adaboost_predict_types.h:77
daal::algorithms::adaboost::prediction::defaultDense
Definition: adaboost_predict.h:78
daal::algorithms::adaboost::prediction::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: adaboost_predict.h:174
daal::algorithms::adaboost::prediction::interface1::Batch
Predict AdaBoost classification results.
Definition: adaboost_predict.h:133
daal::batch
Definition: daal_defines.h:132
daal::algorithms::adaboost::prediction::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: adaboost_predict.h:181
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::adaboost::prediction::Method
Method
Definition: adaboost_predict.h:76
daal::algorithms::adaboost::interface1::Parameter
AdaBoost algorithm parameters.
Definition: adaboost_model.h:80
daal::algorithms::adaboost::prediction::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: adaboost_predict.h:156
daal::algorithms::adaboost::prediction::interface1::BatchContainer
Provides methods to run implementations of the AdaBoost algorithm. It is associated with daal::algori...
Definition: adaboost_predict.h:96
daal::algorithms::adaboost::prediction::interface1::Batch::parameter
ParameterType parameter
Definition: adaboost_predict.h:143
daal::algorithms::adaboost::prediction::interface1::Batch::input
InputType input
Definition: adaboost_predict.h:142
daal::algorithms::boosting::prediction::interface1::Batch
Base class for predicting results of boosting classifiers
Definition: boosting_predict.h:101

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