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

decision_tree_regression_training_batch.h
1 /* file: decision_tree_regression_training_batch.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 model-based training in the batch processing mode
45 //--
46 */
47 
48 #ifndef __DECISION_TREE_REGRESSION_TRAINING_BATCH_H__
49 #define __DECISION_TREE_REGRESSION_TRAINING_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/decision_tree/decision_tree_regression_training_types.h"
53 #include "algorithms/decision_tree/decision_tree_regression_model.h"
54 #include "algorithms/regression/regression_training_batch.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace decision_tree
61 {
62 namespace regression
63 {
64 namespace training
65 {
66 namespace interface1
67 {
78 template <typename algorithmFPType, Method method, CpuType cpu>
79 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
80 {
81 public:
86  BatchContainer(daal::services::Environment::env * daalEnv);
87 
89  ~BatchContainer();
90 
94  services::Status compute() DAAL_C11_OVERRIDE;
95 };
96 
112 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
113 class DAAL_EXPORT Batch : public algorithms::regression::training::Batch
114 {
115 public:
116  typedef algorithms::regression::training::Batch super;
117 
118  typedef algorithms::decision_tree::regression::training::Input InputType;
119  typedef algorithms::decision_tree::regression::Parameter ParameterType;
120  typedef algorithms::decision_tree::regression::training::Result ResultType;
121 
122  InputType input;
123  ParameterType parameter;
126  Batch()
127  {
128  initialize();
129  }
130 
136  Batch(const Batch<algorithmFPType, method> & other) :
137  algorithms::regression::training::Batch(other), input(other.input), parameter(other.parameter)
138  {
139  initialize();
140  }
141 
142  virtual algorithms::regression::training::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 
159  void resetResult() // DAAL_C11_OVERRIDE
160  {
161  _result.reset(new ResultType());
162  _res = NULL;
163  }
164 
171  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
172  {
173  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
174  }
175 
176 protected:
177  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
178  {
179  return new Batch<algorithmFPType, method>(*this);
180  }
181 
182  services::Status allocateResult() DAAL_C11_OVERRIDE
183  {
184  services::Status s = getResult()->template allocate<algorithmFPType>(&input, &parameter, method);
185  _res = _result.get();
186  return s;
187  }
188 
189  void initialize()
190  {
191  _in = &input;
192  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
193  _par = &parameter;
194  _result.reset(new ResultType());
195  }
196 };
198 } // namespace interface1
199 
200 using interface1::BatchContainer;
201 using interface1::Batch;
202 
203 } // namespace training
204 } // namespace regression
205 } // namespace decision_tree
206 } // namespace algorithms
207 } // namespace daal
208 
209 #endif
daal::algorithms::regression::training::interface1::Input
Input objects for the regression model-based training
Definition: regression_training_types.h:102
daal::algorithms::decision_tree::regression::training::interface1::Batch::parameter
ParameterType parameter
Definition: decision_tree_regression_training_batch.h:123
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::decision_tree::regression::training::interface1::Batch::resetResult
void resetResult()
Definition: decision_tree_regression_training_batch.h:159
daal::algorithms::decision_tree::regression::training::interface1::BatchContainer
Class containing methods for Decision tree model-based training using algorithmFPType precision arith...
Definition: decision_tree_regression_training_batch.h:79
daal::algorithms::decision_tree::regression::training::interface1::Result
Provides methods to access the result obtained with the compute() method of Decision tree model-based...
Definition: decision_tree_regression_training_types.h:174
daal::algorithms::decision_tree::regression::training::interface1::Batch::input
InputType input
Definition: decision_tree_regression_training_batch.h:122
daal::algorithms::decision_tree::regression::interface1::Parameter
Decision tree algorithm parameters.
Definition: decision_tree_regression_model.h:96
daal::algorithms::decision_tree::regression::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: decision_tree_regression_training_batch.h:171
daal::algorithms::decision_tree::regression::training::interface1::Input
Base class for the input objects in the training stage of the regression algorithms.
Definition: decision_tree_regression_training_types.h:127
daal::algorithms::decision_tree::regression::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: decision_tree_regression_training_batch.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::regression::training::interface1::Batch
Provides methods for the regression model-based training in the batch processing mode.
Definition: regression_training_batch.h:77
daal::algorithms::decision_tree::regression::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: decision_tree_regression_training_batch.h:136
daal::algorithms::decision_tree::regression::training::interface1::Batch
Provides methods for Decision tree model-based training in the batch processing mode.
Definition: decision_tree_regression_training_batch.h:113
daal::algorithms::decision_tree::regression::training::interface1::Batch::Batch
Batch()
Definition: decision_tree_regression_training_batch.h:126
daal::algorithms::decision_tree::regression::training::interface1::Batch::getInput
virtual algorithms::regression::training::Input * getInput() DAAL_C11_OVERRIDE
Definition: decision_tree_regression_training_batch.h:142
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:76
daal::algorithms::decision_tree::regression::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_tree_regression_training_batch.h:148

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