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

spatial_maximum_pooling2d_layer_backward.h
1 /* file: spatial_maximum_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 spatial pyramid maximum two-dimensional (2D) pooling layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __SPATIAL_MAXIMUM_POOLING2D_LAYER_BACKWARD_H__
26 #define __SPATIAL_MAXIMUM_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/spatial_pooling2d/spatial_maximum_pooling2d_layer_types.h"
33 #include "algorithms/neural_networks/layers/spatial_pooling2d/spatial_maximum_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 spatial_maximum_pooling2d
44 {
45 namespace backward
46 {
50 namespace interface1
51 {
57 template<typename algorithmFPType, Method method, CpuType cpu>
58 class BatchContainer : public AnalysisContainerIface<batch>
59 {};
72 template<typename algorithmFPType, CpuType cpu>
73 class BatchContainer<algorithmFPType, defaultDense, cpu> : public AnalysisContainerIface<batch>
74 {
75 public:
82  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
87  DAAL_DEPRECATED ~BatchContainer();
93  services::Status compute() DAAL_C11_OVERRIDE;
94 };
95 
116 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
117 class Batch : public layers::backward::LayerIfaceImpl
118 {
119 public:
120  typedef layers::backward::LayerIfaceImpl super;
121 
122  typedef algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::Input InputType;
123  typedef algorithms::neural_networks::layers::spatial_maximum_pooling2d::Parameter ParameterType;
124  typedef algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::Result ResultType;
125 
126  ParameterType &parameter;
127  InputType input;
135  DAAL_DEPRECATED Batch(size_t pyramidHeight, size_t nDimensions) : _defaultParameter(pyramidHeight, nDimensions - 2, nDimensions - 1), parameter(_defaultParameter)
136  {
137  initialize();
138  }
139 
146  DAAL_DEPRECATED Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
147  {
148  initialize();
149  }
150 
158  Batch(const Batch<algorithmFPType, method> &other) : super(other),
159  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
160  {
161  initialize();
162  }
163 
168  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
169 
174  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
175 
180  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
181 
186  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
187  {
188  return _result;
189  }
190 
195  ResultPtr getResult()
196  {
197  return _result;
198  }
199 
206  services::Status setResult(const ResultPtr& result)
207  {
208  DAAL_CHECK(result, services::ErrorNullResult)
209  _result = result;
210  _res = _result.get();
211  return services::Status();
212  }
213 
220  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
221  {
222  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
223  }
224 
230  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
231  {
232  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
233  this->_res = this->_result.get();
234  return s;
235  }
236 
237 protected:
238  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
239  {
240  return new Batch<algorithmFPType, method>(*this);
241  }
242 
243  void initialize()
244  {
245  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
246  _in = &input;
247  _par = &parameter;
248  _result.reset(new ResultType());
249  }
250 
251 private:
252  ResultPtr _result;
253  ParameterType _defaultParameter;
254 };
256 } // namespace interface1
257 using interface1::BatchContainer;
258 using interface1::Batch;
259 } // namespace backward
260 } // namespace spatial_maximum_pooling2d
261 } // namespace layers
262 } // namespace neural_networks
263 } // namespace algorithms
264 } // namespace daal
265 
266 #endif
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: spatial_maximum_pooling2d_layer_backward.h:180
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::BatchContainer
Definition: spatial_maximum_pooling2d_layer_backward.h:58
daal::batch
Definition: daal_defines.h:112
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::input
InputType input
Definition: spatial_maximum_pooling2d_layer_backward.h:127
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: spatial_maximum_pooling2d_layer_backward.h:186
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: spatial_maximum_pooling2d_layer_backward.h:220
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(size_t pyramidHeight, size_t nDimensions)
Definition: spatial_maximum_pooling2d_layer_backward.h:135
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::spatial_maximum_pooling2d::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: spatial_maximum_pooling2d_layer_backward.h:174
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: spatial_maximum_pooling2d_layer_backward.h:126
daal_defines.h
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: spatial_maximum_pooling2d_layer_backward.h:206
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: spatial_maximum_pooling2d_layer_backward.h:230
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(ParameterType &parameter)
Definition: spatial_maximum_pooling2d_layer_backward.h:146
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::spatial_maximum_pooling2d::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: spatial_maximum_pooling2d_layer_backward.h:158
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::defaultDense
Definition: spatial_maximum_pooling2d_layer_types.h:55
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: spatial_maximum_pooling2d_layer_backward.h:168
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch
Provides methods for the backward spatial pyramid maximum 2D pooling layer in the batch processing mo...
Definition: spatial_maximum_pooling2d_layer_backward.h:117
daal::algorithms::neural_networks::layers::spatial_maximum_pooling2d::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: spatial_maximum_pooling2d_layer_backward.h:195

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