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

softmax_layer_forward.h
1 /* file: softmax_layer_forward.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 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 the interface for the forward softmax layer in the batch
19 // processing mode
20 //--
21 */
22 
23 #ifndef __SOFTMAX_LAYER_FORWARD_H__
24 #define __SOFTMAX_LAYER_FORWARD_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "data_management/data/tensor.h"
28 #include "services/daal_defines.h"
29 #include "algorithms/neural_networks/layers/layer.h"
30 #include "algorithms/neural_networks/layers/softmax/softmax_layer_types.h"
31 #include "algorithms/neural_networks/layers/softmax/softmax_layer_forward_types.h"
32 
33 namespace daal
34 {
35 namespace algorithms
36 {
37 namespace neural_networks
38 {
39 namespace layers
40 {
41 namespace softmax
42 {
43 namespace forward
44 {
45 namespace interface1
46 {
56 template<typename algorithmFPType, Method method, CpuType cpu>
57 class DAAL_EXPORT BatchContainer : public layers::forward::LayerContainerIfaceImpl
58 {
59 public:
65  BatchContainer(daal::services::Environment::env *daalEnv);
67  ~BatchContainer();
73  services::Status compute() DAAL_C11_OVERRIDE;
74 };
75 
92 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
93 class Batch : public layers::forward::LayerIfaceImpl
94 {
95 public:
96  typedef layers::forward::LayerIfaceImpl super;
97 
98  typedef algorithms::neural_networks::layers::softmax::forward::Input InputType;
99  typedef algorithms::neural_networks::layers::softmax::Parameter ParameterType;
100  typedef algorithms::neural_networks::layers::softmax::forward::Result ResultType;
101 
102  ParameterType &parameter;
103  InputType input;
106  Batch() : parameter(_defaultParameter)
107  {
108  initialize();
109  };
110 
116  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
117  {
118  initialize();
119  }
120 
127  Batch(const Batch<algorithmFPType, method> &other) : super(other),
128  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
129  {
130  initialize();
131  }
132 
137  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
138 
143  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
144 
149  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
150 
155  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
156  {
157  return getResult();
158  }
159 
164  ResultPtr getResult()
165  {
166  return _result;
167  }
168 
175  services::Status setResult(const ResultPtr& result)
176  {
177  DAAL_CHECK(result, services::ErrorNullResult)
178  _result = result;
179  _res = _result.get();
180  return services::Status();
181  }
182 
189  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
190  {
191  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
192  }
193 
199  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
200  {
201  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
202  this->_res = this->_result.get();
203  return s;
204  }
205 
206 protected:
207  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
208  {
209  return new Batch<algorithmFPType, method>(*this);
210  }
211 
212  void initialize()
213  {
214  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
215  _in = &input;
216  _par = &parameter;
217  _result.reset(new ResultType());
218  }
219 
220 private:
221  ResultPtr _result;
222  ParameterType _defaultParameter;
223 };
225 } // namespace interface1
226 using interface1::BatchContainer;
227 using interface1::Batch;
228 } // namespace forward
229 } // namespace softmax
230 } // namespace layers
231 } // namespace neural_networks
232 } // namespace algorithms
233 } // namespace daal
234 #endif
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::Batch
Batch()
Definition: softmax_layer_forward.h:106
daal
Definition: algorithm_base_common.h:31
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: softmax_layer_forward.h:137
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: softmax_layer_forward.h:199
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: softmax_layer_forward.h:116
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: softmax_layer_forward.h:164
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: softmax_layer_forward.h:143
daal_defines.h
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: softmax_layer_forward.h:149
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: softmax_layer_forward.h:175
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: softmax_layer_forward.h:189
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch
Computes the results of the forward softmax layer in the batch processing mode.
Definition: softmax_layer_forward.h:93
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: softmax_layer_forward.h:102
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:68
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::getLayerResult
layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: softmax_layer_forward.h:155
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: softmax_layer_forward.h:127
daal::algorithms::neural_networks::layers::softmax::forward::interface1::Batch::input
InputType input
Definition: softmax_layer_forward.h:103
daal::algorithms::neural_networks::layers::softmax::forward::interface1::BatchContainer
Class containing methods for the forward softmax layer using algorithmFPType precision arithmetic...
Definition: softmax_layer_forward.h:57
daal::services::ErrorNullResult
Definition: error_indexes.h:96

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