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

svm_train.h
1 /* file: svm_train.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 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  Parameter parameter;
122  classifier::training::Input input;
125  Batch()
126  {
127  initialize();
128  };
129 
136  Batch(const Batch<algorithmFPType, method> &other) : classifier::training::Batch(other),
137  parameter(other.parameter), input(other.input)
138  {
139  initialize();
140  }
141 
142  virtual ~Batch() {}
143 
148  classifier::training::Input * getInput() DAAL_C11_OVERRIDE { return &input; }
149 
154  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
155 
160  ResultPtr getResult()
161  {
162  return Result::cast(_result);
163  }
164 
168  services::Status resetResult() DAAL_C11_OVERRIDE
169  {
170  _result.reset(new Result());
171  DAAL_CHECK(_result, services::ErrorNullResult);
172  _res = NULL;
173  return services::Status();
174  }
175 
181  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
182  {
183  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
184  }
185 
186 protected:
187  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
188  {
189  return new Batch<algorithmFPType, method>(*this);
190  }
191 
192  services::Status allocateResult() DAAL_C11_OVERRIDE
193  {
194  ResultPtr res = getResult();
195  DAAL_CHECK(res, services::ErrorNullResult);
196  services::Status s = res->template allocate<algorithmFPType>(&input, _par, (int) method);
197  _res = _result.get();
198  return s;
199  }
200 
201  void initialize()
202  {
203  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
204  _in = &input;
205  _par = &parameter;
206  _result.reset(new Result());
207  }
208 };
210 } // namespace interface1
211 using interface1::BatchContainer;
212 using interface1::Batch;
213 
214 } // namespace training
215 } // namespace svm
216 } // namespace algorithms
217 } // namespace daal
218 #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
Definition: algorithm_base_common.h:57
daal::algorithms::svm::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: svm_train.h:181
daal::algorithms::svm::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: svm_train.h:154
daal::algorithms::svm::training::interface1::Batch::input
classifier::training::Input input
Definition: svm_train.h:122
daal::algorithms::svm::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: svm_train.h:136
daal::algorithms::svm::training::interface1::BatchContainer
Class containing methods to compute results of the SVM training.
Definition: svm_train.h:81
daal::algorithms::svm::training::interface1::Batch::parameter
Parameter parameter
Definition: svm_train.h:121
daal::batch
Definition: daal_defines.h:131
daal::algorithms::svm::training::interface1::Batch::Batch
Batch()
Definition: svm_train.h:125
daal::algorithms::svm::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: svm_train.h:160
daal::algorithms::svm::training::interface1::Batch::getInput
classifier::training::Input * getInput() DAAL_C11_OVERRIDE
Definition: svm_train.h:148
daal::algorithms::svm::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: svm_train.h:168
daal::algorithms::svm::training::interface1::Batch
Algorithm class to train the SVM model
Definition: svm_train.h:118
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.