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

classifier_predict_types.h
1 /* file: classifier_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 base classes used in the prediction stage
45 // of the classifier algorithm
46 //--
47 */
48 
49 #ifndef __CLASSIFIER_PREDICT_TYPES_H__
50 #define __CLASSIFIER_PREDICT_TYPES_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "algorithms/classifier/classifier_model.h"
54 
55 #include "data_management/data/homogen_numeric_table.h"
56 
57 namespace daal
58 {
59 namespace algorithms
60 {
61 namespace classifier
62 {
72 namespace prediction
73 {
79 enum NumericTableInputId
80 {
81  data,
82  lastNumericTableInputId = data
83 };
84 
90 enum ModelInputId
91 {
92  model = lastNumericTableInputId + 1,
93  lastModelInputId = model
94 };
95 
100 enum ResultId
101 {
102  prediction,
103  lastResultId = prediction
104 };
105 
109 namespace interface1
110 {
115 class DAAL_EXPORT InputIface : public daal::algorithms::Input
116 {
117 public:
118  InputIface(size_t nElements);
119  InputIface(const InputIface& other) : daal::algorithms::Input(other){}
120 
121  virtual ~InputIface() {}
126  virtual size_t getNumberOfRows() const = 0;
127 };
128 
133 class DAAL_EXPORT Input : public InputIface
134 {
135 public:
136  Input();
137  Input(const Input& other) : InputIface(other){}
138  virtual ~Input() {}
139 
144  size_t getNumberOfRows() const DAAL_C11_OVERRIDE;
145 
151  data_management::NumericTablePtr get(NumericTableInputId id) const;
152 
158  classifier::ModelPtr get(ModelInputId id) const;
159 
165  void set(NumericTableInputId id, const data_management::NumericTablePtr &ptr);
166 
172  void set(ModelInputId id, const ModelPtr &ptr);
173 
179  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
180 
181 protected:
182  services::Status checkImpl(const daal::algorithms::Parameter *parameter) const;
183 };
184 
190 class DAAL_EXPORT Result : public daal::algorithms::Result
191 {
192 public:
193  DECLARE_SERIALIZABLE_CAST(Result);
194  Result();
195 
201  data_management::NumericTablePtr get(ResultId id) const;
202 
208  void set(ResultId id, const data_management::NumericTablePtr &value);
209 
217  template <typename algorithmFPType>
218  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
219 
226  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter,
227  int method) const DAAL_C11_OVERRIDE;
228 
229 protected:
230  services::Status checkImpl(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter) const;
231 
233  template<typename Archive, bool onDeserialize>
234  services::Status serialImpl(Archive *arch)
235  {
236  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
237  }
238 };
239 typedef services::SharedPtr<Result> ResultPtr;
240 } // namespace interface1
241 using interface1::InputIface;
242 using interface1::Input;
243 using interface1::Result;
244 using interface1::ResultPtr;
245 }
247 }
248 }
249 }
250 #endif
daal::algorithms::classifier::prediction::interface1::Result
Provides methods to access prediction results obtained with the compute() method of the classifier pr...
Definition: classifier_predict_types.h:190
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::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:331
daal::algorithms::classifier::prediction::prediction
Definition: classifier_predict_types.h:102
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::classifier::prediction::ResultId
ResultId
Definition: classifier_predict_types.h:100
daal::algorithms::classifier::prediction::data
Definition: classifier_predict_types.h:81
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::classifier::prediction::interface1::InputIface
Base class for working with input objects in the prediction stage of the classification algorithm...
Definition: classifier_predict_types.h:115
daal::algorithms::classifier::prediction::model
Definition: classifier_predict_types.h:92
daal::algorithms::math::abs::value
Definition: abs_types.h:112
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.