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

sum_of_functions_types.h
1 /* file: sum_of_functions_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 Sum of functions interface.
45 //--
46 */
47 
48 #ifndef __SUM_OF_FUNCTIONS_TYPES_H__
49 #define __SUM_OF_FUNCTIONS_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/numeric_table.h"
53 #include "services/daal_defines.h"
54 #include "objective_function_types.h"
55 
56 namespace daal
57 {
58 namespace algorithms
59 {
60 namespace optimization_solver
61 {
71 namespace sum_of_functions
72 {
73 
78 enum InputId
79 {
80  argument = (int)objective_function::argument,
81 };
82 
86 namespace interface1
87 {
94 /* [Parameter source code] */
95 struct DAAL_EXPORT Parameter : public objective_function::Parameter
96 {
106  Parameter(size_t numberOfTerms,
107  data_management::NumericTablePtr batchIndices = data_management::NumericTablePtr(),
108  const DAAL_UINT64 resultsToCompute = objective_function::gradient);
109 
114  Parameter(const Parameter &other);
115 
121  virtual services::Status check() const;
122 
123  virtual ~Parameter() {}
124 
125  size_t numberOfTerms;
126  data_management::NumericTablePtr batchIndices;
130 };
131 /* [Parameter source code] */
132 
137 class DAAL_EXPORT Input : public objective_function::Input
138 {
139 public:
141  Input(size_t n = 1);
142 
144  Input(const Input& other);
145 
147  virtual ~Input() {}
148 
154  void set(InputId id, const data_management::NumericTablePtr &ptr);
155 
161  data_management::NumericTablePtr get(InputId id) const;
162 
170  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
171 };
173 } // namespace interface1
174 using interface1::Parameter;
175 using interface1::Input;
176 
177 } // namespace sum_of_functions
178 } // namespace optimization_solver
179 } // namespace algorithm
180 } // namespace daal
181 #endif
daal::algorithms::optimization_solver::objective_function::argument
Definition: objective_function_types.h:83
daal::algorithms::optimization_solver::sum_of_functions::interface1::Input
Input objects for the Sum of functions
Definition: sum_of_functions_types.h:137
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::optimization_solver::sum_of_functions::interface1::Parameter::batchIndices
data_management::NumericTablePtr batchIndices
Definition: sum_of_functions_types.h:126
daal::algorithms::optimization_solver::sum_of_functions::interface1::Input::~Input
virtual ~Input()
Definition: sum_of_functions_types.h:147
daal_defines.h
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::sum_of_functions::interface1::Parameter
Parameter for the Sum of functions
Definition: sum_of_functions_types.h:95
daal::algorithms::optimization_solver::sum_of_functions::argument
Definition: sum_of_functions_types.h:80
daal::algorithms::optimization_solver::objective_function::gradient
Definition: objective_function_types.h:93
daal::algorithms::optimization_solver::sum_of_functions::interface1::Parameter::numberOfTerms
size_t numberOfTerms
Definition: sum_of_functions_types.h:125
daal::algorithms::optimization_solver::objective_function::interface1::Parameter
Parameter for the Objective function
Definition: objective_function_types.h:122
daal::algorithms::optimization_solver::sum_of_functions::InputId
InputId
Definition: sum_of_functions_types.h:78

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