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

kdtree_knn_classification_training_types.h
1 /* file: kdtree_knn_classification_training_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 Neighbor (kNN) algorithm interface
45 //--
46 */
47 
48 #ifndef __KNN_CLASSIFICATION_TRAINING_TYPES_H__
49 #define __KNN_CLASSIFICATION_TRAINING_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_training_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 
64 namespace kdtree_knn_classification
65 {
66 
76 namespace training
77 {
78 
83 enum Method
84 {
85  defaultDense = 0
86 };
87 
91 namespace interface1
92 {
93 
98 class DAAL_EXPORT Result : public classifier::training::Result
99 {
100 public:
101  DECLARE_SERIALIZABLE_CAST(Result);
102  Result();
103 
109  daal::algorithms::kdtree_knn_classification::interface1::ModelPtr get(classifier::training::ResultId id) const;
110 
117  template<typename algorithmFPType>
118  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const Parameter *parameter, int method);
119 
120 protected:
122  template<typename Archive, bool onDeserialize>
123  services::Status serialImpl(Archive *arch)
124  {
125  return classifier::training::Result::serialImpl<Archive, onDeserialize>(arch);
126  }
127 };
128 typedef services::SharedPtr<Result> ResultPtr;
129 } // namespace interface1
130 
131 using interface1::Result;
132 using interface1::ResultPtr;
133 
134 } // namespace training
136 } // namespace kdtree_knn_classification
137 } // namespace algorithms
138 } // namespace daal
139 
140 #endif
daal::algorithms::kdtree_knn_classification::interface1::Parameter
KD-tree based kNN algorithm parameters.
Definition: kdtree_knn_classification_model.h:98
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::kdtree_knn_classification::training::Method
Method
Computation methods for KD-tree based kNN model-based training.
Definition: kdtree_knn_classification_training_types.h:83
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::classifier::training::ResultId
ResultId
Definition: classifier_training_types.h:106
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::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::defaultDense
Definition: kdtree_knn_classification_training_types.h:85
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217

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