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

softmax.h
1 /* file: softmax.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Implementation of the interface for the softmax function
21 //--
22 */
23 
24 #ifndef __SOFTMAX_H__
25 #define __SOFTMAX_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "data_management/data/numeric_table.h"
29 #include "services/daal_defines.h"
30 #include "algorithms/math/softmax_types.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
36 namespace math
37 {
38 namespace softmax
39 {
40 namespace interface1
41 {
52 template<typename algorithmFPType, Method method, CpuType cpu>
53 class BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
54 {
55 public:
62  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
67  DAAL_DEPRECATED ~BatchContainer();
73  virtual services::Status compute() DAAL_C11_OVERRIDE;
74 };
75 
92 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
93 class DAAL_EXPORT Batch : public daal::algorithms::Analysis<batch>
94 {
95 public:
96  typedef algorithms::math::softmax::Input InputType;
97  typedef algorithms::math::softmax::Result ResultType;
98 
103  DAAL_DEPRECATED Batch()
104  {
105  initialize();
106  }
107 
113  Batch(const Batch<algorithmFPType, method> &other) : input(other.input)
114  {
115  initialize();
116  }
117 
122  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
123 
128  ResultPtr getResult()
129  {
130  return _result;
131  }
132 
139  services::Status setResult(const ResultPtr &result)
140  {
141  DAAL_CHECK(result, services::ErrorNullResult)
142  _result = result;
143  _res = _result.get();
144  return services::Status();
145  }
146 
147  InputType input;
154  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
155  {
156  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
157  }
158 
159 protected:
160  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
161  {
162  return new Batch<algorithmFPType, method>(*this);
163  }
164 
165  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
166  {
167  _result.reset(new ResultType());
168  services::Status s = _result->allocate<algorithmFPType>(&input, NULL, (int) method);
169  _res = _result.get();
170  return s;
171  }
172 
173  void initialize()
174  {
175  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
176  _in = &input;
177  }
178 private:
179  ResultPtr _result;
180 };
182 } // namespace interface1
183 using interface1::BatchContainer;
184 using interface1::Batch;
185 
186 } // namespace softmax
187 } // namespace math
188 } // namespace algorithms
189 } // namespace daal
190 #endif
daal::algorithms::math::softmax::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: softmax.h:122
daal::algorithms::math::softmax::interface1::Batch
Computes the softmax function in the batch processing mode.
Definition: softmax.h:93
daal::batch
Definition: daal_defines.h:112
daal::algorithms::math::softmax::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: softmax.h:139
daal::algorithms::math::softmax::interface1::Batch::getResult
ResultPtr getResult()
Definition: softmax.h:128
daal::algorithms::math::softmax::interface1::BatchContainer::compute
virtual services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::math::softmax::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::math::softmax::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: softmax.h:113
daal::algorithms::math::softmax::interface1::Batch::Batch
DAAL_DEPRECATED Batch()
Definition: softmax.h:103
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal::algorithms::math::softmax::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::math::softmax::interface1::Batch::input
InputType input
Definition: softmax.h:147
daal_defines.h
daal::algorithms::math::softmax::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: softmax.h:154
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::math::softmax::interface1::BatchContainer
Class containing methods for the softmax function computing using algorithmFPType precision arithmeti...
Definition: softmax.h:53

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