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

decision_tree_classification_training_batch.h
1 /* file: decision_tree_classification_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_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  Input input;
117  Parameter parameter;
120  Batch(size_t nClasses) : parameter(nClasses)
121  {
122  initialize();
123  }
124 
130  Batch(const Batch<algorithmFPType, method> & other) : classifier::training::Batch(other), input(other.input), parameter(other.parameter)
131  {
132  initialize();
133  }
134 
139  Input * getInput() DAAL_C11_OVERRIDE { return &input; }
140 
145  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
146 
151  ResultPtr getResult() { return Result::cast(_result); }
152 
156  services::Status resetResult() DAAL_C11_OVERRIDE
157  {
158  _result.reset(new Result());
159  DAAL_CHECK(_result, services::ErrorNullResult);
160  _res = NULL;
161  return services::Status();
162  }
163 
170  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
171  {
172  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
173  }
174 
175 protected:
176  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
177  {
178  return new Batch<algorithmFPType, method>(*this);
179  }
180 
181  services::Status allocateResult() DAAL_C11_OVERRIDE
182  {
183  ResultPtr res = getResult();
184  DAAL_CHECK(res, services::ErrorNullResult);
185  services::Status s = res->template allocate<algorithmFPType>((classifier::training::InputIface *)(&input), &parameter, (int)method);
186  _res = _result.get();
187  return s;
188  }
189 
190  void initialize()
191  {
192  _in = &input;
193  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
194  _par = &parameter;
195  _result.reset(new Result());
196  }
197 };
198 
200 } // namespace interface1
201 
202 using interface1::BatchContainer;
203 using interface1::Batch;
204 
205 } // namespace training
206 } // namespace classification
207 } // namespace decision_tree
208 } // namespace algorithms
209 } // namespace daal
210 
211 #endif
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::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::decision_tree::classification::training::interface1::Batch::input
Input input
Definition: decision_tree_classification_training_batch.h:116
daal::algorithms::decision_tree::classification::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: decision_tree_classification_training_batch.h:170
daal::algorithms::decision_tree::classification::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: decision_tree_classification_training_batch.h:156
daal::batch
Definition: daal_defines.h:131
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:120
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:130
daal::algorithms::decision_tree::classification::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: decision_tree_classification_training_batch.h:145
daal::algorithms::decision_tree::classification::training::interface1::Batch::parameter
Parameter parameter
Definition: decision_tree_classification_training_batch.h:117
daal::algorithms::decision_tree::classification::training::interface1::Batch::getInput
Input * getInput() DAAL_C11_OVERRIDE
Definition: decision_tree_classification_training_batch.h:139
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:151

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