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

average_pooling2d_layer_backward.h
1 /* file: average_pooling2d_layer_backward.h */
2 /*******************************************************************************
3 * Copyright 2014-2017 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the interface for the backward average two-dimensional (2D) pooling layer
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __AVERAGE_POOLING2D_LAYER_BACKWARD_H__
50 #define __AVERAGE_POOLING2D_LAYER_BACKWARD_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "data_management/data/tensor.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/neural_networks/layers/layer.h"
56 #include "algorithms/neural_networks/layers/pooling2d/average_pooling2d_layer_types.h"
57 #include "algorithms/neural_networks/layers/pooling2d/average_pooling2d_layer_backward_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
67 namespace average_pooling2d
68 {
69 namespace backward
70 {
74 namespace interface1
75 {
91 template<typename algorithmFPType, Method method, CpuType cpu>
92 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
93 {
94 public:
100  BatchContainer(daal::services::Environment::env *daalEnv);
102  ~BatchContainer();
108  services::Status compute() DAAL_C11_OVERRIDE;
109  services::Status setupCompute() DAAL_C11_OVERRIDE;
110 };
111 
130 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
131 class Batch : public layers::backward::LayerIfaceImpl
132 {
133 public:
134  typedef layers::backward::LayerIfaceImpl super;
135  Parameter &parameter;
136  Input input;
142  Batch(size_t nDimensions) : _defaultParameter(nDimensions - 2, nDimensions - 1),parameter(_defaultParameter)
143  {
144  initialize();
145  }
146 
152  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
153  {
154  initialize();
155  }
156 
163  Batch(const Batch<algorithmFPType, method> &other) : super(other),
164  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
165  {
166  initialize();
167  }
168 
173  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
174 
179  virtual Input *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
180 
185  virtual Parameter *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
186 
191  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
192  {
193  return _result;
194  }
195 
200  ResultPtr getResult()
201  {
202  return _result;
203  }
204 
211  services::Status setResult(const ResultPtr& result)
212  {
213  DAAL_CHECK(result, services::ErrorNullResult)
214  _result = result;
215  _res = _result.get();
216  return services::Status();
217  }
218 
225  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
226  {
227  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
228  }
229 
235  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
236  {
237  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
238  this->_res = this->_result.get();
239  return s;
240  }
241 
242 protected:
243  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
244  {
245  return new Batch<algorithmFPType, method>(*this);
246  }
247 
248  void initialize()
249  {
250  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
251  _in = &input;
252  _par = &parameter;
253  _result.reset(new Result());
254  }
255 
256 private:
257  ResultPtr _result;
258  Parameter _defaultParameter;
259 };
261 } // namespace interface1
262 using interface1::BatchContainer;
263 using interface1::Batch;
264 } // namespace backward
265 } // namespace average_pooling2d
266 } // namespace layers
267 } // namespace neural_networks
268 } // namespace algorithms
269 } // namespace daal
270 
271 #endif
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getLayerInput
virtual Input * getLayerInput() DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:179
daal
Definition: algorithm_base_common.h:57
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getLayerParameter
virtual Parameter * getLayerParameter() DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:185
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:235
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::input
Input input
Definition: average_pooling2d_layer_backward.h:136
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:131
daal_defines.h
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::parameter
Parameter & parameter
Definition: average_pooling2d_layer_backward.h:135
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: average_pooling2d_layer_backward.h:152
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: average_pooling2d_layer_backward.h:211
daal::batch
Definition: daal_defines.h:131
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: average_pooling2d_layer_backward.h:225
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: average_pooling2d_layer_backward.h:163
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: average_pooling2d_layer_backward.h:200
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:173
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Input
Input objects for the backward average 2D pooling layer
Definition: average_pooling2d_layer_backward_types.h:90
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: average_pooling2d_layer_backward.h:191
daal::services::ErrorNullResult
Definition: error_indexes.h:122
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:92
daal::algorithms::neural_networks::layers::average_pooling2d::backward::interface1::Batch::Batch
Batch(size_t nDimensions)
Definition: average_pooling2d_layer_backward.h:142

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