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

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

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