C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 3

mse_types.h
1 /* file: mse_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 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 Mean squared error objective function interface.
19 //--
20 */
21 
22 #ifndef __MSE_TYPES_H__
23 #define __MSE_TYPES_H__
24 
25 #include "algorithms/algorithm.h"
26 #include "data_management/data/numeric_table.h"
27 #include "services/daal_defines.h"
28 #include "sum_of_functions_types.h"
29 
30 namespace daal
31 {
32 namespace algorithms
33 {
37 namespace optimization_solver
38 {
48 namespace mse
49 {
50 
55 enum InputId
56 {
57  argument = (int)sum_of_functions::argument,
58  data ,
59  dependentVariables,
60  lastInputId = dependentVariables
61 };
62 
67 enum Method
68 {
69  defaultDense = 0
70 };
71 
75 namespace interface1
76 {
77 
84 /* [Parameter source code] */
85 struct DAAL_EXPORT Parameter : public sum_of_functions::Parameter
86 {
96  Parameter(size_t numberOfTerms,
97  data_management::NumericTablePtr batchIndices = data_management::NumericTablePtr(),
98  const DAAL_UINT64 resultsToCompute = objective_function::gradient);
99 
104  Parameter(const Parameter &other);
110  virtual services::Status check() const;
111 
112  virtual ~Parameter() {}
113 };
114 /* [Parameter source code] */
115 
120 class DAAL_EXPORT Input : public sum_of_functions::Input
121 {
122 public:
124  Input();
125 
127  Input(const Input& other);
128 
130  virtual ~Input() {}
131 
137  void set(InputId id, const data_management::NumericTablePtr &ptr);
138 
144  data_management::NumericTablePtr get(InputId id) const;
145 
153  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
154 };
156 } // namespace interface1
157 using interface1::Parameter;
158 using interface1::Input;
159 
160 } // namespace mse
161 } // namespace optimization_solver
162 } // namespace algorithm
163 } // namespace daal
164 #endif
daal::algorithms::optimization_solver::mse::data
Definition: mse_types.h:58
daal
Definition: algorithm_base_common.h:31
daal::algorithms::optimization_solver::mse::argument
Definition: mse_types.h:57
daal_defines.h
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:60
daal::algorithms::optimization_solver::mse::defaultDense
Definition: mse_types.h:69
daal::algorithms::optimization_solver::sum_of_functions::argument
Definition: sum_of_functions_types.h:54
daal::algorithms::optimization_solver::mse::interface1::Input
Input objects for the Mean squared error objective function
Definition: mse_types.h:120
daal::algorithms::optimization_solver::mse::interface1::Parameter
Parameter for Mean squared error objective function
Definition: mse_types.h:85
daal::algorithms::optimization_solver::objective_function::gradient
Definition: objective_function_types.h:67
daal::algorithms::optimization_solver::mse::dependentVariables
Definition: mse_types.h:59
daal::algorithms::optimization_solver::mse::Method
Method
Definition: mse_types.h:67
daal::algorithms::optimization_solver::mse::InputId
InputId
Definition: mse_types.h:55
daal::algorithms::optimization_solver::mse::interface1::Input::~Input
virtual ~Input()
Definition: mse_types.h:130
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:191

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