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

elastic_net_training_types.h
1 /* file: elastic_net_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 elastic net algorithm interface
21 //--
22 */
23 
24 #ifndef __ELASTIC_NET_TRAINING_TYPES_H__
25 #define __ELASTIC_NET_TRAINING_TYPES_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "algorithms/elastic_net/elastic_net_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 elastic_net
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 
127 enum DataUseInComputation
128 {
129  doNotUse = 0,
130  doUse = 1
131 };
135 namespace interface1
136 {
142 /* [Parameter source code] */
143 struct DAAL_EXPORT Parameter : public linear_model::Parameter
144 {
145  typedef optimization_solver::iterative_solver::BatchPtr SolverPtr;
146 
147  Parameter(const SolverPtr & solver = SolverPtr());
148  Parameter(const Parameter & o)
149  : linear_model::Parameter(o),
150  penaltyL1(o.penaltyL1),
151  penaltyL2(o.penaltyL2),
152  optimizationSolver(o.optimizationSolver),
153  dataUseInComputation(o.dataUseInComputation),
154  optResultToCompute(o.optResultToCompute)
155  {}
156 
157  services::Status check() const DAAL_C11_OVERRIDE;
158 
159  data_management::NumericTablePtr penaltyL1;
160  data_management::NumericTablePtr penaltyL2;
162  SolverPtr optimizationSolver;
164  DataUseInComputation dataUseInComputation;
165  DAAL_UINT64 optResultToCompute;
166 };
167 /* [Parameter source code] */
168 
173 class InputIface
174 {
175 public:
180  virtual size_t getNumberOfFeatures() const = 0;
181 
186  virtual size_t getNumberOfDependentVariables() const = 0;
187 
188  virtual ~InputIface() {}
189 };
190 
195 class DAAL_EXPORT Input : public linear_model::training::Input, public InputIface
196 {
197 public:
199  Input();
200  Input(const Input & other);
201 
202  virtual ~Input() {}
203 
209  data_management::NumericTablePtr get(InputId id) const;
210 
216  void set(InputId id, const data_management::NumericTablePtr & value);
217 
223  algorithms::OptionalArgumentPtr get(OptionalInputId id) const;
224 
230  void set(OptionalInputId id, const algorithms::OptionalArgumentPtr & ptr);
231 
237  data_management::NumericTablePtr get(OptionalDataId id) const;
238 
244  void set(OptionalDataId id, const data_management::NumericTablePtr & ptr);
245 
250  size_t getNumberOfFeatures() const DAAL_C11_OVERRIDE;
251 
256  size_t getNumberOfDependentVariables() const DAAL_C11_OVERRIDE;
257 
265  services::Status check(const daal::algorithms::Parameter * par, int method) const DAAL_C11_OVERRIDE;
266 };
267 
273 class DAAL_EXPORT Result : public linear_model::training::Result
274 {
275 public:
276  DECLARE_SERIALIZABLE_CAST(Result);
277  Result();
278 
284  elastic_net::ModelPtr get(ResultId id) const;
285 
291  void set(ResultId id, const elastic_net::ModelPtr & value);
292 
298  data_management::NumericTablePtr get(OptionalResultNumericTableId id) const;
299 
305  void set(OptionalResultNumericTableId id, const data_management::NumericTablePtr & value);
306 
315  template <typename algorithmFPType>
316  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input * input, const Parameter * parameter, const int method);
317 
326  services::Status check(const daal::algorithms::Input * input, const daal::algorithms::Parameter * par, int method) const DAAL_C11_OVERRIDE;
327 
328 protected:
330  template <typename Archive, bool onDeserialize>
331  services::Status serialImpl(Archive * arch)
332  {
333  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
334  }
335 };
336 typedef services::SharedPtr<Result> ResultPtr;
337 typedef services::SharedPtr<const Result> ResultConstPtr;
338 } // namespace interface1
339 
340 using interface1::InputIface;
341 using interface1::Input;
342 using interface1::Parameter;
343 
344 using interface1::Result;
345 using interface1::ResultPtr;
346 using interface1::ResultConstPtr;
347 
348 } // namespace training
349 } // namespace elastic_net
351 } // namespace algorithms
352 } // namespace daal
353 
354 #endif
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::elastic_net::training::interface1::Parameter
Parameters for the elastic net algorithm.
Definition: elastic_net_training_types.h:143
daal::algorithms::elastic_net::training::data
Definition: elastic_net_training_types.h:68
daal::algorithms::elastic_net::training::ResultToComputeId
ResultToComputeId
Definition: elastic_net_training_types.h:98
daal::algorithms::elastic_net::training::ResultId
ResultId
Available identifiers of the result of elastic net model-based training.
Definition: elastic_net_training_types.h:107
daal::algorithms::elastic_net::training::interface1::InputIface
Abstract class that specifies the interface of input objects for elastic net model-based training...
Definition: elastic_net_training_types.h:173
daal::algorithms::elastic_net::training::OptionalDataId
OptionalDataId
Definition: elastic_net_training_types.h:87
daal::algorithms::elastic_net::training::interface1::Parameter::optResultToCompute
DAAL_UINT64 optResultToCompute
Definition: elastic_net_training_types.h:165
daal::algorithms::elastic_net::training::dependentVariables
Definition: elastic_net_training_types.h:69
daal::algorithms::elastic_net::training::OptionalResultNumericTableId
OptionalResultNumericTableId
Definition: elastic_net_training_types.h:117
daal::algorithms::linear_model::training::model
Definition: linear_model_training_types.h:66
daal::algorithms::elastic_net::training::interface1::Parameter::penaltyL2
data_management::NumericTablePtr penaltyL2
Definition: elastic_net_training_types.h:160
daal::algorithms::elastic_net::training::gramMatrixId
Definition: elastic_net_training_types.h:119
daal::algorithms::elastic_net::training::OptionalInputId
OptionalInputId
Definition: elastic_net_training_types.h:77
daal::algorithms::elastic_net::training::model
Definition: elastic_net_training_types.h:109
daal::algorithms::elastic_net::training::weights
Definition: elastic_net_training_types.h:89
daal::algorithms::elastic_net::training::interface1::InputIface::getNumberOfDependentVariables
virtual size_t getNumberOfDependentVariables() const =0
daal::algorithms::elastic_net::training::interface1::Parameter::optimizationSolver
SolverPtr optimizationSolver
Definition: elastic_net_training_types.h:162
daal::algorithms::elastic_net::training::optionalArgument
Definition: elastic_net_training_types.h:79
daal::algorithms::elastic_net::training::doNotUse
Definition: elastic_net_training_types.h:129
daal::algorithms::elastic_net::training::defaultDense
Definition: elastic_net_training_types.h:59
daal::algorithms::elastic_net::training::InputId
InputId
Available identifiers of input objects for elastic net model-based training.
Definition: elastic_net_training_types.h:66
daal::algorithms::elastic_net::training::gramMatrix
Definition: elastic_net_training_types.h:90
daal::algorithms::elastic_net::training::computeGramMatrix
Definition: elastic_net_training_types.h:100
daal::algorithms::elastic_net::training::interface1::Input
Input objects for elastic net model-based training
Definition: elastic_net_training_types.h:195
daal::algorithms::elastic_net::training::interface1::Parameter::penaltyL1
data_management::NumericTablePtr penaltyL1
Definition: elastic_net_training_types.h:159
daal::algorithms::elastic_net::training::interface1::Result
Provides methods to access the result obtained with the compute() method of elastic net model-based t...
Definition: elastic_net_training_types.h:273
daal::algorithms::math::abs::value
Definition: abs_types.h:88
daal::algorithms::elastic_net::training::interface1::Parameter::dataUseInComputation
DataUseInComputation dataUseInComputation
Definition: elastic_net_training_types.h:164
daal::algorithms::elastic_net::training::doUse
Definition: elastic_net_training_types.h:130
daal::algorithms::elastic_net::training::Method
Method
Computation methods for elastic net model-based training.
Definition: elastic_net_training_types.h:57
daal::algorithms::elastic_net::training::interface1::InputIface::getNumberOfFeatures
virtual size_t getNumberOfFeatures() const =0
daal::algorithms::elastic_net::training::DataUseInComputation
DataUseInComputation
Available identifiers for input data corruption.
Definition: elastic_net_training_types.h:127

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