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

lasso_regression_training_types.h
1 /* file: lasso_regression_training_types.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 lasso regression algorithm interface
21 //--
22 */
23 
24 #ifndef __LASSO_REGRESSION_TRAINING_TYPES_H__
25 #define __LASSO_REGRESSION_TRAINING_TYPES_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "algorithms/lasso_regression/lasso_regression_model.h"
30 #include "algorithms/linear_model/linear_model_training_types.h"
31 #include "algorithms/optimization_solver/iterative_solver/iterative_solver_batch.h"
32 
33 namespace daal
34 {
35 namespace algorithms
36 {
40 namespace lasso_regression
41 {
51 namespace training
52 {
57 enum Method
58 {
59  defaultDense = 0,
60 };
61 
66 enum InputId
67 {
68  data = linear_model::training::data,
69  dependentVariables = linear_model::training::dependentVariables,
70  lastInputId = dependentVariables
71 };
72 
77 enum OptionalInputId
78 {
79  optionalArgument = lastInputId + 1,
80  lastOptionalInputId = optionalArgument
81 };
82 
87 enum OptionalDataId
88 {
89  weights,
90  gramMatrix,
91  lastOptionalData = gramMatrix
92 };
93 
98 enum ResultToComputeId
99 {
100  computeGramMatrix = 0x00000001ULL
101 };
102 
107 enum ResultId
108 {
109  model = linear_model::training::model,
110  lastResultId = model
111 };
112 
117 enum OptionalResultNumericTableId
118 {
119  gramMatrixId = lastResultId + 1,
120  lastResultNumericTableId = gramMatrixId
121 };
122 
123 
124 
129 enum DataUseInComputation
130 {
131  doNotUse = 0,
132  doUse = 1
133 };
137 namespace interface1
138 {
139 
145 /* [Parameter source code] */
146 struct DAAL_EXPORT Parameter : public linear_model::Parameter
147 {
148  typedef optimization_solver::iterative_solver::BatchPtr SolverPtr;
149 
150  Parameter(const SolverPtr& solver = SolverPtr());
151  Parameter(const Parameter& o): linear_model::Parameter(o),
152  lassoParameters(o.lassoParameters), optimizationSolver(o.optimizationSolver),
153  dataUseInComputation(o.dataUseInComputation), optResultToCompute(o.optResultToCompute){}
154 
155  services::Status check() const DAAL_C11_OVERRIDE;
156 
157  data_management::NumericTablePtr lassoParameters;
159  SolverPtr optimizationSolver;
161  DataUseInComputation dataUseInComputation;
162  DAAL_UINT64 optResultToCompute;
163 };
164 /* [Parameter source code] */
165 
170 class InputIface
171 {
172 public:
177  virtual size_t getNumberOfFeatures() const = 0;
178 
183  virtual size_t getNumberOfDependentVariables() const = 0;
184 
185  virtual ~InputIface() {}
186 };
187 
192 class DAAL_EXPORT Input : public linear_model::training::Input, public InputIface
193 {
194 public:
196  Input();
197  Input(const Input& other);
198 
199  virtual ~Input() {}
200 
206  data_management::NumericTablePtr get(InputId id) const;
207 
213  void set(InputId id, const data_management::NumericTablePtr &value);
214 
220  algorithms::OptionalArgumentPtr get(OptionalInputId id) const;
221 
227  void set(OptionalInputId id, const algorithms::OptionalArgumentPtr &ptr);
228 
234  data_management::NumericTablePtr get(OptionalDataId id) const;
235 
241  void set(OptionalDataId id, const data_management::NumericTablePtr &ptr);
242 
247  size_t getNumberOfFeatures() const DAAL_C11_OVERRIDE;
248 
253  size_t getNumberOfDependentVariables() const DAAL_C11_OVERRIDE;
254 
262  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
263 };
264 
270 class DAAL_EXPORT Result : public linear_model::training::Result
271 {
272 public:
273  DECLARE_SERIALIZABLE_CAST(Result);
274  Result();
275 
281  lasso_regression::ModelPtr get(ResultId id) const;
282 
288  void set(ResultId id, const lasso_regression::ModelPtr &value);
289 
290 
296  data_management::NumericTablePtr get(OptionalResultNumericTableId id) const;
297 
303  void set(OptionalResultNumericTableId id, const data_management::NumericTablePtr &value);
304 
313  template<typename algorithmFPType>
314  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const Parameter *parameter, const int method);
315 
324  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
325 
326 protected:
328  template<typename Archive, bool onDeserialize>
329  services::Status serialImpl(Archive *arch)
330  {
331  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
332  }
333 };
334 typedef services::SharedPtr<Result> ResultPtr;
335 typedef services::SharedPtr<const Result> ResultConstPtr;
336 } // namespace interface1
337 
338 using interface1::InputIface;
339 using interface1::Input;
340 using interface1::Parameter;
341 
342 using interface1::Result;
343 using interface1::ResultPtr;
344 using interface1::ResultConstPtr;
345 
346 } // namespace training
347 } // namespace lasso_regression
349 } // namespace algorithms
350 } // namespace daal
351 
352 #endif
daal::algorithms::lasso_regression::training::interface1::Input
Input objects for lasso regression model-based training
Definition: lasso_regression_training_types.h:192
daal::algorithms::linear_model::training::dependentVariables
Definition: linear_model_training_types.h:56
daal::algorithms::linear_model::training::data
Definition: linear_model_training_types.h:55
daal::algorithms::lasso_regression::training::ResultToComputeId
ResultToComputeId
Definition: lasso_regression_training_types.h:98
daal::algorithms::lasso_regression::training::interface1::InputIface::getNumberOfDependentVariables
virtual size_t getNumberOfDependentVariables() const =0
daal::algorithms::lasso_regression::training::gramMatrixId
Definition: lasso_regression_training_types.h:119
daal::algorithms::lasso_regression::training::dependentVariables
Definition: lasso_regression_training_types.h:69
daal::algorithms::lasso_regression::training::weights
Definition: lasso_regression_training_types.h:89
daal::algorithms::linear_model::training::model
Definition: linear_model_training_types.h:66
daal::algorithms::lasso_regression::training::interface1::Parameter::optResultToCompute
DAAL_UINT64 optResultToCompute
Definition: lasso_regression_training_types.h:162
daal::algorithms::lasso_regression::training::interface1::Parameter::dataUseInComputation
DataUseInComputation dataUseInComputation
Definition: lasso_regression_training_types.h:161
daal::algorithms::lasso_regression::training::InputId
InputId
Available identifiers of input objects for lasso regression model-based training. ...
Definition: lasso_regression_training_types.h:66
daal::algorithms::lasso_regression::training::data
Definition: lasso_regression_training_types.h:68
daal::algorithms::lasso_regression::training::OptionalInputId
OptionalInputId
Definition: lasso_regression_training_types.h:77
daal::algorithms::lasso_regression::training::optionalArgument
Definition: lasso_regression_training_types.h:79
daal::algorithms::lasso_regression::training::interface1::Parameter::lassoParameters
data_management::NumericTablePtr lassoParameters
Definition: lasso_regression_training_types.h:157
daal::algorithms::lasso_regression::training::model
Definition: lasso_regression_training_types.h:109
daal::algorithms::lasso_regression::training::defaultDense
Definition: lasso_regression_training_types.h:59
daal::algorithms::lasso_regression::training::OptionalResultNumericTableId
OptionalResultNumericTableId
Definition: lasso_regression_training_types.h:117
daal::algorithms::lasso_regression::training::interface1::Result
Provides methods to access the result obtained with the compute() method of lasso regression model-ba...
Definition: lasso_regression_training_types.h:270
daal::algorithms::lasso_regression::training::DataUseInComputation
DataUseInComputation
Available identifiers for input data corruption.
Definition: lasso_regression_training_types.h:129
daal::algorithms::lasso_regression::training::ResultId
ResultId
Available identifiers of the result of lasso regression model-based training.
Definition: lasso_regression_training_types.h:107
daal::algorithms::lasso_regression::training::doUse
Definition: lasso_regression_training_types.h:132
daal::algorithms::lasso_regression::training::OptionalDataId
OptionalDataId
Definition: lasso_regression_training_types.h:87
daal::algorithms::lasso_regression::training::interface1::Parameter
Parameters for the lasso regression algorithm.
Definition: lasso_regression_training_types.h:146
daal::algorithms::lasso_regression::training::computeGramMatrix
Definition: lasso_regression_training_types.h:100
daal::algorithms::lasso_regression::training::Method
Method
Computation methods for lasso regression model-based training.
Definition: lasso_regression_training_types.h:57
daal::algorithms::math::abs::value
Definition: abs_types.h:88
daal::algorithms::lasso_regression::training::gramMatrix
Definition: lasso_regression_training_types.h:90
daal::algorithms::lasso_regression::training::interface1::Parameter::optimizationSolver
SolverPtr optimizationSolver
Definition: lasso_regression_training_types.h:159
daal::algorithms::lasso_regression::training::interface1::InputIface
Abstract class that specifies the interface of input objects for lasso regression model-based trainin...
Definition: lasso_regression_training_types.h:170
daal::algorithms::lasso_regression::training::doNotUse
Definition: lasso_regression_training_types.h:131
daal::algorithms::lasso_regression::training::interface1::InputIface::getNumberOfFeatures
virtual size_t getNumberOfFeatures() const =0

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