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

kdtree_knn_classification_training_batch.h
1 /* file: kdtree_knn_classification_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 k-Nearest Neighbor (kNN) model-based training in the batch processing mode
45 //--
46 */
47 
48 #ifndef __KDTREE_KNN_CLASSIFICATION_TRAINING_BATCH_H__
49 #define __KDTREE_KNN_CLASSIFICATION_TRAINING_BATCH_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/k_nearest_neighbors/kdtree_knn_classification_training_types.h"
53 #include "algorithms/k_nearest_neighbors/kdtree_knn_classification_model.h"
54 #include "algorithms/classifier/classifier_training_batch.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace kdtree_knn_classification
61 {
62 namespace training
63 {
64 namespace interface1
65 {
76 template <typename algorithmFPType, Method method, CpuType cpu>
77 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
78 {
79 public:
84  BatchContainer(daal::services::Environment::env * daalEnv);
85 
87  ~BatchContainer();
88 
92  services::Status compute() DAAL_C11_OVERRIDE;
93 };
94 
110 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
111 class DAAL_EXPORT Batch : public classifier::training::Batch
112 {
113 public:
114  typedef classifier::training::Batch super;
115 
116  typedef typename super::InputType InputType;
117  typedef algorithms::kdtree_knn_classification::Parameter ParameterType;
118  typedef algorithms::kdtree_knn_classification::training::Result ResultType;
119 
120  ParameterType parameter;
121  InputType input;
124  Batch()
125  {
126  initialize();
127  }
128 
135  Batch(const Batch<algorithmFPType, method> & other) : classifier::training::Batch(other),
136  parameter(other.parameter), input(other.input)
137  {
138  initialize();
139  }
140 
145  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
146 
151  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
152 
157  ResultPtr getResult() { return Result::cast(_result); }
158 
162  services::Status resetResult() DAAL_C11_OVERRIDE
163  {
164  _result.reset(new ResultType());
165  DAAL_CHECK(_result, services::ErrorNullResult);
166  _res = NULL;
167  return services::Status();
168  }
169 
176  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
177  {
178  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
179  }
180 
181 protected:
182  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
183  {
184  return new Batch<algorithmFPType, method>(*this);
185  }
186 
187  services::Status allocateResult() DAAL_C11_OVERRIDE
188  {
189  const ResultPtr res = getResult();
190  DAAL_CHECK(_result, services::ErrorNullResult);
191  services::Status s = res->template allocate<algorithmFPType>((classifier::training::InputIface *)(&input), &parameter, (int)method);
192  _res = _result.get();
193  return s;
194  }
195 
196  void initialize()
197  {
198  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
199  _in = &input;
200  _par = &parameter;
201  _result.reset(new ResultType());
202  }
203 };
204 
206 } // namespace interface1
207 
208 using interface1::BatchContainer;
209 using interface1::Batch;
210 
211 } // namespace training
212 } // namespace kdtree_knn_classification
213 } // namespace algorithms
214 } // namespace daal
215 
216 #endif
daal::algorithms::kdtree_knn_classification::interface1::Parameter
KD-tree based kNN algorithm parameters.
Definition: kdtree_knn_classification_model.h:98
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::classifier::training::interface1::InputIface
Abstract class that specifies the interface of the classes of the classification algorithm input obje...
Definition: classifier_training_types.h:121
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::input
InputType input
Definition: kdtree_knn_classification_training_batch.h:121
daal::algorithms::kdtree_knn_classification::training::interface1::Batch
Provides methods for KD-tree based kNN model-based training in the batch processing mode...
Definition: kdtree_knn_classification_training_batch.h:111
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: kdtree_knn_classification_training_batch.h:157
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::kdtree_knn_classification::training::interface1::Result
Provides methods to access the result obtained with the compute() method of KD-tree based kNN model-b...
Definition: kdtree_knn_classification_training_types.h:98
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: kdtree_knn_classification_training_batch.h:176
daal::algorithms::classifier::training::interface1::Batch
Algorithm class for training the classifier model.
Definition: classifier_training_batch.h:82
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::kdtree_knn_classification::training::interface1::BatchContainer
Class containing methods for KD-tree based kNN model-based training using algorithmFPType precision a...
Definition: kdtree_knn_classification_training_batch.h:77
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::Batch
Batch()
Definition: kdtree_knn_classification_training_batch.h:124
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::parameter
ParameterType parameter
Definition: kdtree_knn_classification_training_batch.h:120
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: kdtree_knn_classification_training_batch.h:145
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: kdtree_knn_classification_training_batch.h:151
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: kdtree_knn_classification_training_batch.h:162
daal::algorithms::kdtree_knn_classification::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: kdtree_knn_classification_training_batch.h:135
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.