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

cross_entropy_loss_types.h
1 /* file: cross_entropy_loss_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 cross-entropy loss objective function
19 //--
20 */
21 
22 #ifndef __CROSS_ENTROPY_LOSS_TYPES_H__
23 #define __CROSS_ENTROPY_LOSS_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 cross_entropy_loss
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 /* [interface1::Parameter source code] */
85 struct DAAL_EXPORT Parameter : public sum_of_functions::interface1::Parameter
86 {
97  Parameter(size_t nClasses, size_t numberOfTerms,
98  data_management::NumericTablePtr batchIndices = data_management::NumericTablePtr(),
99  const DAAL_UINT64 resultsToCompute = objective_function::gradient);
100 
105  Parameter(const Parameter &other);
111  virtual services::Status check() const;
112 
113  virtual ~Parameter() {}
114 
115  bool interceptFlag;
116  float penaltyL1;
117  float penaltyL2;
118  size_t nClasses;
119 };
120 /* [interface1::Parameter source code] */
121 
126 class DAAL_EXPORT Input : public sum_of_functions::interface1::Input
127 {
128 public:
130  Input();
131 
133  Input(const Input& other);
134 
136  virtual ~Input() {}
137 
143  void set(InputId id, const data_management::NumericTablePtr &ptr);
144 
150  data_management::NumericTablePtr get(InputId id) const;
151 
159  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
160 };
162 } // namespace interface1
163 
167 namespace interface2
168 {
169 
176 /* [Parameter source code] */
177 struct DAAL_EXPORT Parameter : public sum_of_functions::Parameter
178 {
189  Parameter(size_t nClasses, size_t numberOfTerms,
190  data_management::NumericTablePtr batchIndices = data_management::NumericTablePtr(),
191  const DAAL_UINT64 resultsToCompute = objective_function::gradient);
192 
197  Parameter(const Parameter &other);
203  virtual services::Status check() const;
204 
205  virtual ~Parameter() {}
206 
207  bool interceptFlag;
208  float penaltyL1;
209  float penaltyL2;
210  size_t nClasses;
211 };
212 
217 class DAAL_EXPORT Input : public sum_of_functions::Input
218 {
219 public:
221  Input();
222 
224  Input(const Input& other);
225 
227  virtual ~Input() {}
228 
234  void set(InputId id, const data_management::NumericTablePtr &ptr);
235 
241  data_management::NumericTablePtr get(InputId id) const;
242 
250  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
251 };
252 /* [Parameter source code] */
253 }// namespace interface2
254 using interface2::Parameter;
255 using interface2::Input;
256 
257 } // namespace cross_entropy_loss
258 } // namespace optimization_solver
259 } // namespace algorithm
260 } // namespace daal
261 #endif
daal::algorithms::optimization_solver::sum_of_functions::interface1::Input
Input objects for the Sum of functions
Definition: sum_of_functions_types.h:111
daal::algorithms::optimization_solver::cross_entropy_loss::data
Definition: cross_entropy_loss_types.h:58
daal::algorithms::optimization_solver::cross_entropy_loss::interface1::Parameter
Parameter for Cross-entropy loss objective function
Definition: cross_entropy_loss_types.h:85
daal
Definition: algorithm_base_common.h:31
daal::algorithms::optimization_solver::cross_entropy_loss::interface2::Input::~Input
virtual ~Input()
Definition: cross_entropy_loss_types.h:227
daal::algorithms::optimization_solver::cross_entropy_loss::interface2::Parameter::nClasses
size_t nClasses
Definition: cross_entropy_loss_types.h:210
daal::algorithms::optimization_solver::cross_entropy_loss::interface1::Input
Input objects for the Cross-entropy loss objective function
Definition: cross_entropy_loss_types.h:126
daal::algorithms::optimization_solver::cross_entropy_loss::interface2::Input
Input objects for the Cross-entropy loss objective function
Definition: cross_entropy_loss_types.h:217
daal::algorithms::optimization_solver::cross_entropy_loss::interface2::Parameter
Parameter for Cross-entropy loss objective function
Definition: cross_entropy_loss_types.h:177
daal::algorithms::optimization_solver::cross_entropy_loss::dependentVariables
Definition: cross_entropy_loss_types.h:59
daal_defines.h
daal::algorithms::optimization_solver::cross_entropy_loss::interface2::Parameter::penaltyL2
float penaltyL2
Definition: cross_entropy_loss_types.h:209
daal::algorithms::optimization_solver::cross_entropy_loss::interface2::Parameter::penaltyL1
float penaltyL1
Definition: cross_entropy_loss_types.h:208
daal::algorithms::optimization_solver::sum_of_functions::interface1::Parameter
Parameter for the Sum of functions
Definition: sum_of_functions_types.h:69
daal::algorithms::optimization_solver::cross_entropy_loss::Method
Method
Definition: cross_entropy_loss_types.h:67
daal::algorithms::optimization_solver::cross_entropy_loss::interface2::Parameter::interceptFlag
bool interceptFlag
Definition: cross_entropy_loss_types.h:207
daal::algorithms::optimization_solver::sum_of_functions::argument
Definition: sum_of_functions_types.h:54
daal::algorithms::optimization_solver::cross_entropy_loss::interface1::Parameter::penaltyL2
float penaltyL2
Definition: cross_entropy_loss_types.h:117
daal::algorithms::optimization_solver::cross_entropy_loss::interface1::Parameter::penaltyL1
float penaltyL1
Definition: cross_entropy_loss_types.h:116
daal::algorithms::optimization_solver::cross_entropy_loss::interface1::Input::~Input
virtual ~Input()
Definition: cross_entropy_loss_types.h:136
daal::algorithms::optimization_solver::cross_entropy_loss::defaultDense
Definition: cross_entropy_loss_types.h:69
daal::algorithms::optimization_solver::objective_function::gradient
Definition: objective_function_types.h:67
daal::algorithms::optimization_solver::cross_entropy_loss::interface1::Parameter::nClasses
size_t nClasses
Definition: cross_entropy_loss_types.h:118
daal::algorithms::optimization_solver::cross_entropy_loss::argument
Definition: cross_entropy_loss_types.h:57
daal::algorithms::optimization_solver::cross_entropy_loss::interface1::Parameter::interceptFlag
bool interceptFlag
Definition: cross_entropy_loss_types.h:115
daal::algorithms::optimization_solver::cross_entropy_loss::InputId
InputId
Definition: cross_entropy_loss_types.h:55

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