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

decision_forest_regression_training_batch.h
1 /* file: decision_forest_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 forest model-based training
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __DECISION_FOREST_REGRESSSION_TRAINING_BATCH_H__
50 #define __DECISION_FOREST_REGRESSSION_TRAINING_BATCH_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/numeric_table.h"
54 #include "services/daal_defines.h"
55 #include "services/daal_memory.h"
56 #include "algorithms/decision_forest/decision_forest_regression_training_types.h"
57 #include "algorithms/decision_forest/decision_forest_regression_model.h"
58 #include "algorithms/regression/regression_training_batch.h"
59 
60 namespace daal
61 {
62 namespace algorithms
63 {
64 namespace decision_forest
65 {
66 namespace regression
67 {
68 namespace training
69 {
70 namespace interface1
71 {
82 template<typename algorithmFPType, Method method, CpuType cpu>
83 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
84 {
85 public:
91  BatchContainer(daal::services::Environment::env *daalEnv);
93  ~BatchContainer();
98  services::Status compute() DAAL_C11_OVERRIDE;
99  services::Status setupCompute() DAAL_C11_OVERRIDE;
100 };
101 
117 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
118 class DAAL_EXPORT Batch : public algorithms::regression::training::Batch
119 {
120 public:
121  typedef algorithms::decision_forest::regression::training::Input InputType;
122  typedef algorithms::decision_forest::regression::training::Parameter ParameterType;
123  typedef algorithms::decision_forest::regression::training::Result ResultType;
124 
125  InputType input;
126  ParameterType parameter;
129  Batch() : parameter()
130  {
131  initialize();
132  parameter.minObservationsInLeafNode = 5;
133  }
134 
141  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
142  {
143  initialize();
144  }
145 
146  ~Batch() {}
147 
148  virtual algorithms::regression::training::Input* getInput() DAAL_C11_OVERRIDE { return &input; }
149 
154  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
155 
160  ResultPtr getResult() { return ResultType::cast(_result); }
161 
168  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
169  {
170  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
171  }
172 
173 protected:
174 
175  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
176  {
177  return new Batch<algorithmFPType, method>(*this);
178  }
179 
180  services::Status allocateResult() DAAL_C11_OVERRIDE
181  {
182  services::Status s = getResult()->template allocate<algorithmFPType>(&input, &parameter, method);
183  _res = _result.get();
184  return s;
185  }
186 
187  void initialize()
188  {
189  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
190  _in = &input;
191  _par = &parameter;
192  _result.reset(new ResultType());
193  }
194 };
196 } // namespace interface1
197 using interface1::BatchContainer;
198 using interface1::Batch;
199 }
200 }
201 }
202 }
203 }
204 #endif
daal::algorithms::decision_forest::regression::training::interface1::Result
Provides methods to access the result obtained with the compute() method of decision forest model-bas...
Definition: decision_forest_regression_training_types.h:189
daal::algorithms::regression::training::interface1::Input
Input objects for the regression model-based training
Definition: regression_training_types.h:102
daal::algorithms::decision_forest::regression::training::interface1::Input
Input objects for decision forest model-based training
Definition: decision_forest_regression_training_types.h:150
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_forest::regression::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: decision_forest_regression_training_batch.h:168
daal::algorithms::decision_forest::regression::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: decision_forest_regression_training_batch.h:141
daal::algorithms::decision_forest::training::interface1::Parameter::minObservationsInLeafNode
size_t minObservationsInLeafNode
Definition: decision_forest_training_parameter.h:144
daal::algorithms::decision_forest::regression::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: decision_forest_regression_training_batch.h:160
daal::algorithms::decision_forest::regression::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_forest_regression_training_batch.h:154
daal_defines.h
daal::algorithms::decision_forest::regression::training::interface1::Parameter
Parameters for the decision forest algorithm.
Definition: decision_forest_regression_training_types.h:138
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_forest::regression::training::interface1::Batch::parameter
ParameterType parameter
Definition: decision_forest_regression_training_batch.h:126
daal::algorithms::decision_forest::regression::training::interface1::Batch
Provides methods for decision forest model-based training in the batch processing mode...
Definition: decision_forest_regression_training_batch.h:118
daal::algorithms::decision_forest::regression::training::interface1::Batch::Batch
Batch()
Definition: decision_forest_regression_training_batch.h:129
daal::algorithms::decision_forest::regression::training::interface1::BatchContainer
Class containing methods for decision forest regression model-based training using algorithmFPType pr...
Definition: decision_forest_regression_training_batch.h:83
daal::algorithms::decision_forest::regression::training::interface1::Batch::input
InputType input
Definition: decision_forest_regression_training_batch.h:125
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_forest::regression::training::interface1::Batch::getInput
virtual algorithms::regression::training::Input * getInput() DAAL_C11_OVERRIDE
Definition: decision_forest_regression_training_batch.h:148

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