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

stochastic_pooling2d_layer_backward.h
1 /* file: stochastic_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 stochastic two-dimensional (2D) pooling layer
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __STOCHASTIC_POOLING2D_LAYER_BACKWARD_H__
50 #define __STOCHASTIC_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/stochastic_pooling2d_layer_types.h"
57 #include "algorithms/neural_networks/layers/pooling2d/stochastic_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 stochastic_pooling2d
68 {
69 namespace backward
70 {
74 namespace interface1
75 {
85 template<typename algorithmFPType, Method method, CpuType cpu>
86 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
87 {};
98 template<typename algorithmFPType, CpuType cpu>
99 class DAAL_EXPORT BatchContainer<algorithmFPType, defaultDense, cpu>: public AnalysisContainerIface<batch>
100 {
101 public:
107  BatchContainer(daal::services::Environment::env *daalEnv);
109  ~BatchContainer();
115  services::Status compute() DAAL_C11_OVERRIDE;
116 };
117 
136 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
137 class Batch : public layers::backward::LayerIfaceImpl
138 {
139 public:
140  typedef layers::backward::LayerIfaceImpl super;
141  Parameter &parameter;
142  Input input;
148  Batch(size_t nDimensions) : _defaultParameter(nDimensions - 2, nDimensions - 1), parameter(_defaultParameter)
149  {
150  initialize();
151  }
152 
158  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
159  {
160  initialize();
161  }
162 
169  Batch(const Batch<algorithmFPType, method> &other) : super(other),
170  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
171  {
172  initialize();
173  }
174 
179  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
180 
185  virtual Input *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
186 
191  virtual Parameter *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
192 
197  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
198  {
199  return _result;
200  }
201 
206  ResultPtr getResult()
207  {
208  return _result;
209  }
210 
217  services::Status setResult(const ResultPtr& result)
218  {
219  DAAL_CHECK(result, services::ErrorNullResult)
220  _result = result;
221  _res = _result.get();
222  return services::Status();
223  }
224 
231  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
232  {
233  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
234  }
235 
241  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
242  {
243  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
244  this->_res = this->_result.get();
245  return s;
246  }
247 
248 protected:
249  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
250  {
251  return new Batch<algorithmFPType, method>(*this);
252  }
253 
254  void initialize()
255  {
256  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
257  _in = &input;
258  _par = &parameter;
259  _result.reset(new Result());
260  }
261 
262 private:
263  ResultPtr _result;
264  Parameter _defaultParameter;
265 };
267 } // namespace interface1
268 using interface1::BatchContainer;
269 using interface1::Batch;
270 } // namespace backward
271 } // namespace stochastic_pooling2d
272 } // namespace layers
273 } // namespace neural_networks
274 } // namespace algorithms
275 } // namespace daal
276 
277 #endif
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::Batch
Batch(size_t nDimensions)
Definition: stochastic_pooling2d_layer_backward.h:148
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: stochastic_pooling2d_layer_backward.h:231
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::input
Input input
Definition: stochastic_pooling2d_layer_backward.h:142
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: stochastic_pooling2d_layer_backward.h:206
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::stochastic_pooling2d::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: stochastic_pooling2d_layer_backward.h:169
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getLayerParameter
virtual Parameter * getLayerParameter() DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:191
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:179
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::BatchContainer
Provides methods to run implementations of the backward stochastic 2D pooling layer.
Definition: stochastic_pooling2d_layer_backward.h:86
daal_defines.h
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: stochastic_pooling2d_layer_backward.h:158
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:241
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::parameter
Parameter & parameter
Definition: stochastic_pooling2d_layer_backward.h:141
daal::batch
Definition: daal_defines.h:131
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch
Provides methods for the backward stochastic 2D pooling layer in the batch processing mode...
Definition: stochastic_pooling2d_layer_backward.h:137
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::stochastic_pooling2d::backward::interface1::Input
Input objects for the backward stochastic 2D pooling layer
Definition: stochastic_pooling2d_layer_backward_types.h:91
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:197
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: stochastic_pooling2d_layer_backward.h:217
daal::algorithms::neural_networks::layers::stochastic_pooling2d::defaultDense
Definition: stochastic_pooling2d_layer_types.h:79
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getLayerInput
virtual Input * getLayerInput() DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:185

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