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

ridge_regression_training_online.h
1 /* file: ridge_regression_training_online.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Implementation of the interface for ridge regression model-based training in the online processing mode
21 //--
22 */
23 
24 #ifndef __RIDGE_REGRESSION_TRAINING_ONLINE_H__
25 #define __RIDGE_REGRESSION_TRAINING_ONLINE_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "algorithms/ridge_regression/ridge_regression_training_types.h"
29 #include "algorithms/linear_model/linear_model_training_online.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
35 namespace ridge_regression
36 {
37 namespace training
38 {
39 namespace interface1
40 {
50 template<typename algorithmFPType, Method method, CpuType cpu>
51 class OnlineContainer : public TrainingContainerIface<online>
52 {
53 public:
58  OnlineContainer(daal::services::Environment::env *daalEnv);
59 
61  ~OnlineContainer();
62 
68  services::Status compute() DAAL_C11_OVERRIDE;
69 
75  services::Status finalizeCompute() DAAL_C11_OVERRIDE;
76 };
77 
96 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = normEqDense>
97 class DAAL_EXPORT Online : public linear_model::training::Online
98 {
99 public:
100  typedef algorithms::ridge_regression::training::Input InputType;
101  typedef algorithms::ridge_regression::TrainParameter ParameterType;
102  typedef algorithms::ridge_regression::training::Result ResultType;
103  typedef algorithms::ridge_regression::training::PartialResult PartialResultType;
104 
105  InputType input;
106  ParameterType parameter;
109  Online()
110  {
111  initialize();
112  }
113 
119  Online(const Online<algorithmFPType, method> & other) :
120  linear_model::training::Online(other), input(other.input), parameter(other.parameter)
121  {
122  initialize();
123  }
124 
125  ~Online() {}
126 
127  virtual regression::training::Input* getInput() DAAL_C11_OVERRIDE { return &input; }
128 
133  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
134 
139  PartialResultPtr getPartialResult() { return PartialResultType::cast(_partialResult); }
140 
145  ResultPtr getResult() { return ResultType::cast(_result); }
146 
152  services::SharedPtr<Online<algorithmFPType, method> > clone() const
153  {
154  return services::SharedPtr<Online<algorithmFPType, method> >(cloneImpl());
155  }
156 
157 protected:
158 
159  virtual Online<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
160  {
161  return new Online<algorithmFPType, method>(*this);
162  }
163 
164  services::Status allocateResult() DAAL_C11_OVERRIDE
165  {
166  services::Status s = getResult()->template allocate<algorithmFPType>(&input, &parameter, method);
167  _res = _result.get();
168  return s;
169  }
170 
171  services::Status allocatePartialResult() DAAL_C11_OVERRIDE
172  {
173  services::Status s = getPartialResult()->template allocate<algorithmFPType>(&input, &parameter, method);
174  _pres = _partialResult.get();
175  return s;
176  }
177 
178  services::Status initializePartialResult() DAAL_C11_OVERRIDE
179  {
180  services::Status s = getPartialResult()->template initialize<algorithmFPType>(&input, &parameter, method);
181  _pres = _partialResult.get();
182  return s;
183  }
184 
185  void initialize()
186  {
187  _ac = new __DAAL_ALGORITHM_CONTAINER(online, OnlineContainer, algorithmFPType, method)(&_env);
188  _in = &input;
189  _par = &parameter;
190  _partialResult.reset(new PartialResultType());
191  _result.reset(new ResultType());
192  }
193 }; // class : Online
195 } // namespace interface1
196 
197 using interface1::OnlineContainer;
198 using interface1::Online;
199 
200 } // namespace training
201 } // namespace ridge_regression
202 } // namespace algorithms
203 } // namespace daal
204 
205 #endif
daal::algorithms::ridge_regression::training::interface1::Online::getPartialResult
PartialResultPtr getPartialResult()
Definition: ridge_regression_training_online.h:139
daal::algorithms::ridge_regression::training::interface1::Online
Provides methods for ridge regression model-based training in the online processing mode...
Definition: ridge_regression_training_online.h:97
daal::algorithms::ridge_regression::training::interface1::Online::Online
Online()
Definition: ridge_regression_training_online.h:109
daal::algorithms::ridge_regression::training::interface1::Online::clone
services::SharedPtr< Online< algorithmFPType, method > > clone() const
Definition: ridge_regression_training_online.h:152
daal::algorithms::ridge_regression::training::interface1::OnlineContainer::compute
services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::ridge_regression::training::interface1::OnlineContainer::~OnlineContainer
~OnlineContainer()
daal::algorithms::ridge_regression::training::interface1::Online::Online
Online(const Online< algorithmFPType, method > &other)
Definition: ridge_regression_training_online.h:119
daal::algorithms::ridge_regression::training::interface1::Online::input
InputType input
Definition: ridge_regression_training_online.h:105
daal::algorithms::ridge_regression::training::interface1::OnlineContainer::OnlineContainer
OnlineContainer(daal::services::Environment::env *daalEnv)
daal::online
Definition: daal_defines.h:114
daal::algorithms::ridge_regression::training::interface1::OnlineContainer::finalizeCompute
services::Status finalizeCompute() DAAL_C11_OVERRIDE
daal::algorithms::ridge_regression::training::interface1::Online::getResult
ResultPtr getResult()
Definition: ridge_regression_training_online.h:145
daal::algorithms::ridge_regression::training::interface1::Online::parameter
ParameterType parameter
Definition: ridge_regression_training_online.h:106
daal::algorithms::ridge_regression::training::interface1::Online::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: ridge_regression_training_online.h:133
daal::algorithms::ridge_regression::training::interface1::OnlineContainer
Class containing methods for ridge regression model-based training in the online processing mode...
Definition: ridge_regression_training_online.h:51
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:52

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