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

decision_tree_regression_predict.h
1 /* file: decision_tree_regression_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 tree regression model-based prediction
45 //--
46 */
47 
48 #ifndef __DECISION_TREE_REGRESSION_PREDICT_H__
49 #define __DECISION_TREE_REGRESSION_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/decision_tree/decision_tree_regression_predict_types.h"
53 #include "algorithms/regression/regression_predict.h"
54 
55 namespace daal
56 {
57 namespace algorithms
58 {
59 namespace decision_tree
60 {
61 namespace regression
62 {
63 namespace prediction
64 {
65 namespace interface1
66 {
77 template<typename algorithmFPType, Method method, CpuType cpu>
78 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
79 {
80 public:
85  BatchContainer(daal::services::Environment::env *daalEnv);
86 
87  ~BatchContainer();
88 
92  services::Status compute() DAAL_C11_OVERRIDE;
93 };
94 
111 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
112 class Batch : public algorithms::regression::prediction::Batch
113 {
114 public:
115  typedef algorithms::regression::prediction::Batch super;
116 
117  typedef algorithms::decision_tree::regression::prediction::Input InputType;
118  typedef algorithms::decision_tree::regression::Parameter ParameterType;
119  typedef algorithms::decision_tree::regression::prediction::Result ResultType;
120 
121  InputType input;
122  ParameterType parameter;
125  Batch()
126  {
127  initialize();
128  }
129 
136  Batch(const Batch<algorithmFPType, method> & other) :
137  algorithms::regression::prediction::Batch(other), input(other.input), parameter(other.parameter)
138  {
139  initialize();
140  }
141 
142  virtual algorithms::regression::prediction::Input* getInput() DAAL_C11_OVERRIDE { return &input; }
143 
148  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
149 
154  ResultPtr getResult() { return ResultType::cast(_result); }
155 
161  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
162  {
163  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
164  }
165 
166 protected:
167 
168  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
169  {
170  return new Batch<algorithmFPType, method>(*this);
171  }
172 
173  services::Status allocateResult() DAAL_C11_OVERRIDE
174  {
175  services::Status s = getResult()->template allocate<algorithmFPType>(_in, &parameter, (int)method);
176  _res = _result.get();
177  return s;
178  }
179 
180  void initialize()
181  {
182  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
183  _in = &input;
184  _par = &parameter;
185  _result.reset(new ResultType());
186  }
187 };
189 } // namespace interface1
190 
191 using interface1::BatchContainer;
192 using interface1::Batch;
193 
194 } // namespace prediction
195 } // namespace regression
196 } // namespace decision_tree
197 } // namespace algorithms
198 } // namespace daal
199 
200 #endif
daal::algorithms::decision_tree::regression::prediction::interface1::Batch::getResult
ResultPtr getResult()
Definition: decision_tree_regression_predict.h:154
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::decision_tree::regression::prediction::interface1::Batch::Batch
Batch()
Definition: decision_tree_regression_predict.h:125
daal::algorithms::PredictionContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the algor...
Definition: prediction.h:66
daal::algorithms::decision_tree::regression::prediction::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_tree_regression_predict.h:148
daal::algorithms::decision_tree::regression::prediction::interface1::Input
Provides an interface for input objects for making Decision tree model-based prediction.
Definition: decision_tree_regression_predict_types.h:134
daal::algorithms::decision_tree::regression::interface1::Parameter
Decision tree algorithm parameters.
Definition: decision_tree_regression_model.h:96
daal::algorithms::decision_tree::regression::prediction::interface1::Batch::parameter
ParameterType parameter
Definition: decision_tree_regression_predict.h:122
daal::algorithms::decision_tree::regression::prediction::interface1::Batch::input
InputType input
Definition: decision_tree_regression_predict.h:121
daal::algorithms::decision_tree::regression::prediction::prediction
Definition: decision_tree_regression_predict_types.h:120
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::decision_tree::regression::prediction::interface1::BatchContainer
Class containing computation methods for Decision tree model-based prediction.
Definition: decision_tree_regression_predict.h:78
daal::algorithms::regression::prediction::interface1::Input
Provides an interface for input objects for making the regression model-based prediction.
Definition: regression_predict_types.h:111
daal::algorithms::decision_tree::regression::prediction::interface1::Batch
Provides methods to run implementations of the Decision tree model-based prediction.
Definition: decision_tree_regression_predict.h:112
daal::algorithms::decision_tree::regression::prediction::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: decision_tree_regression_predict.h:161
daal::algorithms::decision_tree::regression::prediction::interface1::Result
Provides interface for the result of decision tree model-based prediction.
Definition: decision_tree_regression_predict_types.h:180
daal::algorithms::regression::prediction::interface1::Batch
Provides methods to run implementations of the regression model-based prediction. ...
Definition: regression_predict.h:77
daal::algorithms::decision_tree::regression::prediction::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: decision_tree_regression_predict.h:136

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