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

softmax_layer_backward.h
1 /* file: softmax_layer_backward.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 interface for the backward softmax layer in the batch
45 // processing mode
46 //--
47 */
48 
49 #ifndef __SOFTMAX_LAYER_BACKWARD_H__
50 #define __SOFTMAX_LAYER_BACKWARD_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/tensor.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/neural_networks/layers/layer.h"
56 #include "algorithms/neural_networks/layers/softmax/softmax_layer_types.h"
57 #include "algorithms/neural_networks/layers/softmax/softmax_layer_backward_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
67 namespace softmax
68 {
69 namespace backward
70 {
71 namespace interface1
72 {
82 template<typename algorithmFPType, Method method, CpuType cpu>
83 class DAAL_EXPORT BatchContainer : public daal::algorithms::AnalysisContainerIface<batch>
84 {
85 public:
91  BatchContainer(daal::services::Environment::env *daalEnv);
93  ~BatchContainer();
99  services::Status compute() DAAL_C11_OVERRIDE;
100 };
101 
119 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
120 class Batch : public layers::backward::LayerIfaceImpl
121 {
122 public:
123  typedef layers::backward::LayerIfaceImpl super;
124  Parameter &parameter;
125  Input input;
128  Batch() : parameter(_defaultParameter)
129  {
130  initialize();
131  }
132 
138  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
139  {
140  initialize();
141  }
142 
149  Batch(const Batch<algorithmFPType, method> &other) : super(other),
150  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
151  {
152  initialize();
153  }
154 
159  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
160 
165  virtual Input *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
166 
171  virtual Parameter *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
172 
177  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
178  {
179  return _result;
180  }
181 
186  ResultPtr getResult()
187  {
188  return _result;
189  }
190 
197  services::Status setResult(const ResultPtr& result)
198  {
199  DAAL_CHECK(result, services::ErrorNullResult)
200  _result = result;
201  _res = _result.get();
202  return services::Status();
203  }
204 
211  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
212  {
213  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
214  }
215 
221  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
222  {
223  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
224  this->_res = this->_result.get();
225  return s;
226  }
227 
228 protected:
229  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
230  {
231  return new Batch<algorithmFPType, method>(*this);
232  }
233 
234  void initialize()
235  {
236  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
237  _in = &input;
238  _par = &parameter;
239  _result.reset(new Result());
240  }
241 
242 private:
243  ResultPtr _result;
244  Parameter _defaultParameter;
245 };
247 } // namespace interface1
248 using interface1::BatchContainer;
249 using interface1::Batch;
250 } // namespace backward
251 } // namespace softmax
252 } // namespace layers
253 } // namespace neural_networks
254 } // namespace algorithms
255 } // namespace daal
256 #endif
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: softmax_layer_backward.h:149
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:83
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:159
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getLayerParameter
virtual Parameter * getLayerParameter() DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:171
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Input
Input objects for the backward softmax layer
Definition: softmax_layer_backward_types.h:89
daal
Definition: algorithm_base_common.h:57
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: softmax_layer_backward.h:211
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: softmax_layer_backward.h:197
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:177
daal_defines.h
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::input
Input input
Definition: softmax_layer_backward.h:125
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:221
daal::batch
Definition: daal_defines.h:131
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: softmax_layer_backward.h:138
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: softmax_layer_backward.h:186
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::parameter
Parameter & parameter
Definition: softmax_layer_backward.h:124
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::getLayerInput
virtual Input * getLayerInput() DAAL_C11_OVERRIDE
Definition: softmax_layer_backward.h:165
daal::algorithms::neural_networks::layers::softmax::backward::interface1::Batch::Batch
Batch()
Definition: softmax_layer_backward.h:128
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
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:120
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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