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

maximum_pooling3d_layer_forward.h
1 /* file: maximum_pooling3d_layer_forward.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 forward maximum three-dimensional (3D) pooling layer
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __MAXIMUM_POOLING3D_LAYER_FORWARD_H__
50 #define __MAXIMUM_POOLING3D_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/pooling3d/maximum_pooling3d_layer_types.h"
57 #include "algorithms/neural_networks/layers/pooling3d/maximum_pooling3d_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_pooling3d
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 };
110 
129 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
130 class Batch : public layers::forward::LayerIfaceImpl
131 {
132 public:
133  typedef layers::forward::LayerIfaceImpl super;
134  Parameter &parameter;
135  Input input;
141  Batch(size_t nDimensions) : _defaultParameter(nDimensions - 3, nDimensions - 2, nDimensions - 1), parameter(_defaultParameter)
142  {
143  initialize();
144  }
145 
151  Batch(Parameter& parameter) : parameter(parameter), _defaultParameter(parameter)
152  {
153  initialize();
154  }
155 
162  Batch(const Batch<algorithmFPType, method> &other) : super(other),
163  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
164  {
165  initialize();
166  }
167 
172  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
173 
178  virtual Input *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
179 
184  virtual Parameter *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
185 
190  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
191  {
192  return getResult();
193  }
194 
199  ResultPtr getResult()
200  {
201  return _result;
202  }
203 
210  services::Status setResult(const ResultPtr& result)
211  {
212  DAAL_CHECK(result, services::ErrorNullResult)
213  _result = result;
214  _res = _result.get();
215  return services::Status();
216  }
217 
224  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
225  {
226  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
227  }
228 
234  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
235  {
236  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
237  this->_res = this->_result.get();
238  return s;
239  }
240 
241 protected:
242  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
243  {
244  return new Batch<algorithmFPType, method>(*this);
245  }
246 
247  void initialize()
248  {
249  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
250  _in = &input;
251  _par = &parameter;
252  _result.reset(new Result());
253  }
254 
255 private:
256  ResultPtr _result;
257  Parameter _defaultParameter;
258 };
260 } // namespace interface1
261 using interface1::BatchContainer;
262 using interface1::Batch;
263 } // namespace forward
264 } // namespace maximum_pooling3d
265 } // namespace layers
266 } // namespace neural_networks
267 } // namespace algorithms
268 } // namespace daal
269 
270 #endif
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::getLayerParameter
virtual Parameter * getLayerParameter() DAAL_C11_OVERRIDE
Definition: maximum_pooling3d_layer_forward.h:184
daal
Definition: algorithm_base_common.h:57
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: maximum_pooling3d_layer_forward.h:224
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: maximum_pooling3d_layer_forward.h:234
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::Batch
Batch(Parameter &parameter)
Definition: maximum_pooling3d_layer_forward.h:151
daal_defines.h
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: maximum_pooling3d_layer_forward.h:199
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::parameter
Parameter & parameter
Definition: maximum_pooling3d_layer_forward.h:134
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Input
Input objects for the forward maximum 3D pooling layer See pooling3d::forward::Input ...
Definition: maximum_pooling3d_layer_forward_types.h:90
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: maximum_pooling3d_layer_forward.h:172
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: maximum_pooling3d_layer_forward.h:210
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_pooling3d::forward::interface1::Batch
Provides methods for the forward maximum 3D pooling layer in the batch processing mode...
Definition: maximum_pooling3d_layer_forward.h:130
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: maximum_pooling3d_layer_forward.h:162
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::BatchContainer
Provides methods to run implementations of the forward maximum 3D pooling layer. This class is associ...
Definition: maximum_pooling3d_layer_forward.h:92
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::Batch
Batch(size_t nDimensions)
Definition: maximum_pooling3d_layer_forward.h:141
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::input
Input input
Definition: maximum_pooling3d_layer_forward.h:135
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::getLayerResult
layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: maximum_pooling3d_layer_forward.h:190
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::neural_networks::layers::maximum_pooling3d::forward::interface1::Batch::getLayerInput
virtual Input * getLayerInput() DAAL_C11_OVERRIDE
Definition: maximum_pooling3d_layer_forward.h:178

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