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

kdtree_knn_classification_predict.h
1 /* file: kdtree_knn_classification_predict.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 K-Nearest Neighbors (kNN) model-based prediction
45 //--
46 */
47 
48 #ifndef __KDTREE_KNN_CLASSIFICATION_PREDICT_H__
49 #define __KDTREE_KNN_CLASSIFICATION_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "algorithms/k_nearest_neighbors/kdtree_knn_classification_predict_types.h"
53 #include "algorithms/k_nearest_neighbors/kdtree_knn_classification_model.h"
54 #include "algorithms/classifier/classifier_predict.h"
55 #include "data_management/data/homogen_numeric_table.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace kdtree_knn_classification
62 {
63 namespace prediction
64 {
65 namespace interface1
66 {
77 template<typename algorithmFPType, Method method, CpuType cpu>
78 class DAAL_EXPORT BatchContainer : public PredictionContainerIface
79 {
80 public:
85  BatchContainer(daal::services::Environment::env *daalEnv);
86 
87  ~BatchContainer();
88 
92  services::Status compute() DAAL_C11_OVERRIDE;
93 };
94 
111 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
112 class Batch : public classifier::prediction::Batch
113 {
114 public:
115  Input input;
116  Parameter parameter;
119  Batch()
120  {
121  initialize();
122  }
123 
130  Batch(const Batch<algorithmFPType, method> & other) : classifier::prediction::Batch(other), input(other.input), parameter(other.parameter)
131  {
132  initialize();
133  }
134 
139  Input * getInput() DAAL_C11_OVERRIDE { return &input; }
140 
145  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
146 
152  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
153  {
154  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
155  }
156 
157 protected:
158  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
159  {
160  return new Batch<algorithmFPType, method>(*this);
161  }
162 
163  services::Status allocateResult() DAAL_C11_OVERRIDE
164  {
165  services::Status s = _result->allocate<algorithmFPType>(&input, &parameter, (int)method);
166  _res = _result.get();
167  return s;
168  }
169 
170  void initialize()
171  {
172  _in = &input;
173  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
174  _par = &parameter;
175  }
176 };
177 
179 } // namespace interface1
180 
181 using interface1::BatchContainer;
182 using interface1::Batch;
183 
184 } // namespace prediction
185 } // namespace kdtree_knn_classification
186 } // namespace algorithms
187 } // namespace daal
188 
189 #endif
daal::algorithms::kdtree_knn_classification::prediction::interface1::BatchContainer
Class containing computation methods for KD-tree based kNN model-based prediction.
Definition: kdtree_knn_classification_predict.h:78
daal
Definition: algorithm_base_common.h:57
daal::algorithms::kdtree_knn_classification::prediction::interface1::Batch::input
Input input
Definition: kdtree_knn_classification_predict.h:115
daal::algorithms::kdtree_knn_classification::prediction::interface1::Batch::Batch
Batch()
Definition: kdtree_knn_classification_predict.h:119
daal::algorithms::PredictionContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the algor...
Definition: prediction.h:66
daal::batch
Definition: daal_defines.h:131
daal::algorithms::kdtree_knn_classification::prediction::interface1::Batch::parameter
Parameter parameter
Definition: kdtree_knn_classification_predict.h:116
daal::algorithms::kdtree_knn_classification::prediction::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: kdtree_knn_classification_predict.h:152
daal::algorithms::kdtree_knn_classification::prediction::interface1::Input
Provides an interface for input objects for making KD-tree based kNN model-based prediction.
Definition: kdtree_knn_classification_predict_types.h:98
daal::algorithms::kdtree_knn_classification::prediction::interface1::Batch
Provides methods to run implementations of the KD-tree based kNN model-based prediction.
Definition: kdtree_knn_classification_predict.h:112
daal::algorithms::classifier::prediction::prediction
Definition: classifier_predict_types.h:102
daal::algorithms::kdtree_knn_classification::prediction::interface1::Batch::getInput
Input * getInput() DAAL_C11_OVERRIDE
Definition: kdtree_knn_classification_predict.h:139
daal::algorithms::kdtree_knn_classification::prediction::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: kdtree_knn_classification_predict.h:145
daal::algorithms::kdtree_knn_classification::prediction::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: kdtree_knn_classification_predict.h:130

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