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

gbt_regression_predict.h
1 /* file: gbt_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 model-based prediction
45 //--
46 */
47 
48 #ifndef __GBT_REGRESSION_PREDICT_H__
49 #define __GBT_REGRESSION_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/gradient_boosted_trees/gbt_regression_predict_types.h"
53 #include "algorithms/regression/regression_predict.h"
54 
55 namespace daal
56 {
57 namespace algorithms
58 {
59 namespace gbt
60 {
61 namespace regression
62 {
63 namespace prediction
64 {
65 namespace interface1
66 {
76 template<typename algorithmFPType, Method method, CpuType cpu>
77 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
78 {
79 public:
84  BatchContainer(daal::services::Environment::env *daalEnv);
85  ~BatchContainer();
90  services::Status compute() DAAL_C11_OVERRIDE;
91 };
92 
109 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
110 class Batch : public algorithms::regression::prediction::Batch
111 {
112 public:
113  typedef algorithms::gbt::regression::prediction::Input InputType;
114  typedef algorithms::gbt::regression::prediction::Parameter ParameterType;
115  typedef algorithms::gbt::regression::prediction::Result ResultType;
116 
117  InputType input;
120  Batch()
121  {
122  _par = new ParameterType();
123  initialize();
124  }
125 
132  Batch(const Batch<algorithmFPType, method> &other) : input(other.input)
133  {
134  _par = new ParameterType(other.parameter());
135  initialize();
136  }
137 
139  ~Batch()
140  {
141  delete _par;
142  }
143 
148  ParameterType& parameter() { return *static_cast<ParameterType*>(_par); }
149 
154  const ParameterType& parameter() const { return *static_cast<const ParameterType*>(_par); }
155 
160  virtual algorithms::regression::prediction::Input* getInput() DAAL_C11_OVERRIDE{ return &input; }
161 
166  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
167 
172  ResultPtr getResult() { return ResultType::cast(_result); }
173 
179  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
180  {
181  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
182  }
183 
184 protected:
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 = getResult()->template allocate<algorithmFPType>(_in, 0, 0);
194  _res = _result.get();
195  return s;
196  }
197 
198  void initialize()
199  {
200  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
201  _in = &input;
202  _result.reset(new ResultType());
203  }
204 };
206 } // namespace interface1
207 using interface1::BatchContainer;
208 using interface1::Batch;
209 
210 }
211 }
212 }
213 }
214 }
215 #endif
daal::algorithms::gbt::regression::prediction::interface1::Batch::Batch
Batch()
Definition: gbt_regression_predict.h:120
daal::algorithms::gbt::regression::prediction::interface1::Batch::input
InputType input
Definition: gbt_regression_predict.h:117
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::gbt::regression::prediction::interface1::Result
Provides interface for the result of model-based prediction.
Definition: gbt_regression_predict_types.h:187
daal::algorithms::gbt::regression::prediction::interface1::Batch::getResult
ResultPtr getResult()
Definition: gbt_regression_predict.h:172
daal::algorithms::neural_networks::prediction::prediction
Definition: neural_networks_prediction_result.h:79
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::regression::prediction::interface1::Input
Provides an interface for input objects for making model-based prediction.
Definition: gbt_regression_predict_types.h:142
daal::algorithms::gbt::regression::prediction::interface1::Batch::parameter
ParameterType & parameter()
Definition: gbt_regression_predict.h:148
daal::algorithms::gbt::regression::prediction::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: gbt_regression_predict.h:166
daal::algorithms::gbt::regression::prediction::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: gbt_regression_predict.h:132
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::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::gbt::regression::prediction::interface1::Batch::getInput
virtual algorithms::regression::prediction::Input * getInput() DAAL_C11_OVERRIDE
Definition: gbt_regression_predict.h:160
daal::algorithms::gbt::regression::prediction::interface1::Batch::~Batch
~Batch()
Definition: gbt_regression_predict.h:139
daal::algorithms::gbt::regression::prediction::interface1::Batch
Provides methods to run implementations of the model-based prediction.
Definition: gbt_regression_predict.h:110
daal::algorithms::gbt::regression::prediction::interface1::Batch::parameter
const ParameterType & parameter() const
Definition: gbt_regression_predict.h:154
daal::algorithms::gbt::regression::prediction::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: gbt_regression_predict.h:179
daal::algorithms::gbt::regression::prediction::interface1::Parameter
Parameters of the prediction algorithm.
Definition: gbt_regression_predict_types.h:130
daal::algorithms::regression::prediction::interface1::Batch
Provides methods to run implementations of the regression model-based prediction. ...
Definition: regression_predict.h:77
daal::algorithms::gbt::regression::prediction::interface1::BatchContainer
Class containing computation methods for model-based prediction.
Definition: gbt_regression_predict.h:77

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