C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 5

lasso_regression_training_types.h
1 /* file: lasso_regression_training_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Implementation of the lasso regression algorithm interface
19 //--
20 */
21 
22 #ifndef __LASSO_REGRESSION_TRAINING_TYPES_H__
23 #define __LASSO_REGRESSION_TRAINING_TYPES_H__
24 
25 #include "algorithms/algorithm.h"
26 #include "data_management/data/numeric_table.h"
27 #include "algorithms/lasso_regression/lasso_regression_model.h"
28 #include "algorithms/linear_model/linear_model_training_types.h"
29 #include "algorithms/optimization_solver/iterative_solver/iterative_solver_batch.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
38 namespace lasso_regression
39 {
49 namespace training
50 {
55 enum Method
56 {
57  defaultDense = 0,
58 };
59 
64 enum InputId
65 {
66  data = linear_model::training::data,
67  dependentVariables = linear_model::training::dependentVariables,
68  lastInputId = dependentVariables
69 };
70 
75 enum OptionalInputId
76 {
77  optionalArgument = lastInputId + 1,
78  lastOptionalInputId = optionalArgument
79 };
80 
85 enum OptionalDataId
86 {
87  weights,
88  gramMatrix,
89  lastOptionalData = gramMatrix
90 };
91 
96 enum ResultToComputeId
97 {
98  computeGramMatrix = 0x00000001ULL
99 };
100 
105 enum ResultId
106 {
107  model = linear_model::training::model,
108  lastResultId = model
109 };
110 
115 enum OptionalResultNumericTableId
116 {
117  gramMatrixId = lastResultId + 1,
118  lastResultNumericTableId = gramMatrixId
119 };
120 
121 
122 
127 enum DataUseInComputation
128 {
129  doNotUse = 0,
130  doUse = 1
131 };
135 namespace interface1
136 {
137 
143 /* [Parameter source code] */
144 struct DAAL_EXPORT Parameter : public linear_model::Parameter
145 {
146  typedef optimization_solver::iterative_solver::BatchPtr SolverPtr;
147 
148  Parameter(const SolverPtr& solver = SolverPtr());
149  Parameter(const Parameter& o): linear_model::Parameter(o),
150  lassoParameters(o.lassoParameters), optimizationSolver(o.optimizationSolver),
151  dataUseInComputation(o.dataUseInComputation), optResultToCompute(o.optResultToCompute){}
152 
153  services::Status check() const DAAL_C11_OVERRIDE;
154 
155  data_management::NumericTablePtr lassoParameters;
157  SolverPtr optimizationSolver;
159  DataUseInComputation dataUseInComputation;
160  DAAL_UINT64 optResultToCompute;
161 };
162 /* [Parameter source code] */
163 
168 class InputIface
169 {
170 public:
175  virtual size_t getNumberOfFeatures() const = 0;
176 
181  virtual size_t getNumberOfDependentVariables() const = 0;
182 
183  virtual ~InputIface() {}
184 };
185 
190 class DAAL_EXPORT Input : public linear_model::training::Input, public InputIface
191 {
192 public:
194  Input();
195  Input(const Input& other);
196 
197  virtual ~Input() {}
198 
204  data_management::NumericTablePtr get(InputId id) const;
205 
211  void set(InputId id, const data_management::NumericTablePtr &value);
212 
218  algorithms::OptionalArgumentPtr get(OptionalInputId id) const;
219 
225  void set(OptionalInputId id, const algorithms::OptionalArgumentPtr &ptr);
226 
232  data_management::NumericTablePtr get(OptionalDataId id) const;
233 
239  void set(OptionalDataId id, const data_management::NumericTablePtr &ptr);
240 
245  size_t getNumberOfFeatures() const DAAL_C11_OVERRIDE;
246 
251  size_t getNumberOfDependentVariables() const DAAL_C11_OVERRIDE;
252 
260  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
261 };
262 
268 class DAAL_EXPORT Result : public linear_model::training::Result
269 {
270 public:
271  DECLARE_SERIALIZABLE_CAST(Result);
272  Result();
273 
279  lasso_regression::ModelPtr get(ResultId id) const;
280 
286  void set(ResultId id, const lasso_regression::ModelPtr &value);
287 
288 
294  data_management::NumericTablePtr get(OptionalResultNumericTableId id) const;
295 
301  void set(OptionalResultNumericTableId id, const data_management::NumericTablePtr &value);
302 
311  template<typename algorithmFPType>
312  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const Parameter *parameter, const int method);
313 
322  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
323 
324 protected:
326  template<typename Archive, bool onDeserialize>
327  services::Status serialImpl(Archive *arch)
328  {
329  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
330  }
331 };
332 typedef services::SharedPtr<Result> ResultPtr;
333 typedef services::SharedPtr<const Result> ResultConstPtr;
334 } // namespace interface1
335 
336 using interface1::InputIface;
337 using interface1::Input;
338 using interface1::Parameter;
339 
340 using interface1::Result;
341 using interface1::ResultPtr;
342 using interface1::ResultConstPtr;
343 
344 } // namespace training
345 } // namespace lasso_regression
347 } // namespace algorithms
348 } // namespace daal
349 
350 #endif
daal::algorithms::lasso_regression::training::dependentVariables
Definition: lasso_regression_training_types.h:67
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:168
daal::algorithms::lasso_regression::training::gramMatrix
Definition: lasso_regression_training_types.h:88
daal::algorithms::lasso_regression::training::optionalArgument
Definition: lasso_regression_training_types.h:77
daal::algorithms::lasso_regression::training::interface1::Input
Input objects for lasso regression model-based training
Definition: lasso_regression_training_types.h:190
daal
Definition: algorithm_base_common.h:31
daal::algorithms::lasso_regression::training::interface1::Parameter
Parameters for the lasso regression algorithm.
Definition: lasso_regression_training_types.h:144
daal::algorithms::lasso_regression::training::ResultId
ResultId
Available identifiers of the result of lasso regression model-based training.
Definition: lasso_regression_training_types.h:105
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:268
daal::algorithms::lasso_regression::training::interface1::Parameter::optimizationSolver
SolverPtr optimizationSolver
Definition: lasso_regression_training_types.h:157
daal::algorithms::lasso_regression::training::doUse
Definition: lasso_regression_training_types.h:130
daal::algorithms::lasso_regression::training::OptionalDataId
OptionalDataId
Definition: lasso_regression_training_types.h:85
daal::algorithms::lasso_regression::training::DataUseInComputation
DataUseInComputation
Available identifiers for input data corruption.
Definition: lasso_regression_training_types.h:127
daal::algorithms::lasso_regression::training::weights
Definition: lasso_regression_training_types.h:87
daal::algorithms::lasso_regression::training::OptionalInputId
OptionalInputId
Definition: lasso_regression_training_types.h:75
daal::algorithms::lasso_regression::training::interface1::InputIface::getNumberOfFeatures
virtual size_t getNumberOfFeatures() const =0
daal::algorithms::lasso_regression::training::interface1::Parameter::dataUseInComputation
DataUseInComputation dataUseInComputation
Definition: lasso_regression_training_types.h:159
daal::algorithms::lasso_regression::training::InputId
InputId
Available identifiers of input objects for lasso regression model-based training. ...
Definition: lasso_regression_training_types.h:64
daal::algorithms::lasso_regression::training::interface1::Parameter::optResultToCompute
DAAL_UINT64 optResultToCompute
Definition: lasso_regression_training_types.h:160
daal::algorithms::linear_model::training::dependentVariables
Definition: linear_model_training_types.h:54
daal::algorithms::lasso_regression::training::gramMatrixId
Definition: lasso_regression_training_types.h:117
daal::algorithms::lasso_regression::training::OptionalResultNumericTableId
OptionalResultNumericTableId
Definition: lasso_regression_training_types.h:115
daal::algorithms::linear_model::training::model
Definition: linear_model_training_types.h:64
daal::algorithms::lasso_regression::training::Method
Method
Computation methods for lasso regression model-based training.
Definition: lasso_regression_training_types.h:55
daal::algorithms::linear_model::training::data
Definition: linear_model_training_types.h:53
daal::algorithms::lasso_regression::training::data
Definition: lasso_regression_training_types.h:66
daal::algorithms::lasso_regression::training::doNotUse
Definition: lasso_regression_training_types.h:129
daal::algorithms::math::abs::value
Definition: abs_types.h:86
daal::algorithms::lasso_regression::training::computeGramMatrix
Definition: lasso_regression_training_types.h:98
daal::algorithms::lasso_regression::training::ResultToComputeId
ResultToComputeId
Definition: lasso_regression_training_types.h:96
daal::algorithms::lasso_regression::training::interface1::InputIface::getNumberOfDependentVariables
virtual size_t getNumberOfDependentVariables() const =0
daal::algorithms::lasso_regression::training::interface1::Parameter::lassoParameters
data_management::NumericTablePtr lassoParameters
Definition: lasso_regression_training_types.h:155
daal::algorithms::lasso_regression::training::defaultDense
Definition: lasso_regression_training_types.h:57
daal::algorithms::lasso_regression::training::model
Definition: lasso_regression_training_types.h:107

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