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

stump_predict.h
1 /* file: stump_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 decision stump model-based prediction
45 //--
46 */
47 
48 #ifndef __STUMP_PREDICT_H__
49 #define __STUMP_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/weak_learner/weak_learner_predict.h"
53 #include "algorithms/stump/stump_predict_types.h"
54 
55 namespace daal
56 {
57 namespace algorithms
58 {
59 namespace stump
60 {
69 namespace prediction
70 {
75 enum Method
76 {
77  defaultDense = 0
78 };
79 
83 namespace interface1
84 {
94 template<typename algorithmFPType, Method method, CpuType cpu>
95 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
96 {
97 public:
102  BatchContainer(daal::services::Environment::env *daalEnv);
104  ~BatchContainer();
108  services::Status compute() DAAL_C11_OVERRIDE;
109 };
110 
131 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
132 class Batch : public weak_learner::prediction::Batch
133 {
134 public:
135  typedef weak_learner::prediction::Batch super;
136 
137  typedef algorithms::stump::prediction::Input InputType;
138  typedef typename super::ParameterType ParameterType;
139  typedef typename super::ResultType ResultType;
140 
141  InputType input;
143  Batch()
144  {
145  initialize();
146  }
147 
154  Batch(const Batch<algorithmFPType, method> &other) : weak_learner::prediction::Batch(other), input(other.input)
155  {
156  initialize();
157  }
158 
159  ~Batch() {}
160 
165  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
166 
171  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
172 
178  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
179  {
180  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
181  }
182 
183 protected:
184  using weak_learner::prediction::Batch::_result;
185 
186  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
187  {
188  return new Batch<algorithmFPType, method>(*this);
189  }
190 
191  services::Status allocateResult() DAAL_C11_OVERRIDE
192  {
193  services::Status s = _result->allocate<algorithmFPType>(&input, 0, 0);
194  _res = _result.get();
195  return s;
196  }
197 
198  void initialize()
199  {
200  _in = &input;
201  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
202  _par = NULL;
203  }
204 };
205 } // namespace interface1
206 using interface1::BatchContainer;
207 using interface1::Batch;
208 
209 } // namespace daal::algorithms::stump::prediction
211 }
212 }
213 } // namespace daal
214 #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::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:81
daal::algorithms::stump::prediction::interface1::BatchContainer
Provides methods to run implementations of the decision stump prediction algorithm. It is associated with the daal::algorithms::stump::prediction::interface1::Batch class and supports methods to run based on the decision stump model.
Definition: stump_predict.h:95
daal::algorithms::classifier::prediction::interface1::Input
Input objects in the prediction stage of the classification algorithm.
Definition: classifier_predict_types.h:133
daal::algorithms::neural_networks::prediction::prediction
Definition: neural_networks_prediction_result.h:79
daal::algorithms::stump::prediction::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: stump_predict.h:171
daal::algorithms::stump::prediction::interface1::Batch
Predicts results of the decision stump classification.
Definition: stump_predict.h:132
daal::algorithms::PredictionContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the algor...
Definition: prediction.h:66
daal::algorithms::stump::prediction::interface1::Batch::input
InputType input
Definition: stump_predict.h:141
daal::algorithms::weak_learner::prediction::interface1::Batch
Base class for making predictions based on the weak learner model
Definition: weak_learner_predict.h:96
daal::algorithms::stump::prediction::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: stump_predict.h:154
daal::batch
Definition: daal_defines.h:132
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::stump::prediction::Method
Method
Definition: stump_predict.h:75
daal::algorithms::stump::prediction::interface1::Input
Input objects in the prediction stage of the stump algorithm.
Definition: stump_predict_types.h:85
daal::algorithms::stump::prediction::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: stump_predict.h:178
daal::algorithms::stump::prediction::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: stump_predict.h:165
daal::algorithms::stump::prediction::defaultDense
Definition: stump_predict.h:77

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