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

kdtree_knn_classification_predict_types.h
1 /* file: kdtree_knn_classification_predict_types.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 K-Nearest Neighbors (kNN) algorithm interface
45 //--
46 */
47 
48 #ifndef __KDTREE_KNN_CLASSIFICATION_PREDICT_TYPES_H__
49 #define __KDTREE_KNN_CLASSIFICATION_PREDICT_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/data_serialize.h"
53 #include "algorithms/k_nearest_neighbors/kdtree_knn_classification_model.h"
54 #include "algorithms/classifier/classifier_predict_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 
64 namespace kdtree_knn_classification
65 {
66 
76 namespace prediction
77 {
78 
83 enum Method
84 {
85  defaultDense = 0
86 };
87 
91 namespace interface1
92 {
93 
98 class DAAL_EXPORT Input : public classifier::prediction::Input
99 {
100  typedef classifier::prediction::Input super;
101 public:
103  Input();
104 
105  using super::get;
106  using super::set;
107 
113  kdtree_knn_classification::ModelPtr get(classifier::prediction::ModelInputId id) const;
114 
120  void set(classifier::prediction::NumericTableInputId id, const data_management::NumericTablePtr &ptr);
121 
127  void set(classifier::prediction::ModelInputId id, const kdtree_knn_classification::interface1::ModelPtr & value);
128 
134  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
135 };
136 
137 } // namespace interface1
138 
139 using interface1::Input;
140 
141 } // namespace prediction
143 } // namespace kdtree_knn_classification
144 } // namespace algorithms
145 } // namespace daal
146 
147 #endif
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::algorithms::classifier::prediction::NumericTableInputId
NumericTableInputId
Definition: classifier_predict_types.h:79
daal
Definition: algorithm_base_common.h:57
daal::algorithms::classifier::prediction::interface1::Input
Input objects in the prediction stage of the classification algorithm.
Definition: classifier_predict_types.h:133
daal::algorithms::neural_networks::prediction::prediction
Definition: neural_networks_prediction_result.h:79
daal::algorithms::classifier::prediction::ModelInputId
ModelInputId
Definition: classifier_predict_types.h:90
daal::algorithms::kdtree_knn_classification::prediction::Method
Method
Available methods for making KD-tree based kNN model-based prediction.
Definition: kdtree_knn_classification_predict_types.h:83
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
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::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::math::abs::value
Definition: abs_types.h:112
daal::algorithms::kdtree_knn_classification::prediction::defaultDense
Definition: kdtree_knn_classification_predict_types.h:85

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