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

multi_class_classifier_train.h
1 /* file: multi_class_classifier_train.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 multi-class classifier model-based training
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __MULTI_CLASS_CLASSIFIER_TRAIN_H__
50 #define __MULTI_CLASS_CLASSIFIER_TRAIN_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/numeric_table.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/classifier/classifier_training_batch.h"
56 #include "algorithms/multi_class_classifier/multi_class_classifier_train_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace multi_class_classifier
63 {
67 namespace training
68 {
69 
73 namespace interface1
74 {
87 template<typename algorithmFPType, Method method, CpuType cpu>
88 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
89 {
90 public:
96  BatchContainer(daal::services::Environment::env *daalEnv);
98  ~BatchContainer();
104  services::Status compute() DAAL_C11_OVERRIDE;
105 };
106 
124 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = oneAgainstOne>
125 class DAAL_EXPORT Batch : public classifier::training::Batch
126 {
127 public:
128  typedef classifier::training::Batch super;
129 
130  typedef typename super::InputType InputType;
131  typedef algorithms::multi_class_classifier::Parameter ParameterType;
132  typedef algorithms::multi_class_classifier::training::Result ResultType;
133 
134  ParameterType parameter;
135  InputType input;
141  DAAL_DEPRECATED Batch() : parameter(0)
142  {
143  initialize();
144  }
145 
150  Batch(size_t nClasses) : parameter(nClasses)
151  {
152  initialize();
153  }
154 
161  Batch(const Batch<algorithmFPType, method> &other) : classifier::training::Batch(other),
162  parameter(other.parameter), input(other.input)
163  {
164  initialize();
165  }
166 
167  ~Batch() {}
168 
173  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
174 
179  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
180 
185  ResultPtr getResult()
186  {
187  return ResultType::cast(_result);
188  }
189 
193  services::Status resetResult() DAAL_C11_OVERRIDE
194  {
195  _result.reset(new ResultType());
196  DAAL_CHECK(_result, services::ErrorNullResult);
197  _res = NULL;
198  return services::Status();
199  }
200 
206  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
207  {
208  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
209  }
210 
211 protected:
212  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
213  {
214  return new Batch<algorithmFPType, method>(*this);
215  }
216 
217  services::Status allocateResult() DAAL_C11_OVERRIDE
218  {
219  ResultPtr res = getResult();
220  DAAL_CHECK(_result, services::ErrorNullResult);
221  services::Status s = res->template allocate<algorithmFPType>(&input, _par, method);
222  _res = _result.get();
223  return s;
224  }
225 
226  void initialize()
227  {
228  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
229  _in = &input;
230  _par = &parameter;
231  _result.reset(new ResultType());
232  }
233 };
235 } // namespace interface1
236 using interface1::BatchContainer;
237 using interface1::Batch;
238 
239 } // namespace training
240 } // namespace multi_class_classifier
241 } // namespace algorithms
242 } //namespace daal
243 #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::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::multi_class_classifier::training::interface1::Batch::input
InputType input
Definition: multi_class_classifier_train.h:135
daal::algorithms::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:81
daal::algorithms::multi_class_classifier::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: multi_class_classifier_train.h:206
daal::algorithms::multi_class_classifier::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: multi_class_classifier_train.h:179
daal::algorithms::multi_class_classifier::training::interface1::Batch::Batch
Batch(size_t nClasses)
Definition: multi_class_classifier_train.h:150
daal::algorithms::multi_class_classifier::interface1::Parameter
Optional multi-class classifier algorithm parameters that are used with the MultiClassClassifierWu pr...
Definition: multi_class_classifier_model.h:104
daal::algorithms::multi_class_classifier::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: multi_class_classifier_train.h:185
daal::algorithms::multi_class_classifier::training::interface1::Batch::parameter
ParameterType parameter
Definition: multi_class_classifier_train.h:134
daal_defines.h
daal::algorithms::multi_class_classifier::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: multi_class_classifier_train.h:193
daal::batch
Definition: daal_defines.h:132
daal::algorithms::multi_class_classifier::training::interface1::BatchContainer
Class containing methods to compute the results of multi-class classifier model-based training...
Definition: multi_class_classifier_train.h:88
daal::algorithms::multi_class_classifier::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: multi_class_classifier_train.h:161
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::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::multi_class_classifier::training::interface1::Result
Provides methods to access final results obtained with the compute() method for the multi-class class...
Definition: multi_class_classifier_train_types.h:89
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::multi_class_classifier::training::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: multi_class_classifier_train.h:173
daal::algorithms::multi_class_classifier::training::interface1::Batch
Algorithm for the multi-class classifier model training.
Definition: multi_class_classifier_train.h:125

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