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

decision_forest_regression_training_batch.h
1 /* file: decision_forest_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 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 };
100 
116 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
117 class DAAL_EXPORT Batch : public algorithms::regression::training::Batch
118 {
119 public:
120  Input input;
121  Parameter parameter;
124  Batch() : parameter()
125  {
126  initialize();
127  parameter.minObservationsInLeafNode = 5;
128  }
129 
136  Batch(const Batch<algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
137  {
138  initialize();
139  }
140 
141  ~Batch() {}
142 
143  virtual algorithms::regression::training::Input* getInput() DAAL_C11_OVERRIDE { return &input; }
144 
149  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
150 
155  ResultPtr getResult() { return Result::cast(_result); }
156 
163  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
164  {
165  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
166  }
167 
168 protected:
169 
170  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
171  {
172  return new Batch<algorithmFPType, method>(*this);
173  }
174 
175  services::Status allocateResult() DAAL_C11_OVERRIDE
176  {
177  services::Status s = getResult()->template allocate<algorithmFPType>(&input, &parameter, method);
178  _res = _result.get();
179  return s;
180  }
181 
182  void initialize()
183  {
184  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
185  _in = &input;
186  _par = &parameter;
187  _result.reset(new Result());
188  }
189 };
191 } // namespace interface1
192 using interface1::BatchContainer;
193 using interface1::Batch;
194 }
195 }
196 }
197 }
198 }
199 #endif
daal::algorithms::decision_forest::regression::training::interface1::Input
Input objects for decision forest model-based training
Definition: decision_forest_regression_training_types.h:147
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:163
daal::algorithms::decision_forest::regression::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: decision_forest_regression_training_batch.h:136
daal::algorithms::decision_forest::regression::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: decision_forest_regression_training_batch.h:155
daal::algorithms::decision_forest::regression::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_forest_regression_training_batch.h:149
daal_defines.h
daal::algorithms::decision_forest::regression::training::interface1::Parameter
Parameters for the decision forest algorithm.
Definition: decision_forest_regression_training_types.h:135
daal::batch
Definition: daal_defines.h:131
daal::algorithms::decision_forest::regression::training::interface1::Batch::parameter
Parameter parameter
Definition: decision_forest_regression_training_batch.h:121
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:117
daal::algorithms::decision_forest::regression::training::interface1::Batch::Batch
Batch()
Definition: decision_forest_regression_training_batch.h:124
daal::algorithms::decision_forest::regression::training::interface1::Batch::input
Input input
Definition: decision_forest_regression_training_batch.h:120
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::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:76

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