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

linear_model_predict_types.h
1 /* file: linear_model_predict_types.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 regression algorithm interface
45 //--
46 */
47 
48 #ifndef __LINEAR_MODEL_PREDICT_TYPES_H__
49 #define __LINEAR_MODEL_PREDICT_TYPES_H__
50 
51 #include "data_management/data/numeric_table.h"
52 #include "algorithms/algorithm_types.h"
53 #include "algorithms/linear_model/linear_model_model.h"
54 #include "algorithms/regression/regression_predict_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace linear_model
61 {
71 namespace prediction
72 {
77 enum Method
78 {
79  defaultDense = 0
80 };
81 
86 enum NumericTableInputId
87 {
88  data = regression::prediction::data,
89  lastNumericTableInputId = data
90 };
91 
96 enum ModelInputId
97 {
98  model = regression::prediction::model,
99  lastModelInputId = model
100 };
101 
106 enum ResultId
107 {
108  prediction = regression::prediction::prediction,
109  lastResultId = prediction
110 };
111 
115 namespace interface1
116 {
121 class DAAL_EXPORT Input : public regression::prediction::Input
122 {
123 public:
125  Input(size_t nElements = 0);
126  Input(const Input& other);
127 
133  data_management::NumericTablePtr get(NumericTableInputId id) const;
134 
140  linear_model::ModelPtr get(ModelInputId id) const;
141 
147  void set(NumericTableInputId id, const data_management::NumericTablePtr &value);
148 
154  void set(ModelInputId id, const linear_model::ModelPtr &value);
155 
161  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
162 };
163 
164 
169 class DAAL_EXPORT Result : public regression::prediction::Result
170 {
171 public:
172  DECLARE_SERIALIZABLE_CAST(Result);
173  Result(size_t nElements = 0);
174 
180  data_management::NumericTablePtr get(ResultId id) const;
181 
187  void set(ResultId id, const data_management::NumericTablePtr &value);
188 
197  template <typename algorithmFPType>
198  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method);
199 
208  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
209 
210 protected:
212  template<typename Archive, bool onDeserialize>
213  services::Status serialImpl(Archive *arch)
214  {
215  return regression::prediction::Result::serialImpl<Archive, onDeserialize>(arch);
216  }
217 };
218 typedef services::SharedPtr<Result> ResultPtr;
219 typedef services::SharedPtr<const Result> ResultConstPtr;
220 } // namespace interface1
221 using interface1::Input;
222 using interface1::Result;
223 using interface1::ResultPtr;
224 using interface1::ResultConstPtr;
225 }
227 }
228 }
229 }
230 
231 #endif
daal::algorithms::linear_model::prediction::NumericTableInputId
NumericTableInputId
Available identifiers of input numeric tables for making the regression model-based prediction...
Definition: linear_model_predict_types.h:86
daal::algorithms::linear_model::prediction::ResultId
ResultId
Available identifiers of the result for making the regression model-based prediction.
Definition: linear_model_predict_types.h:106
daal::algorithms::linear_model::prediction::interface1::Result
Provides interface for the result of the regression model-based prediction.
Definition: linear_model_predict_types.h:169
daal
Definition: algorithm_base_common.h:57
daal::algorithms::linear_model::prediction::interface1::Input
Provides an interface for input objects for making the regression model-based prediction.
Definition: linear_model_predict_types.h:121
daal::algorithms::linear_model::prediction::data
Definition: linear_model_predict_types.h:88
daal::algorithms::linear_model::prediction::ModelInputId
ModelInputId
Available identifiers of input models for making the regression model-based prediction.
Definition: linear_model_predict_types.h:96
daal::algorithms::linear_model::prediction::prediction
Definition: linear_model_predict_types.h:108
daal::algorithms::linear_model::prediction::Method
Method
Available methods for making the regression model-based prediction.
Definition: linear_model_predict_types.h:77
daal::algorithms::regression::prediction::prediction
Definition: regression_predict_types.h:98
daal::algorithms::linear_model::prediction::defaultDense
Definition: linear_model_predict_types.h:79
daal::algorithms::regression::prediction::data
Definition: regression_predict_types.h:78
daal::algorithms::linear_model::prediction::model
Definition: linear_model_predict_types.h:98
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::regression::prediction::model
Definition: regression_predict_types.h:88

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