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

svm_train.h
1 /* file: svm_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 SVM model-based training in the batch
45 // processing mode
46 //--
47 */
48 
49 #ifndef __SVM_TRAIN_H__
50 #define __SVM_TRAIN_H__
51 
52 #include "algorithms/algorithm.h"
53 
54 #include "algorithms/svm/svm_train_types.h"
55 #include "algorithms/classifier/classifier_training_batch.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace svm
62 {
63 namespace training
64 {
65 
66 namespace interface1
67 {
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();
97  services::Status compute() DAAL_C11_OVERRIDE;
98 };
99 
117 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = boser>
118 class DAAL_EXPORT Batch : public classifier::training::Batch
119 {
120 public:
121  typedef classifier::training::Batch super;
122 
123  typedef typename super::InputType InputType;
124  typedef algorithms::svm::Parameter ParameterType;
125  typedef algorithms::svm::training::Result ResultType;
126 
127  ParameterType parameter;
128  InputType input;
131  Batch()
132  {
133  initialize();
134  };
135 
142  Batch(const Batch<algorithmFPType, method> &other) : classifier::training::Batch(other),
143  parameter(other.parameter), input(other.input)
144  {
145  initialize();
146  }
147 
148  virtual ~Batch() {}
149 
154  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
155 
160  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
161 
166  ResultPtr getResult()
167  {
168  return ResultType::cast(_result);
169  }
170 
174  services::Status resetResult() DAAL_C11_OVERRIDE
175  {
176  _result.reset(new ResultType());
177  DAAL_CHECK(_result, services::ErrorNullResult);
178  _res = NULL;
179  return services::Status();
180  }
181 
187  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
188  {
189  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
190  }
191 
192 protected:
193  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
194  {
195  return new Batch<algorithmFPType, method>(*this);
196  }
197 
198  services::Status allocateResult() DAAL_C11_OVERRIDE
199  {
200  ResultPtr res = getResult();
201  DAAL_CHECK(res, services::ErrorNullResult);
202  services::Status s = res->template allocate<algorithmFPType>(&input, _par, (int) method);
203  _res = _result.get();
204  return s;
205  }
206 
207  void initialize()
208  {
209  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
210  _in = &input;
211  _par = &parameter;
212  _result.reset(new ResultType());
213  }
214 };
216 } // namespace interface1
217 using interface1::BatchContainer;
218 using interface1::Batch;
219 
220 } // namespace training
221 } // namespace svm
222 } // namespace algorithms
223 } // namespace daal
224 #endif
daal::algorithms::svm::training::interface1::Result
Provides methods to access final results obtained with the compute() method of the SVM training algor...
Definition: svm_train_types.h:93
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::svm::interface1::Parameter
Optional parameters.
Definition: svm_model.h:90
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::svm::training::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: svm_train.h:154
daal::algorithms::svm::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: svm_train.h:160
daal::algorithms::svm::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: svm_train.h:142
daal::algorithms::svm::training::interface1::BatchContainer
Class containing methods to compute results of the SVM training.
Definition: svm_train.h:81
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::svm::training::interface1::Batch::Batch
Batch()
Definition: svm_train.h:131
daal::algorithms::svm::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: svm_train.h:166
daal::algorithms::svm::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: svm_train.h:187
daal::algorithms::classifier::training::interface1::Batch
Algorithm class for training the classifier model.
Definition: classifier_training_batch.h:82
daal::algorithms::svm::training::interface1::Batch::parameter
ParameterType parameter
Definition: svm_train.h:127
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::svm::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: svm_train.h:174
daal::algorithms::svm::training::interface1::Batch
Algorithm class to train the SVM model
Definition: svm_train.h:118
daal::algorithms::svm::training::interface1::Batch::input
InputType input
Definition: svm_train.h:128
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.