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

dropout_layer_backward.h
1 /* file: dropout_layer_backward.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 backward dropout layer in the batch processing mode
19 //--
20 */
21 
22 #ifndef __DROPOUT_LAYER_BACKWARD_H__
23 #define __DROPOUT_LAYER_BACKWARD_H__
24 
25 #include "algorithms/algorithm.h"
26 #include "data_management/data/tensor.h"
27 #include "services/daal_defines.h"
28 #include "algorithms/neural_networks/layers/layer.h"
29 #include "algorithms/neural_networks/layers/dropout/dropout_layer_types.h"
30 #include "algorithms/neural_networks/layers/dropout/dropout_layer_backward_types.h"
31 
32 namespace daal
33 {
34 namespace algorithms
35 {
36 namespace neural_networks
37 {
38 namespace layers
39 {
40 namespace dropout
41 {
42 namespace backward
43 {
44 namespace interface1
45 {
61 template<typename algorithmFPType, Method method, CpuType cpu>
62 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
63 {
64 public:
70  BatchContainer(daal::services::Environment::env *daalEnv);
72  ~BatchContainer();
78  services::Status compute() DAAL_C11_OVERRIDE;
79 };
80 
99 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
100 class Batch : public layers::backward::LayerIfaceImpl
101 {
102 public:
103  typedef layers::backward::LayerIfaceImpl super;
104 
105  typedef algorithms::neural_networks::layers::dropout::backward::Input InputType;
106  typedef algorithms::neural_networks::layers::dropout::Parameter ParameterType;
107  typedef algorithms::neural_networks::layers::dropout::backward::Result ResultType;
108 
109  ParameterType &parameter;
110  InputType input;
113  Batch() : parameter(_defaultParameter)
114  {
115  initialize();
116  };
117 
123  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
124  {
125  initialize();
126  }
127 
128 
135  Batch(const Batch<algorithmFPType, method> &other) : super(other),
136  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
137  {
138  initialize();
139  }
140 
145  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
146 
151  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
152 
157  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
158 
163  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
164  {
165  return _result;
166  }
167 
172  ResultPtr getResult()
173  {
174  return _result;
175  }
176 
183  services::Status setResult(const ResultPtr& result)
184  {
185  DAAL_CHECK(result, services::ErrorNullResult)
186  _result = result;
187  _res = _result.get();
188  return services::Status();
189  }
190 
197  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
198  {
199  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
200  }
201 
207  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
208  {
209  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
210  this->_res = this->_result.get();
211  return s;
212  }
213 
214 protected:
215  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
216  {
217  return new Batch<algorithmFPType, method>(*this);
218  }
219 
220  void initialize()
221  {
222  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
223  _in = &input;
224  _par = &parameter;
225  _result.reset(new ResultType());
226  }
227 
228 private:
229  ResultPtr _result;
230  ParameterType _defaultParameter;
231 };
233 } // namespace interface1
234 using interface1::BatchContainer;
235 using interface1::Batch;
236 } // namespace backward
237 } // namespace dropout
238 } // namespace layers
239 } // namespace neural_networks
240 } // namespace algorithms
241 } // namespace daal
242 #endif
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::input
InputType input
Definition: dropout_layer_backward.h:110
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: dropout_layer_backward.h:197
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::dropout::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: dropout_layer_backward.h:123
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:157
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:163
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: dropout_layer_backward.h:109
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch
Provides methods for the backward dropout layer in the batch processing mode.
Definition: dropout_layer_backward.h:100
daal_defines.h
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:145
daal::batch
Definition: daal_defines.h:106
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:151
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: dropout_layer_backward.h:183
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: dropout_layer_backward.h:207
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: dropout_layer_backward.h:172
daal::algorithms::neural_networks::layers::dropout::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward dropout layer This class is associated...
Definition: dropout_layer_backward.h:62
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::dropout::backward::interface1::Batch::Batch
Batch()
Definition: dropout_layer_backward.h:113
daal::algorithms::neural_networks::layers::dropout::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: dropout_layer_backward.h:135
daal::services::ErrorNullResult
Definition: error_indexes.h:96

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