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

batch_normalization_layer_backward.h
1 /* file: batch_normalization_layer_backward.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 backward batch normalization layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __BATCH_NORMALIZATION_LAYER_BACKWARD_H__
26 #define __BATCH_NORMALIZATION_LAYER_BACKWARD_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "data_management/data/tensor.h"
30 #include "services/daal_defines.h"
31 #include "algorithms/neural_networks/layers/layer.h"
32 #include "algorithms/neural_networks/layers/batch_normalization/batch_normalization_layer_types.h"
33 #include "algorithms/neural_networks/layers/batch_normalization/batch_normalization_layer_backward_types.h"
34 
35 namespace daal
36 {
37 namespace algorithms
38 {
39 namespace neural_networks
40 {
41 namespace layers
42 {
43 namespace batch_normalization
44 {
45 namespace backward
46 {
50 namespace interface1
51 {
69 template<typename algorithmFPType, Method method, CpuType cpu>
70 class BatchContainer : public AnalysisContainerIface<batch>
71 {
72 public:
79  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
84  DAAL_DEPRECATED ~BatchContainer();
91  DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
92 };
93 
114 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
115 class Batch : public layers::backward::LayerIfaceImpl
116 {
117 public:
118  typedef layers::backward::LayerIfaceImpl super;
119 
120  typedef algorithms::neural_networks::layers::batch_normalization::backward::Input InputType;
121  typedef algorithms::neural_networks::layers::batch_normalization::Parameter ParameterType;
122  typedef algorithms::neural_networks::layers::batch_normalization::backward::Result ResultType;
123 
124  ParameterType &parameter;
125  InputType input;
131  DAAL_DEPRECATED Batch() : parameter(_defaultParameter)
132  {
133  initialize();
134  }
135 
142  DAAL_DEPRECATED Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
143  {
144  initialize();
145  }
146 
154  Batch(const Batch<algorithmFPType, method> &other) : super(other),
155  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
156  {
157  initialize();
158  }
159 
165  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
166 
172  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
173 
179  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
180 
186  DAAL_DEPRECATED layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
187  {
188  return _result;
189  }
190 
196  DAAL_DEPRECATED ResultPtr getResult()
197  {
198  return _result;
199  }
200 
208  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
209  {
210  DAAL_CHECK(result, services::ErrorNullResult)
211  _result = result;
212  _res = _result.get();
213  return services::Status();
214  }
215 
223  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
224  {
225  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
226  }
227 
234  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateResult() DAAL_C11_OVERRIDE
235  {
236  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
237  this->_res = this->_result.get();
238  return s;
239  }
240 
241 protected:
242  /*
243  * \DAAL_DEPRECATED
244  */
245  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
246  {
247  return new Batch<algorithmFPType, method>(*this);
248  }
249 
250  /*
251  * \DAAL_DEPRECATED
252  */
253  void initialize()
254  {
255  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
256  _in = &input;
257  _par = &parameter;
258  _result.reset(new ResultType());
259  }
260 
261 private:
262  ResultPtr _result;
263  ParameterType _defaultParameter;
264 };
266 } // namespace interface1
267 using interface1::BatchContainer;
268 using interface1::Batch;
269 } // namespace backward
270 } // namespace batch_normalization
271 } // namespace layers
272 } // namespace neural_networks
273 } // namespace algorithms
274 } // namespace daal
275 #endif
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(ParameterType &parameter)
Definition: batch_normalization_layer_backward.h:142
daal::batch
Definition: daal_defines.h:112
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::getResult
DAAL_DEPRECATED ResultPtr getResult()
Definition: batch_normalization_layer_backward.h:196
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_backward.h:165
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::allocateResult
virtual DAAL_DEPRECATED_VIRTUAL services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_backward.h:234
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::BatchContainer
Provides methods to run implementations of the backward batch normalization layer. This class is associated with the backward::Batch class and supports the method of backward batch normalization layer computation in the batch processing mode.
Definition: batch_normalization_layer_backward.h:70
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_backward.h:179
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: batch_normalization_layer_backward.h:154
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_defines.h
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: batch_normalization_layer_backward.h:124
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: batch_normalization_layer_backward.h:223
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: batch_normalization_layer_backward.h:208
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_backward.h:186
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch()
Definition: batch_normalization_layer_backward.h:131
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_backward.h:172
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch::input
InputType input
Definition: batch_normalization_layer_backward.h:125
daal::algorithms::neural_networks::layers::batch_normalization::backward::interface1::Batch
Provides methods for the backward batch normalization layer in the batch processing mode...
Definition: batch_normalization_layer_backward.h:115

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