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

objective_function_types.h
1 /* file: objective_function_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the Objective function interface.
45 //--
46 */
47 
48 #ifndef __OBJECTIVE_FUNCTION_TYPES_H__
49 #define __OBJECTIVE_FUNCTION_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "data_management/data/homogen_numeric_table.h"
54 #include "services/daal_defines.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
63 namespace optimization_solver
64 {
74 namespace objective_function
75 {
76 
81 enum InputId
82 {
83  argument,
84  lastInputId = argument
85 };
86 
91 enum ResultToComputeId
92 {
93  gradient = 0x00000001ULL,
94  value = 0x00000002ULL,
95  hessian = 0x00000004ULL
96 };
97 
102 enum ResultId
103 {
104  gradientIdx,
105  valueIdx,
106  hessianIdx,
107  lastResultId = hessianIdx
108 };
109 
113 namespace interface1
114 {
121 /* [Parameter source code] */
122 struct DAAL_EXPORT Parameter : public daal::algorithms::Parameter
123 {
128  Parameter(const DAAL_UINT64 resultsToCompute = gradient);
129 
134  Parameter(const Parameter &other);
135 
136  virtual ~Parameter() {}
137 
138  DAAL_UINT64 resultsToCompute;
139 };
140 /* [Parameter source code] */
141 
146 class DAAL_EXPORT Input : public daal::algorithms::Input
147 {
148 public:
150  Input(size_t n = 1);
151 
153  Input(const Input& other);
154 
156  virtual ~Input() {}
157 
163  void set(InputId id, const data_management::NumericTablePtr &ptr);
164 
170  data_management::NumericTablePtr get(InputId id) const;
171 
179  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
180 };
181 
186 class DAAL_EXPORT Result: public daal::algorithms::Result
187 {
188 public:
189  DECLARE_SERIALIZABLE_CAST(Result);
191  Result();
192 
194  virtual ~Result() {};
195 
204  template <typename algorithmFPType>
205  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
206 
212  void set(ResultId id, const data_management::NumericTablePtr &ptr);
213 
219  data_management::NumericTablePtr get(ResultId id) const;
220 
229  virtual services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
230 
231 protected:
232 
233  template<typename Archive, bool onDeserialize>
234  services::Status serialImpl(Archive *arch)
235  {
236  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
237  }
238 };
239 typedef services::SharedPtr<Result> ResultPtr;
241 } // namespace interface1
242 using interface1::Parameter;
243 using interface1::Input;
244 using interface1::Result;
245 using interface1::ResultPtr;
246 
247 } // namespace objective_function
248 } // namespace optimization_solver
249 } // namespace algorithm
250 } // namespace daal
251 #endif
daal::algorithms::optimization_solver::objective_function::argument
Definition: objective_function_types.h:83
daal::algorithms::optimization_solver::objective_function::value
Definition: objective_function_types.h:94
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::algorithms::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:331
daal::algorithms::optimization_solver::objective_function::interface1::Result
Provides methods to access final results obtained with the compute() method of the Objective function...
Definition: objective_function_types.h:186
daal::algorithms::optimization_solver::objective_function::interface1::Result::~Result
virtual ~Result()
Definition: objective_function_types.h:194
daal_defines.h
daal::algorithms::optimization_solver::objective_function::gradientIdx
Definition: objective_function_types.h:104
daal::algorithms::optimization_solver::objective_function::ResultToComputeId
ResultToComputeId
Definition: objective_function_types.h:91
daal::algorithms::optimization_solver::objective_function::hessian
Definition: objective_function_types.h:95
daal::algorithms::optimization_solver::objective_function::interface1::Input
Input objects for the Objective function
Definition: objective_function_types.h:146
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
daal::algorithms::optimization_solver::objective_function::hessianIdx
Definition: objective_function_types.h:106
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::algorithms::optimization_solver::objective_function::valueIdx
Definition: objective_function_types.h:105
daal::algorithms::optimization_solver::objective_function::ResultId
ResultId
Definition: objective_function_types.h:102
daal::algorithms::optimization_solver::objective_function::gradient
Definition: objective_function_types.h:93
daal::algorithms::optimization_solver::objective_function::InputId
InputId
Definition: objective_function_types.h:81
daal::algorithms::optimization_solver::objective_function::interface1::Input::~Input
virtual ~Input()
Definition: objective_function_types.h:156
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::algorithms::optimization_solver::objective_function::interface1::Parameter
Parameter for the Objective function
Definition: objective_function_types.h:122

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