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

gbt_classification_predict.h
1 /* file: gbt_classification_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 gradient boosted trees classification model-based prediction
45 //--
46 */
47 
48 #ifndef __GBT_CLASSIFICATION_PREDICT_H__
49 #define __GBT_CLASSIFICATION_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/classifier/classifier_predict.h"
53 #include "algorithms/gradient_boosted_trees/gbt_classification_model.h"
54 #include "algorithms/gradient_boosted_trees/gbt_classification_predict_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace gbt
61 {
62 namespace classification
63 {
67 namespace prediction
68 {
78 namespace interface1
79 {
89 template<typename algorithmFPType, Method method, CpuType cpu>
90 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
91 {
92 public:
97  BatchContainer(daal::services::Environment::env *daalEnv);
99  ~BatchContainer();
104  services::Status compute() DAAL_C11_OVERRIDE;
105 };
106 
127 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
128 class Batch : public classifier::prediction::Batch
129 {
130 public:
131  typedef classifier::prediction::Batch super;
132 
133  typedef algorithms::gbt::classification::prediction::Input InputType;
134  typedef algorithms::gbt::classification::prediction::Parameter ParameterType;
135  typedef typename super::ResultType ResultType;
136 
137  InputType input;
143  Batch(size_t nClasses)
144  {
145  _par = new ParameterType(nClasses);
146  initialize();
147  };
148 
155  Batch(const Batch<algorithmFPType, method> &other) : classifier::prediction::Batch(other), input(other.input)
156  {
157  _par = new ParameterType(other.parameter());
158  initialize();
159  }
160 
162  ~Batch()
163  {
164  delete _par;
165  }
166 
171  ParameterType& parameter() { return *static_cast<ParameterType*>(_par); }
172 
177  const ParameterType& parameter() const { return *static_cast<const ParameterType*>(_par); }
178 
183  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
184 
189  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
190 
196  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
197  {
198  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
199  }
200 
201 protected:
202  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
203  {
204  return new Batch<algorithmFPType, method>(*this);
205  }
206 
207  services::Status allocateResult() DAAL_C11_OVERRIDE
208  {
209  services::Status s = _result->allocate<algorithmFPType>(&input, 0, 0);
210  _res = _result.get();
211  return s;
212  }
213 
214  void initialize()
215  {
216  _in = &input;
217  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
218  }
219 };
221 } // namespace interface1
222 using interface1::BatchContainer;
223 using interface1::Batch;
224 
225 } // namespace daal::algorithms::gbt::classification::prediction
226 }
227 }
228 }
229 } // namespace daal
230 #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::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::gbt::classification::prediction::interface1::Batch::parameter
const ParameterType & parameter() const
Definition: gbt_classification_predict.h:177
daal::algorithms::PredictionContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the algor...
Definition: prediction.h:66
daal::algorithms::gbt::classification::prediction::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: gbt_classification_predict.h:196
daal::algorithms::gbt::classification::prediction::interface1::Batch::~Batch
~Batch()
Definition: gbt_classification_predict.h:162
daal::algorithms::gbt::classification::prediction::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: gbt_classification_predict.h:155
daal::algorithms::gbt::classification::prediction::interface1::Parameter
Parameters of the prediction algorithm.
Definition: gbt_classification_predict_types.h:97
daal::algorithms::classifier::prediction::interface1::Batch
Base class for making predictions based on the model of the classification algorithms.
Definition: classifier_predict.h:85
daal::batch
Definition: daal_defines.h:132
daal::algorithms::gbt::classification::prediction::interface1::Batch::parameter
ParameterType & parameter()
Definition: gbt_classification_predict.h:171
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::gbt::classification::prediction::interface1::BatchContainer
Provides methods to run implementations of the gradient boosted trees algorithm. This class is associ...
Definition: gbt_classification_predict.h:90
daal::algorithms::gbt::classification::prediction::interface1::Input
Input objects in the prediction stage of the GBT_CLASSIFICATION algorithm.
Definition: gbt_classification_predict_types.h:109
daal::algorithms::gbt::classification::prediction::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: gbt_classification_predict.h:183
daal::algorithms::gbt::classification::prediction::interface1::Batch::input
InputType input
Definition: gbt_classification_predict.h:137
daal::algorithms::gbt::classification::prediction::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: gbt_classification_predict.h:189
daal::algorithms::gbt::classification::prediction::interface1::Batch
Predicts gradient boosted trees classification results.
Definition: gbt_classification_predict.h:128
daal::algorithms::gbt::classification::prediction::interface1::Batch::Batch
Batch(size_t nClasses)
Definition: gbt_classification_predict.h:143

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