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

linear_regression_predict_types.h
1 /* file: linear_regression_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 linear regression algorithm interface
45 //--
46 */
47 
48 #ifndef __LINEAR_REGRESSION_PREDICT_TYPES_H__
49 #define __LINEAR_REGRESSION_PREDICT_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "algorithms/linear_regression/linear_regression_model.h"
54 #include "algorithms/linear_model/linear_model_predict_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
63 namespace linear_regression
64 {
74 namespace prediction
75 {
80 enum Method
81 {
82  defaultDense = 0
83 };
84 
89 enum NumericTableInputId
90 {
91  data = linear_model::prediction::data,
92  lastNumericTableInputId = data
93 };
94 
99 enum ModelInputId
100 {
101  model = linear_model::prediction::model,
102  lastModelInputId = model
103 };
104 
109 enum ResultId
110 {
111  prediction = linear_model::prediction::prediction,
112  lastResultId = prediction
113 };
114 
118 namespace interface1
119 {
124 class DAAL_EXPORT Input : public linear_model::prediction::Input
125 {
126 public:
128  Input();
129 
135  data_management::NumericTablePtr get(NumericTableInputId id) const;
136 
142  linear_regression::ModelPtr get(ModelInputId id) const;
143 
149  void set(NumericTableInputId id, const data_management::NumericTablePtr &value);
150 
156  void set(ModelInputId id, const linear_regression::ModelPtr &value);
157 };
158 
163 class DAAL_EXPORT Result : public linear_model::prediction::Result
164 {
165 public:
166  DECLARE_SERIALIZABLE_CAST(Result);
167  Result();
168 
174  data_management::NumericTablePtr get(ResultId id) const;
175 
181  void set(ResultId id, const data_management::NumericTablePtr &value);
182 
183 protected:
185  template<typename Archive, bool onDeserialize>
186  services::Status serialImpl(Archive *arch)
187  {
188  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
189  }
190 };
191 typedef services::SharedPtr<Result> ResultPtr;
192 typedef services::SharedPtr<const Result> ResultConstPtr;
193 } // namespace interface1
194 using interface1::Input;
195 using interface1::Result;
196 using interface1::ResultPtr;
197 using interface1::ResultConstPtr;
198 }
200 }
201 }
202 } // namespace daal
203 #endif
daal::algorithms::linear_regression::prediction::interface1::Input
Provides an interface for input objects for making linear regression model-based prediction.
Definition: linear_regression_predict_types.h:124
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::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::linear_regression::prediction::Method
Method
Available methods for making linear regression model-based prediction.
Definition: linear_regression_predict_types.h:80
daal::algorithms::linear_model::prediction::model
Definition: linear_model_predict_types.h:98
daal::algorithms::linear_model::prediction::data
Definition: linear_model_predict_types.h:88
daal::algorithms::neural_networks::prediction::prediction
Definition: neural_networks_prediction_result.h:79
daal::algorithms::linear_regression::prediction::interface1::Result
Provides interface for the result of linear regression model-based prediction.
Definition: linear_regression_predict_types.h:163
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_regression::prediction::data
Definition: linear_regression_predict_types.h:91
daal::algorithms::linear_model::prediction::prediction
Definition: linear_model_predict_types.h:108
daal::algorithms::linear_regression::prediction::prediction
Definition: linear_regression_predict_types.h:111
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::linear_regression::prediction::ModelInputId
ModelInputId
Available identifiers of input models for making linear regression model-based prediction.
Definition: linear_regression_predict_types.h:99
daal::algorithms::linear_regression::prediction::NumericTableInputId
NumericTableInputId
Available identifiers of input numeric tables for making linear regression model-based prediction...
Definition: linear_regression_predict_types.h:89
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::linear_regression::prediction::model
Definition: linear_regression_predict_types.h:101
daal::algorithms::linear_regression::prediction::ResultId
ResultId
Available identifiers of the result for making linear regression model-based prediction.
Definition: linear_regression_predict_types.h:109

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