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

spatial_stochastic_pooling2d_layer_backward.h
1 /* file: spatial_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 spatial pyramid stochastic two-dimensional (2D) pooling layer
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __SPATIAL_STOCHASTIC_POOLING2D_LAYER_BACKWARD_H__
50 #define __SPATIAL_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/spatial_pooling2d/spatial_stochastic_pooling2d_layer_backward_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace neural_networks
63 {
64 namespace layers
65 {
66 namespace spatial_stochastic_pooling2d
67 {
68 namespace backward
69 {
73 namespace interface1
74 {
80 template<typename algorithmFPType, Method method, CpuType cpu>
81 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
82 {};
93 template<typename algorithmFPType, CpuType cpu>
94 class DAAL_EXPORT BatchContainer<algorithmFPType, defaultDense, cpu> : public AnalysisContainerIface<batch>
95 {
96 public:
102  BatchContainer(daal::services::Environment::env *daalEnv);
104  ~BatchContainer();
110  services::Status compute() DAAL_C11_OVERRIDE;
111 };
112 
131 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
132 class Batch : public layers::backward::LayerIfaceImpl
133 {
134 public:
135  typedef layers::backward::LayerIfaceImpl super;
136 
137  typedef algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::Input InputType;
138  typedef algorithms::neural_networks::layers::spatial_stochastic_pooling2d::Parameter ParameterType;
139  typedef algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::Result ResultType;
140 
141  ParameterType &parameter;
142  InputType input;
149  Batch(size_t pyramidHeight, size_t nDimensions) : _defaultParameter(pyramidHeight, nDimensions - 2, nDimensions - 1), parameter(_defaultParameter)
150  {
151  initialize();
152  }
153 
159  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
160  {
161  initialize();
162  }
163 
170  Batch(const Batch<algorithmFPType, method> &other) : super(other),
171  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
172  {
173  initialize();
174  }
175 
180  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
181 
186  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
187 
192  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
193 
198  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
199  {
200  return _result;
201  }
202 
207  ResultPtr getResult()
208  {
209  return _result;
210  }
211 
218  services::Status setResult(const ResultPtr& result)
219  {
220  DAAL_CHECK(result, services::ErrorNullResult)
221  _result = result;
222  _res = _result.get();
223  return services::Status();
224  }
225 
232  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
233  {
234  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
235  }
236 
242  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
243  {
244  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
245  this->_res = this->_result.get();
246  return s;
247  }
248 
249 protected:
250  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
251  {
252  return new Batch<algorithmFPType, method>(*this);
253  }
254 
255  void initialize()
256  {
257  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
258  _in = &input;
259  _par = &parameter;
260  _result.reset(new ResultType());
261  }
262 
263 private:
264  ResultPtr _result;
265  ParameterType _defaultParameter;
266 };
268 } // namespace interface1
269 using interface1::BatchContainer;
270 using interface1::Batch;
271 } // namespace backward
272 } // namespace spatial_stochastic_pooling2d
273 } // namespace layers
274 } // namespace neural_networks
275 } // namespace algorithms
276 } // namespace daal
277 
278 #endif
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: spatial_stochastic_pooling2d_layer_backward.h:192
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::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
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::backward::interface1::LayerIface
Abstract class which defines interface for the layer.
Definition: layer_backward.h:85
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: spatial_stochastic_pooling2d_layer_backward.h:186
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Input
Input objects for the backward spatial pyramid stochastic 2D pooling layer
Definition: spatial_stochastic_pooling2d_layer_backward_types.h:90
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: spatial_stochastic_pooling2d_layer_backward.h:180
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::Batch
Batch(size_t pyramidHeight, size_t nDimensions)
Definition: spatial_stochastic_pooling2d_layer_backward.h:149
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: spatial_stochastic_pooling2d_layer_backward.h:218
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::defaultDense
Definition: spatial_stochastic_pooling2d_layer_types.h:80
daal_defines.h
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the backward spatial pyra...
Definition: spatial_stochastic_pooling2d_layer_backward_types.h:152
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::input
InputType input
Definition: spatial_stochastic_pooling2d_layer_backward.h:142
daal::batch
Definition: daal_defines.h:132
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: spatial_stochastic_pooling2d_layer_backward.h:207
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::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: spatial_stochastic_pooling2d_layer_backward.h:141
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: spatial_stochastic_pooling2d_layer_backward.h:242
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::BatchContainer
Definition: spatial_stochastic_pooling2d_layer_backward.h:81
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::interface1::Parameter
Parameters for the spatial pyramid stochastic 2D pooling layer.
Definition: spatial_stochastic_pooling2d_layer_types.h:116
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: spatial_stochastic_pooling2d_layer_backward.h:170
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::spatial_stochastic_pooling2d::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: spatial_stochastic_pooling2d_layer_backward.h:159
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::spatial_stochastic_pooling2d::backward::interface1::Batch
Provides methods for the backward spatial pyramid stochastic 2D pooling layer in the batch processing...
Definition: spatial_stochastic_pooling2d_layer_backward.h:132
daal::algorithms::neural_networks::layers::spatial_stochastic_pooling2d::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: spatial_stochastic_pooling2d_layer_backward.h:232
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

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