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

batch_normalization_layer_forward.h
1 /* file: batch_normalization_layer_forward.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 forward batch normalization layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __BATCH_NORMALIZATION_LAYER_FORWARD_H__
26 #define __BATCH_NORMALIZATION_LAYER_FORWARD_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_forward_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 forward
46 {
50 namespace interface1
51 {
69 template<typename algorithmFPType, Method method, CpuType cpu>
70 class BatchContainer : public layers::forward::LayerContainerIfaceImpl
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  * \DAAL_DEPRECATED
94  */
95  DAAL_DEPRECATED services::Status setupCompute() DAAL_C11_OVERRIDE;
96  /*
97  * \DAAL_DEPRECATED
98  */
99  DAAL_DEPRECATED services::Status resetCompute() DAAL_C11_OVERRIDE;
100  /*
101  * \DAAL_DEPRECATED
102  */
103  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateInput() DAAL_C11_OVERRIDE
104  {
105  Input *input = static_cast<Input *>(_in);
106  return input->allocate<algorithmFPType>(_par, (int) method);
107  }
108 };
109 
130 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
131 class Batch : public layers::forward::LayerIfaceImpl
132 {
133 public:
134  typedef layers::forward::LayerIfaceImpl super;
135 
136  typedef algorithms::neural_networks::layers::batch_normalization::forward::Input InputType;
137  typedef algorithms::neural_networks::layers::batch_normalization::Parameter ParameterType;
138  typedef algorithms::neural_networks::layers::batch_normalization::forward::Result ResultType;
139 
140  ParameterType &parameter;
141  InputType input;
147  DAAL_DEPRECATED Batch() : parameter(_defaultParameter)
148  {
149  initialize();
150  }
151 
158  DAAL_DEPRECATED Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
159  {
160  initialize();
161  }
162 
170  Batch(const Batch<algorithmFPType, method> &other) : super(other),
171  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
172  {
173  initialize();
174  }
175 
181  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
182 
188  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
189 
195  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
196 
202  DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
203  {
204  return getResult();
205  }
206 
212  ResultPtr getResult()
213  {
214  return _result;
215  }
216 
224  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
225  {
226  DAAL_CHECK(result, services::ErrorNullResult)
227  _result = result;
228  _res = _result.get();
229  return services::Status();
230  }
231 
239  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
240  {
241  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
242  }
243 
250  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateResult() DAAL_C11_OVERRIDE
251  {
252  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
253  this->_res = this->_result.get();
254  return s;
255  }
256 
262  DAAL_DEPRECATED_VIRTUAL virtual layers::forward::LayerIfacePtr getLayerForPrediction() const DAAL_C11_OVERRIDE
263  {
264  services::SharedPtr<Batch<algorithmFPType, method> > seflCopy = clone();
265  if (_result)
266  {
267  seflCopy->input.set(forward::populationMean, _result->get(auxPopulationMean));
268  seflCopy->input.set(forward::populationVariance, _result->get(auxPopulationVariance));
269  }
270  return services::staticPointerCast<layers::forward::LayerIface>(seflCopy);
271  }
272 
273 protected:
274  /*
275  * \DAAL_DEPRECATED
276  */
277  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
278  {
279  return new Batch<algorithmFPType, method>(*this);
280  }
281 
282  /*
283  * \DAAL_DEPRECATED
284  */
285  void initialize()
286  {
287  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
288  _in = &input;
289  _par = &parameter;
290  _result.reset(new ResultType());
291  }
292 
293 private:
294  ResultPtr _result;
295  ParameterType _defaultParameter;
296 };
297 
299 } // namespace interface1
300 using interface1::BatchContainer;
301 using interface1::Batch;
302 } // namespace forward
303 } // namespace batch_normalization
304 } // namespace layers
305 } // namespace neural_networks
306 } // namespace algorithms
307 } // namespace daal
308 
309 #endif
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::input
InputType input
Definition: batch_normalization_layer_forward.h:141
daal::algorithms::neural_networks::layers::batch_normalization::auxPopulationMean
Definition: batch_normalization_layer_types.h:68
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: batch_normalization_layer_forward.h:239
daal::algorithms::neural_networks::layers::batch_normalization::auxPopulationVariance
Definition: batch_normalization_layer_types.h:69
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: batch_normalization_layer_forward.h:212
daal::algorithms::neural_networks::layers::batch_normalization::forward::populationVariance
Definition: batch_normalization_layer_forward_types.h:62
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Input
Input objects for the forward batch normalization layer.
Definition: batch_normalization_layer_forward_types.h:76
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_forward.h:202
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::allocateResult
virtual DAAL_DEPRECATED_VIRTUAL services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_forward.h:250
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: batch_normalization_layer_forward.h:170
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_forward.h:181
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: batch_normalization_layer_forward.h:224
daal_defines.h
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_forward.h:195
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: batch_normalization_layer_forward.h:140
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::BatchContainer
Provides methods to run implementations of the forward batch normalization layer. This class is assoc...
Definition: batch_normalization_layer_forward.h:70
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_forward.h:188
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Input::allocate
DAAL_EXPORT services::Status allocate(const daal::algorithms::Parameter *parameter, const int method)
daal::algorithms::neural_networks::layers::batch_normalization::forward::populationMean
Definition: batch_normalization_layer_forward_types.h:61
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch
Provides methods for the forward batch normalization layer in the batch processing mode...
Definition: batch_normalization_layer_forward.h:131
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::getLayerForPrediction
virtual DAAL_DEPRECATED_VIRTUAL layers::forward::LayerIfacePtr getLayerForPrediction() const DAAL_C11_OVERRIDE
Definition: batch_normalization_layer_forward.h:262
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::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch()
Definition: batch_normalization_layer_forward.h:147
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(ParameterType &parameter)
Definition: batch_normalization_layer_forward.h:158

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