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

stump_training_batch.h
1 /* file: stump_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 stump model-based training
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __STUMP_TRAINING_BATCH_H__
50 #define __STUMP_TRAINING_BATCH_H__
51 
52 #include "algorithms/weak_learner/weak_learner_training_batch.h"
53 #include "algorithms/stump/stump_training_types.h"
54 
55 namespace daal
56 {
57 namespace algorithms
58 {
59 namespace stump
60 {
61 namespace training
62 {
63 
64 namespace interface1
65 {
80 template<typename algorithmFPType, Method method, CpuType cpu>
81 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
82 {
83 public:
89  BatchContainer(daal::services::Environment::env *daalEnv);
91  ~BatchContainer();
95  services::Status compute() DAAL_C11_OVERRIDE;
96 };
97 
115 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
116 class DAAL_EXPORT Batch : public weak_learner::training::Batch
117 {
118 public:
119  typedef weak_learner::training::Batch super;
120 
121  typedef typename super::InputType InputType;
122  typedef typename super::ParameterType ParameterType;
123  typedef algorithms::stump::training::Result ResultType;
124 
125  ParameterType parameter;
126  InputType input;
128  Batch()
129  {
130  initialize();
131  }
132 
139  Batch(const Batch<algorithmFPType, method> &other) : weak_learner::training::Batch(other),
140  parameter(other.parameter), input(other.input)
141  {
142  initialize();
143  }
144 
145  virtual ~Batch() {}
146 
151  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
152 
157  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
158 
163  training::ResultPtr getResult()
164  {
165  return ResultType::cast(_result);
166  }
167 
171  services::Status resetResult() DAAL_C11_OVERRIDE
172  {
173  _result.reset(new ResultType());
174  DAAL_CHECK(_result, services::ErrorNullResult)
175  _res = NULL;
176  return services::Status();
177  }
178 
184  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
185  {
186  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
187  }
188 
189 protected:
190  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
191  {
192  return new Batch<algorithmFPType, method>(*this);
193  }
194 
195  services::Status allocateResult() DAAL_C11_OVERRIDE
196  {
197  training::ResultPtr res = getResult();
198  DAAL_CHECK(res, services::ErrorNullResult);
199  services::Status s = res->template allocate<algorithmFPType>(&input, _par, method);
200  _res = _result.get();
201  return s;
202  }
203 
204  void initialize()
205  {
206  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
207  _in = &input;
208  _par = &parameter;
209  _result.reset(new ResultType());
210  }
211 };
213 } // namespace interface1
214 using interface1::BatchContainer;
215 using interface1::Batch;
216 
217 } // namespace daal::algorithms::stump::training
218 }
219 }
220 } // namespace daal
221 #endif // __STUMP_TRAINING_BATCH_H__
daal::algorithms::weak_learner::training::interface1::Batch
Base class for training the weak learner model in the batch processing mode
Definition: weak_learner_training_batch.h:84
daal::algorithms::stump::training::interface1::BatchContainer
Provides methods to run implementations of the the decision stump training algorithm. It is associated with the daal::algorithms::stump::training::Batch class and supports methods to train the decision stump model.
Definition: stump_training_batch.h:81
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::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::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:81
daal::algorithms::stump::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: stump_training_batch.h:184
daal::algorithms::stump::training::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: stump_training_batch.h:151
daal::batch
Definition: daal_defines.h:132
daal::algorithms::stump::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: stump_training_batch.h:139
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::stump::training::interface1::Batch
Trains the decision stump model.
Definition: stump_training_batch.h:116
daal::algorithms::stump::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: stump_training_batch.h:157
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::algorithms::stump::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: stump_training_batch.h:171
daal::algorithms::stump::training::interface1::Result
Provides methods to access final results obtained with the compute() method of the decision stump tra...
Definition: stump_training_types.h:95
daal::algorithms::stump::training::interface1::Batch::input
InputType input
Definition: stump_training_batch.h:126
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::stump::training::interface1::Batch::parameter
ParameterType parameter
Definition: stump_training_batch.h:125

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