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

softmax_types.h
1 /* file: softmax_types.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 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 softmax function interface.
45 //--
46 */
47 
48 #ifndef __SOFTMAX_TYPES_H__
49 #define __SOFTMAX_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 math
64 {
74 namespace softmax
75 {
80 enum Method
81 {
82  defaultDense = 0
83 };
84 
89 enum InputId
90 {
91  data,
92  lastInputId = data
93 };
94 
99 enum ResultId
100 {
101  value,
102  lastResultId = value
103 };
104 
108 namespace interface1
109 {
114 class DAAL_EXPORT Input : public daal::algorithms::Input
115 {
116 public:
118  Input();
119 
121  Input(const Input& other) : daal::algorithms::Input(other){}
122 
123  virtual ~Input() {}
124 
130  data_management::NumericTablePtr get(InputId id) const;
131 
137  void set(InputId id, const data_management::NumericTablePtr &ptr);
138 
146  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
147 };
148 
153 class DAAL_EXPORT Result : public daal::algorithms::Result
154 {
155 public:
156  DECLARE_SERIALIZABLE_CAST(Result);
158  Result();
159 
160  virtual ~Result() {};
161 
170  template <typename algorithmFPType>
171  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method);
172 
178  data_management::NumericTablePtr get(ResultId id) const;
179 
185  void set(ResultId id, const data_management::NumericTablePtr &ptr);
186 
195  services::Status check(const daal::algorithms::Input *in, const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
196 
197 protected:
199  template<typename Archive, bool onDeserialize>
200  services::Status serialImpl(Archive *arch)
201  {
202  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
203  }
204 };
205 typedef services::SharedPtr<Result> ResultPtr;
206 
208 } // namespace interface1
209 using interface1::Input;
210 using interface1::Result;
211 using interface1::ResultPtr;
212 
213 } // namespace softmax
214 } // namespace math
215 } // namespace algorithm
216 } // namespace daal
217 #endif
daal::algorithms::math::softmax::Method
Method
Definition: softmax_types.h:80
daal
Definition: algorithm_base_common.h:57
daal::algorithms::math::softmax::interface1::Input
Input objects for the softmax function
Definition: softmax_types.h:114
daal::algorithms::math::softmax::ResultId
ResultId
Definition: softmax_types.h:99
daal::algorithms::math::softmax::interface1::Input::Input
Input(const Input &other)
Definition: softmax_types.h:121
daal_defines.h
daal::algorithms::math::softmax::InputId
InputId
Definition: softmax_types.h:89
daal::algorithms::math::softmax::data
Definition: softmax_types.h:91
daal::algorithms::math::softmax::interface1::Result
Results obtained with the compute() method of the softmax function in the batch processing mode...
Definition: softmax_types.h:153
daal::algorithms::math::softmax::defaultDense
Definition: softmax_types.h:82
daal::algorithms::math::softmax::value
Definition: softmax_types.h:101

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