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

decision_tree_regression_training_batch.h
1 /* file: decision_tree_regression_training_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 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  Input input;
117  Parameter parameter;
120  Batch()
121  {
122  initialize();
123  }
124 
130  Batch(const Batch<algorithmFPType, method> & other) :
131  algorithms::regression::training::Batch(other), input(other.input), parameter(other.parameter)
132  {
133  initialize();
134  }
135 
136  virtual algorithms::regression::training::Input* getInput() DAAL_C11_OVERRIDE { return &input; }
137 
142  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
143 
148  ResultPtr getResult() { return Result::cast(_result); }
149 
153  void resetResult() // DAAL_C11_OVERRIDE
154  {
155  _result.reset(new Result());
156  _res = NULL;
157  }
158 
165  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
166  {
167  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
168  }
169 
170 protected:
171  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
172  {
173  return new Batch<algorithmFPType, method>(*this);
174  }
175 
176  services::Status allocateResult() DAAL_C11_OVERRIDE
177  {
178  services::Status s = getResult()->template allocate<algorithmFPType>(&input, &parameter, method);
179  _res = _result.get();
180  return s;
181  }
182 
183  void initialize()
184  {
185  _in = &input;
186  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
187  _par = &parameter;
188  _result.reset(new Result());
189  }
190 };
192 } // namespace interface1
193 
194 using interface1::BatchContainer;
195 using interface1::Batch;
196 
197 } // namespace training
198 } // namespace regression
199 } // namespace decision_tree
200 } // namespace algorithms
201 } // namespace daal
202 
203 #endif
daal::algorithms::decision_tree::regression::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: decision_tree_regression_training_batch.h:165
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:153
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::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:148
daal::batch
Definition: daal_defines.h:131
daal::algorithms::decision_tree::regression::training::interface1::Batch::parameter
Parameter parameter
Definition: decision_tree_regression_training_batch.h:117
daal::algorithms::decision_tree::regression::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: decision_tree_regression_training_batch.h:130
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:120
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::input
Input input
Definition: decision_tree_regression_training_batch.h:116
daal::algorithms::decision_tree::regression::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_tree_regression_training_batch.h:142

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