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

iterative_solver_types.h
1 /* file: iterative_solver_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 iterative solver algorithm types.
19 //--
20 */
21 
22 #ifndef __ITERATIVE_SOLVER_TYPES_H__
23 #define __ITERATIVE_SOLVER_TYPES_H__
24 
25 #include "algorithms/algorithm.h"
26 #include "data_management/data/numeric_table.h"
27 #include "data_management/data/homogen_numeric_table.h"
28 #include "services/daal_defines.h"
29 #include "algorithms/optimization_solver/objective_function/sum_of_functions_batch.h"
30 
31 namespace daal
32 {
33 namespace algorithms
34 {
35 namespace optimization_solver
36 {
46 namespace iterative_solver
47 {
48 
53 enum InputId
54 {
55  inputArgument,
56  lastInputId = inputArgument
57 };
58 
63 enum OptionalInputId
64 {
65  optionalArgument = lastInputId + 1,
66  lastOptionalInputId = optionalArgument
67 };
68 
73 enum ResultId
74 {
75  minimum,
76  nIterations,
77  lastResultId = nIterations
78 };
79 
84 enum OptionalResultId
85 {
86  optionalResult = lastResultId + 1,
87  lastOptionalResultId = optionalResult
88 };
89 
94 enum OptionalDataId
95 {
96  lastIteration,
97  lastOptionalData = lastIteration
98 };
99 
103 namespace interface1
104 {
105 
112 /* [interface1::Parameter source code] */
113 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
114 {
123  Parameter(const sum_of_functions::interface1::BatchPtr &function_, size_t nIterations_ = 100,
124  double accuracyThreshold_ = 1.0e-05, bool optionalResultReq_ = false, size_t batchSize_ = 1);
125 
130  Parameter(const Parameter &other);
131 
132  virtual ~Parameter() {}
133 
139  virtual services::Status check() const;
140 
141  sum_of_functions::interface1::BatchPtr function;
142  size_t nIterations;
143  double accuracyThreshold;
145  bool optionalResultRequired;
146  size_t batchSize;
151 };
152 /* [interface1::Parameter source code] */
153 
158 class DAAL_EXPORT Input : public daal::algorithms::Input
159 {
160 public:
161  Input();
162  Input(const Input& other);
163 
164  virtual ~Input() {}
165 
171  data_management::NumericTablePtr get(InputId id) const;
172 
178  algorithms::OptionalArgumentPtr get(OptionalInputId id) const;
179 
185  data_management::NumericTablePtr get(OptionalDataId id) const;
186 
192  void set(InputId id, const data_management::NumericTablePtr &ptr);
193 
199  void set(OptionalInputId id, const algorithms::OptionalArgumentPtr &ptr);
200 
206  void set(OptionalDataId id, const data_management::NumericTablePtr &ptr);
214  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
215 };
216 
221 class DAAL_EXPORT Result : public daal::algorithms::Result
222 {
223 public:
224  DECLARE_SERIALIZABLE_CAST(Result);
225  Result() : daal::algorithms::Result(lastOptionalResultId + 1)
226  {}
227 
228  virtual ~Result() {};
229 
238  template <typename algorithmFPType>
239  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method);
240 
246  data_management::NumericTablePtr get(ResultId id) const;
247 
253  algorithms::OptionalArgumentPtr get(OptionalResultId id) const;
254 
260  data_management::NumericTablePtr get(OptionalDataId id) const;
261 
267  void set(ResultId id, const data_management::NumericTablePtr &ptr);
268 
274  void set(OptionalResultId id, const algorithms::OptionalArgumentPtr &ptr);
275 
281  void set(OptionalDataId id, const data_management::NumericTablePtr &ptr);
282 
291  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par,
292  int method) const DAAL_C11_OVERRIDE;
293 
294 protected:
296  template<typename Archive, bool onDeserialize>
297  services::Status serialImpl(Archive *arch)
298  {
299  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
300  }
301 };
302 typedef services::SharedPtr<Result> ResultPtr;
303 
305 } // namespace interface1
306 
310 namespace interface2
311 {
312 
319 /* [Parameter source code] */
320 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
321 {
330  Parameter(const sum_of_functions::BatchPtr &function_, size_t nIterations_ = 100,
331  double accuracyThreshold_ = 1.0e-05, bool optionalResultReq_ = false, size_t batchSize_ = 1);
332 
337  Parameter(const Parameter &other);
338 
339  virtual ~Parameter() {}
340 
346  virtual services::Status check() const;
347 
348  sum_of_functions::BatchPtr function;
349  size_t nIterations;
350  double accuracyThreshold;
352  bool optionalResultRequired;
353  size_t batchSize;
358 };
359 /* [Parameter source code] */
360 
365 class DAAL_EXPORT Input : public daal::algorithms::Input
366 {
367 public:
368  Input();
369  Input(const Input& other);
370 
371  virtual ~Input() {}
372 
378  data_management::NumericTablePtr get(InputId id) const;
379 
385  algorithms::OptionalArgumentPtr get(OptionalInputId id) const;
386 
392  data_management::NumericTablePtr get(OptionalDataId id) const;
393 
399  void set(InputId id, const data_management::NumericTablePtr &ptr);
400 
406  void set(OptionalInputId id, const algorithms::OptionalArgumentPtr &ptr);
407 
413  void set(OptionalDataId id, const data_management::NumericTablePtr &ptr);
421  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
422 };
423 
428 class DAAL_EXPORT Result : public daal::algorithms::Result
429 {
430 public:
431  DECLARE_SERIALIZABLE_CAST(Result);
432  Result() : daal::algorithms::Result(lastOptionalResultId + 1)
433  {}
434 
435  virtual ~Result() {};
436 
445  template <typename algorithmFPType>
446  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method);
447 
453  data_management::NumericTablePtr get(ResultId id) const;
454 
460  algorithms::OptionalArgumentPtr get(OptionalResultId id) const;
461 
467  data_management::NumericTablePtr get(OptionalDataId id) const;
468 
474  void set(ResultId id, const data_management::NumericTablePtr &ptr);
475 
481  void set(OptionalResultId id, const algorithms::OptionalArgumentPtr &ptr);
482 
488  void set(OptionalDataId id, const data_management::NumericTablePtr &ptr);
489 
498  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par,
499  int method) const DAAL_C11_OVERRIDE;
500 
501 protected:
503  template<typename Archive, bool onDeserialize>
504  services::Status serialImpl(Archive *arch)
505  {
506  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
507  }
508 };
509 typedef services::SharedPtr<Result> ResultPtr;
510 
512 } // namespace interface2
513 using interface2::Parameter;
514 using interface2::Input;
515 using interface2::Result;
516 using interface2::ResultPtr;
517 
518 } // namespace iterative_solver
519 } // namespace optimization_solver
520 } // namespace algorithm
521 } // namespace daal
522 #endif
daal::algorithms::optimization_solver::iterative_solver::interface1::Parameter::optionalResultRequired
bool optionalResultRequired
Definition: iterative_solver_types.h:145
daal::algorithms::optimization_solver::iterative_solver::interface1::Parameter::nIterations
size_t nIterations
Definition: iterative_solver_types.h:142
daal
Definition: algorithm_base_common.h:31
daal::algorithms::optimization_solver::iterative_solver::interface1::Parameter::batchSize
size_t batchSize
Definition: iterative_solver_types.h:146
daal::algorithms::optimization_solver::iterative_solver::interface1::Result
Results obtained with the compute() method of the iterative solver algorithm in the batch processing ...
Definition: iterative_solver_types.h:221
daal::algorithms::optimization_solver::iterative_solver::interface2::Parameter::optionalResultRequired
bool optionalResultRequired
Definition: iterative_solver_types.h:352
daal::algorithms::optimization_solver::iterative_solver::InputId
InputId
Definition: iterative_solver_types.h:53
daal::algorithms::optimization_solver::iterative_solver::interface1::Parameter
Parameter base class for the iterative solver algorithm
Definition: iterative_solver_types.h:113
daal::algorithms::optimization_solver::iterative_solver::interface1::Input
Input parameters for the iterative solver algorithm
Definition: iterative_solver_types.h:158
daal::algorithms::optimization_solver::iterative_solver::interface2::Input
Input parameters for the iterative solver algorithm
Definition: iterative_solver_types.h:365
daal::algorithms::optimization_solver::iterative_solver::interface2::Parameter::nIterations
size_t nIterations
Definition: iterative_solver_types.h:349
daal_defines.h
daal::algorithms::optimization_solver::iterative_solver::OptionalDataId
OptionalDataId
Definition: iterative_solver_types.h:94
daal::algorithms::optimization_solver::iterative_solver::minimum
Definition: iterative_solver_types.h:75
daal::algorithms::optimization_solver::iterative_solver::interface1::Parameter::accuracyThreshold
double accuracyThreshold
Definition: iterative_solver_types.h:143
daal::algorithms::optimization_solver::iterative_solver::ResultId
ResultId
Definition: iterative_solver_types.h:73
daal::algorithms::optimization_solver::iterative_solver::OptionalResultId
OptionalResultId
Definition: iterative_solver_types.h:84
daal::algorithms::optimization_solver::iterative_solver::lastIteration
Definition: iterative_solver_types.h:96
daal::algorithms::optimization_solver::iterative_solver::optionalResult
Definition: iterative_solver_types.h:86
daal::algorithms::optimization_solver::iterative_solver::interface2::Parameter::batchSize
size_t batchSize
Definition: iterative_solver_types.h:353
daal::algorithms::optimization_solver::iterative_solver::interface2::Parameter
Parameter base class for the iterative solver algorithm
Definition: iterative_solver_types.h:320
daal::algorithms::optimization_solver::iterative_solver::OptionalInputId
OptionalInputId
Definition: iterative_solver_types.h:63
daal::algorithms::optimization_solver::iterative_solver::optionalArgument
Definition: iterative_solver_types.h:65
daal::algorithms::optimization_solver::iterative_solver::interface2::Parameter::accuracyThreshold
double accuracyThreshold
Definition: iterative_solver_types.h:350
daal::algorithms::optimization_solver::iterative_solver::interface2::Result
Results obtained with the compute() method of the iterative solver algorithm in the batch processing ...
Definition: iterative_solver_types.h:428
daal::algorithms::optimization_solver::iterative_solver::nIterations
Definition: iterative_solver_types.h:76
daal::algorithms::optimization_solver::iterative_solver::inputArgument
Definition: iterative_solver_types.h:55

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