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

average_pooling2d_layer_backward.h
1 /* file: average_pooling2d_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 average two-dimensional (2D) pooling layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __AVERAGE_POOLING2D_LAYER_BACKWARD_H__
26 #define __AVERAGE_POOLING2D_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/pooling2d/average_pooling2d_layer_types.h"
33 #include "algorithms/neural_networks/layers/pooling2d/average_pooling2d_layer_backward_types.h"
34 
35 namespace daal
36 {
37 namespace algorithms
38 {
39 namespace neural_networks
40 {
41 namespace layers
42 {
43 namespace average_pooling2d
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  * \DAAL_DEPRECATED
94  */
95  DAAL_DEPRECATED services::Status setupCompute() DAAL_C11_OVERRIDE;
96 };
97 
118 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
119 class Batch : public layers::backward::LayerIfaceImpl
120 {
121 public:
122  typedef layers::backward::LayerIfaceImpl super;
123 
124  typedef algorithms::neural_networks::layers::average_pooling2d::backward::Input InputType;
125  typedef algorithms::neural_networks::layers::average_pooling2d::Parameter ParameterType;
126  typedef algorithms::neural_networks::layers::average_pooling2d::backward::Result ResultType;
127 
128  ParameterType &parameter;
129  InputType input;
136  DAAL_DEPRECATED Batch(size_t nDimensions) : _defaultParameter(nDimensions - 2, nDimensions - 1),parameter(_defaultParameter)
137  {
138  initialize();
139  }
140 
147  DAAL_DEPRECATED Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
148  {
149  initialize();
150  }
151 
159  Batch(const Batch<algorithmFPType, method> &other) : super(other),
160  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
161  {
162  initialize();
163  }
164 
170  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
171 
177  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
178 
184  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
185 
191  DAAL_DEPRECATED layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
192  {
193  return _result;
194  }
195 
201  DAAL_DEPRECATED ResultPtr getResult()
202  {
203  return _result;
204  }
205 
213  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
214  {
215  DAAL_CHECK(result, services::ErrorNullResult)
216  _result = result;
217  _res = _result.get();
218  return services::Status();
219  }
220 
228  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
229  {
230  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
231  }
232 
239  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateResult() DAAL_C11_OVERRIDE
240  {
241  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
242  this->_res = this->_result.get();
243  return s;
244  }
245 
246 protected:
247  /*
248  * \DAAL_DEPRECATED
249  */
250  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
251  {
252  return new Batch<algorithmFPType, method>(*this);
253  }
254 
255  /*
256  * \DAAL_DEPRECATED
257  */
258  void initialize()
259  {
260  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
261  _in = &input;
262  _par = &parameter;
263  _result.reset(new ResultType());
264  }
265 
266 private:
267  ResultPtr _result;
268  ParameterType _defaultParameter;
269 };
271 } // namespace interface1
272 using interface1::BatchContainer;
273 using interface1::Batch;
274 } // namespace backward
275 } // namespace average_pooling2d
276 } // namespace layers
277 } // namespace neural_networks
278 } // namespace algorithms
279 } // namespace daal
280 
281 #endif
daal::batch
Definition: daal_defines.h:112
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: average_pooling2d_layer_backward.h:213
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::input
InputType input
Definition: average_pooling2d_layer_backward.h:129
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: average_pooling2d_layer_backward.h:228
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: average_pooling2d_layer_backward.h:159
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(size_t nDimensions)
Definition: average_pooling2d_layer_backward.h:136
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:170
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::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:191
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal_defines.h
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:177
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::allocateResult
virtual DAAL_DEPRECATED_VIRTUAL services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:239
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::BatchContainer
Provides methods to run implementations of the backward average 2D pooling layer. This class is assoc...
Definition: average_pooling2d_layer_backward.h:70
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getResult
DAAL_DEPRECATED ResultPtr getResult()
Definition: average_pooling2d_layer_backward.h:201
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(Parameter &parameter)
Definition: average_pooling2d_layer_backward.h:147
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:184
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch
Provides methods for the backward average 2D pooling layer in the batch processing mode...
Definition: average_pooling2d_layer_backward.h:119
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::average_pooling2d::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: average_pooling2d_layer_backward.h:128

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