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

decision_tree_classification_training_batch.h
1 /* file: decision_tree_classification_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_CLASSIFICATION_TRAINING_BATCH_H__
49 #define __DECISION_TREE_CLASSIFICATION_TRAINING_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/decision_tree/decision_tree_classification_training_types.h"
53 #include "algorithms/decision_tree/decision_tree_classification_model.h"
54 #include "algorithms/classifier/classifier_training_batch.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace decision_tree
61 {
62 namespace classification
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 classifier::training::Batch
114 {
115 public:
116  typedef classifier::training::Batch super;
117 
118  typedef algorithms::decision_tree::classification::training::Input InputType;
119  typedef algorithms::decision_tree::classification::Parameter ParameterType;
120  typedef algorithms::decision_tree::classification::training::Result ResultType;
121 
122 
123  InputType input;
124  ParameterType parameter;
127  Batch(size_t nClasses) : parameter(nClasses)
128  {
129  initialize();
130  }
131 
137  Batch(const Batch<algorithmFPType, method> & other) : classifier::training::Batch(other), input(other.input), parameter(other.parameter)
138  {
139  initialize();
140  }
141 
146  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
147 
152  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
153 
158  ResultPtr getResult() { return ResultType::cast(_result); }
159 
163  services::Status resetResult() DAAL_C11_OVERRIDE
164  {
165  _result.reset(new ResultType());
166  DAAL_CHECK(_result, services::ErrorNullResult);
167  _res = NULL;
168  return services::Status();
169  }
170 
177  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
178  {
179  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
180  }
181 
182 protected:
183  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
184  {
185  return new Batch<algorithmFPType, method>(*this);
186  }
187 
188  services::Status allocateResult() DAAL_C11_OVERRIDE
189  {
190  ResultPtr res = getResult();
191  DAAL_CHECK(res, services::ErrorNullResult);
192  services::Status s = res->template allocate<algorithmFPType>((classifier::training::InputIface *)(&input), &parameter, (int)method);
193  _res = _result.get();
194  return s;
195  }
196 
197  void initialize()
198  {
199  _in = &input;
200  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
201  _par = &parameter;
202  _result.reset(new ResultType());
203  }
204 };
205 
207 } // namespace interface1
208 
209 using interface1::BatchContainer;
210 using interface1::Batch;
211 
212 } // namespace training
213 } // namespace classification
214 } // namespace decision_tree
215 } // namespace algorithms
216 } // namespace daal
217 
218 #endif
daal::algorithms::classifier::training::interface1::Input
Base class for the input objects in the training stage of the classification algorithms.
Definition: classifier_training_types.h:134
daal::algorithms::decision_tree::classification::training::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: decision_tree_classification_training_batch.h:146
daal::algorithms::decision_tree::classification::training::interface1::Batch
Provides methods for Decision tree model-based training in the batch processing mode.
Definition: decision_tree_classification_training_batch.h:113
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::algorithms::decision_tree::classification::training::interface1::Result
Provides methods to access the result obtained with the compute() method of Decision tree model-based...
Definition: decision_tree_classification_training_types.h:156
daal
Definition: algorithm_base_common.h:57
daal::algorithms::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:81
daal::algorithms::classifier::training::interface1::InputIface
Abstract class that specifies the interface of the classes of the classification algorithm input obje...
Definition: classifier_training_types.h:121
daal::algorithms::decision_tree::classification::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: decision_tree_classification_training_batch.h:163
daal::algorithms::decision_tree::classification::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: decision_tree_classification_training_batch.h:177
daal::algorithms::decision_tree::classification::training::interface1::Batch::parameter
ParameterType parameter
Definition: decision_tree_classification_training_batch.h:124
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::decision_tree::classification::training::interface1::BatchContainer
Class containing methods for Decision tree model-based training using algorithmFPType precision arith...
Definition: decision_tree_classification_training_batch.h:79
daal::algorithms::decision_tree::classification::training::interface1::Batch::Batch
Batch(size_t nClasses)
Definition: decision_tree_classification_training_batch.h:127
daal::algorithms::decision_tree::classification::training::interface1::Batch::input
InputType input
Definition: decision_tree_classification_training_batch.h:123
daal::algorithms::decision_tree::classification::training::interface1::Input
Base class for the input objects in the training stage of the classification algorithms.
Definition: decision_tree_classification_training_types.h:115
daal::algorithms::decision_tree::classification::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: decision_tree_classification_training_batch.h:137
daal::algorithms::decision_tree::classification::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_tree_classification_training_batch.h:152
daal::algorithms::decision_tree::classification::interface1::Parameter
Decision tree algorithm parameters.
Definition: decision_tree_classification_model.h:107
daal::algorithms::classifier::training::interface1::Batch
Algorithm class for training the classifier model.
Definition: classifier_training_batch.h:82
daal::algorithms::classifier::training::interface1::Result
Provides methods to access final results obtained with the compute() method in the batch processing m...
Definition: classifier_training_types.h:222
daal::services::ErrorNullResult
Definition: error_indexes.h:122
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::classification::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: decision_tree_classification_training_batch.h:158

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