C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 4

softmax_layer_backward.h
1 /* file: softmax_layer_backward.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 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 backward softmax layer in the batch
19 // processing mode
20 //--
21 */
22 
23 #ifndef __SOFTMAX_LAYER_BACKWARD_H__
24 #define __SOFTMAX_LAYER_BACKWARD_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_backward_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 backward
44 {
45 namespace interface1
46 {
56 template<typename algorithmFPType, Method method, CpuType cpu>
57 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
58 {
59 public:
65  BatchContainer(daal::services::Environment::env *daalEnv);
67  ~BatchContainer();
73  services::Status compute() DAAL_C11_OVERRIDE;
74 };
75 
93 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
94 class Batch : public layers::backward::LayerIfaceImpl
95 {
96 public:
97  typedef layers::backward::LayerIfaceImpl super;
98 
99  typedef algorithms::neural_networks::layers::softmax::backward::Input InputType;
100  typedef algorithms::neural_networks::layers::softmax::Parameter ParameterType;
101  typedef algorithms::neural_networks::layers::softmax::backward::Result ResultType;
102 
103  ParameterType &parameter;
104  InputType input;
107  Batch() : parameter(_defaultParameter)
108  {
109  initialize();
110  }
111 
117  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
118  {
119  initialize();
120  }
121 
128  Batch(const Batch<algorithmFPType, method> &other) : super(other),
129  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
130  {
131  initialize();
132  }
133 
138  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
139 
144  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
145 
150  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
151 
156  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
157  {
158  return _result;
159  }
160 
165  ResultPtr getResult()
166  {
167  return _result;
168  }
169 
176  services::Status setResult(const ResultPtr& result)
177  {
178  DAAL_CHECK(result, services::ErrorNullResult)
179  _result = result;
180  _res = _result.get();
181  return services::Status();
182  }
183 
190  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
191  {
192  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
193  }
194 
200  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
201  {
202  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
203  this->_res = this->_result.get();
204  return s;
205  }
206 
207 protected:
208  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
209  {
210  return new Batch<algorithmFPType, method>(*this);
211  }
212 
213  void initialize()
214  {
215  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
216  _in = &input;
217  _par = &parameter;
218  _result.reset(new ResultType());
219  }
220 
221 private:
222  ResultPtr _result;
223  ParameterType _defaultParameter;
224 };
226 } // namespace interface1
227 using interface1::BatchContainer;
228 using interface1::Batch;
229 } // namespace backward
230 } // namespace softmax
231 } // namespace layers
232 } // namespace neural_networks
233 } // namespace algorithms
234 } // namespace daal
235 #endif
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: softmax_layer_backward.h:128
daal::algorithms::neural_networks::layers::softmax::backward::interface1::BatchContainer
Class containing methods for the backward softmax layer using algorithmFPType precision arithmetic...
Definition: softmax_layer_backward.h:57
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:138
daal
Definition: algorithm_base_common.h:31
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:53
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: softmax_layer_backward.h:190
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: softmax_layer_backward.h:176
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:156
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: softmax_layer_backward.h:117
daal_defines.h
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:150
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:200
daal::batch
Definition: daal_defines.h:110
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: softmax_layer_backward.h:165
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:144
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: softmax_layer_backward.h:103
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::Batch
Batch()
Definition: softmax_layer_backward.h:107
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::backward::interface1::Batch
Computes the results of the backward softmax layer in the batch processing mode.
Definition: softmax_layer_backward.h:94
daal::services::ErrorNullResult
Definition: error_indexes.h:96
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::input
InputType input
Definition: softmax_layer_backward.h:104

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