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

stochastic_pooling2d_layer_backward.h
1 /* file: stochastic_pooling2d_layer_backward.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 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 
142  typedef algorithms::neural_networks::layers::stochastic_pooling2d::backward::Input InputType;
143  typedef algorithms::neural_networks::layers::stochastic_pooling2d::Parameter ParameterType;
144  typedef algorithms::neural_networks::layers::stochastic_pooling2d::backward::Result ResultType;
145 
146  ParameterType &parameter;
147  InputType input;
153  Batch(size_t nDimensions) : _defaultParameter(nDimensions - 2, nDimensions - 1), parameter(_defaultParameter)
154  {
155  initialize();
156  }
157 
163  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
164  {
165  initialize();
166  }
167 
174  Batch(const Batch<algorithmFPType, method> &other) : super(other),
175  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
176  {
177  initialize();
178  }
179 
184  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
185 
190  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
191 
196  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
197 
202  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
203  {
204  return _result;
205  }
206 
211  ResultPtr getResult()
212  {
213  return _result;
214  }
215 
222  services::Status setResult(const ResultPtr& result)
223  {
224  DAAL_CHECK(result, services::ErrorNullResult)
225  _result = result;
226  _res = _result.get();
227  return services::Status();
228  }
229 
236  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
237  {
238  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
239  }
240 
246  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
247  {
248  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
249  this->_res = this->_result.get();
250  return s;
251  }
252 
253 protected:
254  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
255  {
256  return new Batch<algorithmFPType, method>(*this);
257  }
258 
259  void initialize()
260  {
261  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
262  _in = &input;
263  _par = &parameter;
264  _result.reset(new ResultType());
265  }
266 
267 private:
268  ResultPtr _result;
269  ParameterType _defaultParameter;
270 };
272 } // namespace interface1
273 using interface1::BatchContainer;
274 using interface1::Batch;
275 } // namespace backward
276 } // namespace stochastic_pooling2d
277 } // namespace layers
278 } // namespace neural_networks
279 } // namespace algorithms
280 } // namespace daal
281 
282 #endif
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::Batch
Batch(size_t nDimensions)
Definition: stochastic_pooling2d_layer_backward.h:153
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::input
InputType input
Definition: stochastic_pooling2d_layer_backward.h:147
daal::algorithms::neural_networks::layers::backward::interface1::LayerIfaceImpl
Implements the abstract interface LayerIface. LayerIfaceImpl is, in turn, the base class for the clas...
Definition: layer_backward.h:153
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward stochastic 2...
Definition: stochastic_pooling2d_layer_backward_types.h:154
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: stochastic_pooling2d_layer_backward.h:211
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:174
daal::algorithms::neural_networks::layers::backward::interface1::LayerIface
Abstract class which defines interface for the layer.
Definition: layer_backward.h:85
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:184
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::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:196
daal_defines.h
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:246
daal::batch
Definition: daal_defines.h:132
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::stochastic_pooling2d::defaultDense
Definition: stochastic_pooling2d_layer_types.h:79
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: stochastic_pooling2d_layer_backward.h:190
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::Batch::parameter
ParameterType & parameter
Definition: stochastic_pooling2d_layer_backward.h:146
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::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_backward_types.h:224
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: stochastic_pooling2d_layer_backward.h:163
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: stochastic_pooling2d_layer_backward.h:222
daal::algorithms::neural_networks::layers::stochastic_pooling2d::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: stochastic_pooling2d_layer_backward.h:236
daal::algorithms::neural_networks::layers::backward::interface1::Input
Input parameters for the layer algorithm
Definition: layer_backward_types.h:150
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::neural_networks::layers::stochastic_pooling2d::interface1::Parameter
Parameters for the stochastic 2D pooling layer.
Definition: stochastic_pooling2d_layer_types.h:115

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