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

brownboost_training_batch.h
1 /* file: brownboost_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 BrownBoost model-based training
45 //--
46 */
47 
48 #ifndef __BROWN_BOOST_TRAINING_BATCH_H__
49 #define __BROWN_BOOST_TRAINING_BATCH_H__
50 
51 #include "algorithms/boosting/boosting_training_batch.h"
52 #include "algorithms/boosting/brownboost_training_types.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace brownboost
59 {
60 namespace training
61 {
62 
63 namespace interface1
64 {
78 template<typename algorithmFPType, Method method, CpuType cpu>
79 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
80 {
81 public:
87  BatchContainer(daal::services::Environment::env *daalEnv);
89  ~BatchContainer();
93  services::Status compute() DAAL_C11_OVERRIDE;
94 };
95 
113 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
114 class DAAL_EXPORT Batch : public boosting::training::Batch
115 {
116 public:
117  typedef boosting::training::Batch super;
118 
119  typedef typename super::InputType InputType;
120  typedef algorithms::brownboost::Parameter ParameterType;
121  typedef algorithms::brownboost::training::Result ResultType;
122 
123  ParameterType parameter;
124  InputType input;
126  Batch()
127  {
128  initialize();
129  }
130 
137  Batch(const Batch<algorithmFPType, method> &other) : boosting::training::Batch(other),
138  parameter(other.parameter), input(other.input)
139  {
140  initialize();
141  }
142 
143  virtual ~Batch() {}
144 
149  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
150 
155  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
156 
161  ResultPtr getResult()
162  {
163  return ResultType::cast(_result);
164  }
165 
169  services::Status resetResult() DAAL_C11_OVERRIDE
170  {
171  _result.reset(new ResultType());
172  DAAL_CHECK(_result, services::ErrorNullResult);
173  _res = NULL;
174  return services::Status();
175  }
176 
182  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
183  {
184  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
185  }
186 
187 protected:
188  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
189  {
190  return new Batch<algorithmFPType, method>(*this);
191  }
192 
193  services::Status allocateResult() DAAL_C11_OVERRIDE
194  {
195  ResultPtr res = getResult();
196  DAAL_CHECK(_result, services::ErrorNullResult);
197  services::Status s = res->template allocate<algorithmFPType>(&input, _par, method);
198  _res = _result.get();
199  return s;
200  }
201 
202  void initialize()
203  {
204  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
205  _in = &input;
206  _par = &parameter;
207  _result.reset(new ResultType());
208  }
209 };
211 } // namespace interface1
212 using interface1::BatchContainer;
213 using interface1::Batch;
214 
215 } // namespace daal::algorithms::brownboost::training
216 }
217 }
218 } // namespace daal
219 #endif // __BROWN_BOOST_TRAINING_BATCH_H__
daal::algorithms::brownboost::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: brownboost_training_batch.h:182
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::brownboost::training::interface1::Batch
Trains model of the BrownBoost algorithms in the batch processing mode.
Definition: brownboost_training_batch.h:114
daal::algorithms::brownboost::training::interface1::Result
Provides methods to access final results obtained with the compute() method of the BrownBoost trainin...
Definition: brownboost_training_types.h:96
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::brownboost::training::interface1::Batch::input
InputType input
Definition: brownboost_training_batch.h:124
daal::algorithms::brownboost::training::interface1::Batch::parameter
ParameterType parameter
Definition: brownboost_training_batch.h:123
daal::algorithms::boosting::training::interface1::Batch
Base class for training models of boosting algorithms in the batch processing mode ...
Definition: boosting_training_batch.h:95
daal::algorithms::brownboost::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: brownboost_training_batch.h:155
daal::algorithms::brownboost::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: brownboost_training_batch.h:137
daal::batch
Definition: daal_defines.h:132
daal::algorithms::brownboost::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: brownboost_training_batch.h:169
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::brownboost::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: brownboost_training_batch.h:161
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::classifier::training::interface1::Batch
Algorithm class for training the classifier model.
Definition: classifier_training_batch.h:82
daal::algorithms::brownboost::training::interface1::BatchContainer
Provides methods to run implementations of BrownBoost model-based training. This class is associated ...
Definition: brownboost_training_batch.h:79
daal::algorithms::boosting::interface1::Parameter
Base class for parameters of the boosting algorithm
Definition: boosting_model.h:84
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::brownboost::interface1::Parameter
BrownBoost algorithm parameters.
Definition: brownboost_model.h:81
daal::algorithms::brownboost::training::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: brownboost_training_batch.h:149
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

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