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

maximum_pooling2d_layer_forward.h
1 /* file: maximum_pooling2d_layer_forward.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 forward maximum two-dimensional (2D) pooling layer
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __MAXIMUM_POOLING2D_LAYER_FORWARD_H__
50 #define __MAXIMUM_POOLING2D_LAYER_FORWARD_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/maximum_pooling2d_layer_types.h"
57 #include "algorithms/neural_networks/layers/pooling2d/maximum_pooling2d_layer_forward_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
67 namespace maximum_pooling2d
68 {
69 namespace forward
70 {
74 namespace interface1
75 {
91 template<typename algorithmFPType, Method method, CpuType cpu>
92 class DAAL_EXPORT BatchContainer : public layers::forward::LayerContainerIfaceImpl
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::forward::LayerIfaceImpl
132 {
133 public:
134  typedef layers::forward::LayerIfaceImpl super;
135 
136  typedef algorithms::neural_networks::layers::maximum_pooling2d::forward::Input InputType;
137  typedef algorithms::neural_networks::layers::maximum_pooling2d::Parameter ParameterType;
138  typedef algorithms::neural_networks::layers::maximum_pooling2d::forward::Result ResultType;
139 
140  ParameterType &parameter;
141  InputType input;
147  Batch(size_t nDimensions) : _defaultParameter(nDimensions - 2, nDimensions - 1),parameter(_defaultParameter)
148  {
149  initialize();
150  }
151 
157  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
158  {
159  initialize();
160  }
161 
168  Batch(const Batch<algorithmFPType, method> &other) : super(other),
169  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
170  {
171  initialize();
172  }
173 
178  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
179 
184  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
185 
190  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
191 
196  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
197  {
198  return getResult();
199  }
200 
205  ResultPtr getResult()
206  {
207  return _result;
208  }
209 
216  services::Status setResult(const ResultPtr& result)
217  {
218  DAAL_CHECK(result, services::ErrorNullResult)
219  _result = result;
220  _res = _result.get();
221  return services::Status();
222  }
223 
230  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
231  {
232  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
233  }
234 
240  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
241  {
242  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
243  this->_res = this->_result.get();
244  return s;
245  }
246 
247 protected:
248  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
249  {
250  return new Batch<algorithmFPType, method>(*this);
251  }
252 
253  void initialize()
254  {
255  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
256  _in = &input;
257  _par = &parameter;
258  _result.reset(new ResultType());
259  }
260 
261 private:
262  ResultPtr _result;
263  ParameterType _defaultParameter;
264 };
266 } // namespace interface1
267 using interface1::BatchContainer;
268 using interface1::Batch;
269 } // namespace forward
270 } // namespace maximum_pooling2d
271 } // namespace layers
272 } // namespace neural_networks
273 } // namespace algorithms
274 } // namespace daal
275 
276 #endif
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::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: maximum_pooling2d_layer_forward.h:190
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the forward maximum 2D po...
Definition: maximum_pooling2d_layer_forward_types.h:98
daal::algorithms::neural_networks::layers::forward::interface1::LayerIface
Abstract class which defines interface for the layer.
Definition: layer_forward.h:86
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: maximum_pooling2d_layer_forward.h:184
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: maximum_pooling2d_layer_forward.h:240
daal_defines.h
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: maximum_pooling2d_layer_forward.h:205
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::maximum_pooling2d::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: maximum_pooling2d_layer_forward.h:140
daal::algorithms::neural_networks::layers::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_forward_types.h:241
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::BatchContainer
Provides methods to run implementations of the forward maximum 2D pooling layer. This class is associ...
Definition: maximum_pooling2d_layer_forward.h:92
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Input
Input objects for the forward maximum 2D pooling layer See pooling2d::forward::Input ...
Definition: maximum_pooling2d_layer_forward_types.h:90
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: maximum_pooling2d_layer_forward.h:178
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::input
InputType input
Definition: maximum_pooling2d_layer_forward.h:141
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: maximum_pooling2d_layer_forward.h:216
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::maximum_pooling2d::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: maximum_pooling2d_layer_forward.h:168
daal::algorithms::neural_networks::layers::forward::interface1::Input
Input objects for layer algorithm
Definition: layer_forward_types.h:149
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch
Provides methods for the forward maximum 2D pooling layer in the batch processing mode...
Definition: maximum_pooling2d_layer_forward.h:131
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::Batch
Batch(size_t nDimensions)
Definition: maximum_pooling2d_layer_forward.h:147
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: maximum_pooling2d_layer_forward.h:230
daal::algorithms::neural_networks::layers::maximum_pooling2d::forward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: maximum_pooling2d_layer_forward.h:157
daal::algorithms::neural_networks::layers::forward::interface1::LayerContainerIfaceImpl
Provides methods of base container for forward layers. This class is associated with the daal::algori...
Definition: layer_forward_container_base.h:86
daal::algorithms::neural_networks::layers::forward::interface1::LayerIfaceImpl
Implements the abstract interface LayerIface. LayerIfaceImpl is, in turn, the base class for the clas...
Definition: layer_forward.h:169
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::neural_networks::layers::maximum_pooling2d::interface1::Parameter
Parameters for the maximum 2D pooling layer.
Definition: maximum_pooling2d_layer_types.h:115

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