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

linear_regression_predict.h
1 /* file: linear_regression_predict.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 interface for linear regression model-based prediction
45 //--
46 */
47 
48 #ifndef __LINEAR_REGRESSION_PREDICT_H__
49 #define __LINEAR_REGRESSION_PREDICT_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "services/daal_defines.h"
53 #include "algorithms/linear_regression/linear_regression_predict_types.h"
54 #include "algorithms/linear_model/linear_model_predict.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace linear_regression
61 {
62 namespace prediction
63 {
64 namespace interface1
65 {
91 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
92 class Batch
93 {};
94 
111 template<typename algorithmFPType>
112 class Batch<algorithmFPType, defaultDense> : public linear_model::prediction::Batch<algorithmFPType, linear_model::prediction::defaultDense>
113 {
114 public:
115  typedef algorithms::linear_regression::prediction::Input InputType;
116  typedef algorithms::linear_regression::Parameter ParameterType;
117  typedef algorithms::linear_regression::prediction::Result ResultType;
118 
119  InputType input;
122  Batch()
123  {
124  initialize();
125  }
126 
133  Batch(const Batch<algorithmFPType, defaultDense> &other) : input(other.input)
134  {
135  initialize();
136  }
137 
142  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)defaultDense; }
143 
148  ResultPtr getResult() { return ResultType::cast(this->_result); }
149 
155  services::SharedPtr<Batch<algorithmFPType, defaultDense> > clone() const
156  {
157  return services::SharedPtr<Batch<algorithmFPType, defaultDense> >(cloneImpl());
158  }
159 
160  virtual regression::prediction::Input* getInput() DAAL_C11_OVERRIDE { return &input; }
161 
162 protected:
163 
164  virtual Batch<algorithmFPType, defaultDense> * cloneImpl() const DAAL_C11_OVERRIDE
165  {
166  return new Batch<algorithmFPType, defaultDense>(*this);
167  }
168 
169  services::Status allocateResult() DAAL_C11_OVERRIDE
170  {
171  services::Status s = getResult()->template allocate<algorithmFPType>(this->_in, 0, 0);
172  this->_res = this->_result.get();
173  return s;
174  }
175 
176  void initialize()
177  {
178  this->_ac = new __DAAL_ALGORITHM_CONTAINER(batch, linear_model::prediction::BatchContainer, algorithmFPType, linear_model::prediction::defaultDense)(&(this->_env));
179  this->_in = &input;
180  this->_par = NULL;
181  this->_result.reset(new ResultType());
182  }
183 };
185 } // namespace interface1
186 using interface1::Batch;
187 
188 }
189 }
190 }
191 }
192 #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::algorithms::linear_regression::prediction::interface1::Batch< algorithmFPType, defaultDense >::Batch
Batch()
Definition: linear_regression_predict.h:122
daal
Definition: algorithm_base_common.h:57
daal::algorithms::linear_model::prediction::interface1::BatchContainer
Class containing computation methods for the regression model-based prediction.
Definition: linear_model_predict.h:74
daal::algorithms::linear_model::prediction::interface1::Batch
Provides methods to run implementations of the regression model-based prediction. ...
Definition: linear_model_predict.h:107
daal::algorithms::association_rules::defaultDense
Definition: apriori_types.h:77
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_model::interface1::Parameter
Parameters for the regression algorithm.
Definition: linear_model_model.h:85
daal_defines.h
daal::algorithms::linear_regression::prediction::interface1::Batch< algorithmFPType, defaultDense >::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: linear_regression_predict.h:142
daal::batch
Definition: daal_defines.h:132
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_model::prediction::defaultDense
Definition: linear_model_predict_types.h:79
daal::algorithms::linear_regression::prediction::interface1::Batch< algorithmFPType, defaultDense >::getResult
ResultPtr getResult()
Definition: linear_regression_predict.h:148
daal::algorithms::regression::prediction::interface1::Input
Provides an interface for input objects for making the regression model-based prediction.
Definition: regression_predict_types.h:111
daal::algorithms::linear_regression::prediction::interface1::Batch< algorithmFPType, defaultDense >::input
InputType input
Definition: linear_regression_predict.h:119
daal::algorithms::linear_regression::prediction::interface1::Batch< algorithmFPType, defaultDense >::Batch
Batch(const Batch< algorithmFPType, defaultDense > &other)
Definition: linear_regression_predict.h:133
daal::algorithms::linear_regression::interface1::Parameter
Parameters for the linear regression algorithm.
Definition: linear_regression_model.h:82
daal::algorithms::linear_regression::prediction::interface1::Batch
Provides methods to run implementations of the linear regression model-based prediction.
Definition: linear_regression_predict.h:92
daal::algorithms::linear_regression::prediction::interface1::Batch< algorithmFPType, defaultDense >
Provides methods to run implementations of the linear regression model-based prediction.
Definition: linear_regression_predict.h:112
daal::algorithms::linear_regression::prediction::interface1::Batch< algorithmFPType, defaultDense >::clone
services::SharedPtr< Batch< algorithmFPType, defaultDense > > clone() const
Definition: linear_regression_predict.h:155

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