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

average_pooling1d_layer_forward.h
1 /* file: average_pooling1d_layer_forward.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Implementation of the interface for the forward average one-dimensional (1D) pooling layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __AVERAGE_POOLING1D_LAYER_FORWARD_H__
26 #define __AVERAGE_POOLING1D_LAYER_FORWARD_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "data_management/data/tensor.h"
30 #include "services/daal_defines.h"
31 #include "algorithms/neural_networks/layers/layer.h"
32 #include "algorithms/neural_networks/layers/pooling1d/average_pooling1d_layer_types.h"
33 #include "algorithms/neural_networks/layers/pooling1d/average_pooling1d_layer_forward_types.h"
34 
35 namespace daal
36 {
37 namespace algorithms
38 {
39 namespace neural_networks
40 {
41 namespace layers
42 {
43 namespace average_pooling1d
44 {
45 namespace forward
46 {
50 namespace interface1
51 {
69 template<typename algorithmFPType, Method method, CpuType cpu>
70 class BatchContainer : public layers::forward::LayerContainerIfaceImpl
71 {
72 public:
79  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
84  DAAL_DEPRECATED ~BatchContainer();
91  DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
92 };
93 
114 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
115 class Batch : public layers::forward::LayerIfaceImpl
116 {
117 public:
118  typedef layers::forward::LayerIfaceImpl super;
119 
120  typedef algorithms::neural_networks::layers::average_pooling1d::forward::Input InputType;
121  typedef algorithms::neural_networks::layers::average_pooling1d::Parameter ParameterType;
122  typedef algorithms::neural_networks::layers::average_pooling1d::forward::Result ResultType;
123 
124  ParameterType &parameter;
125  InputType input;
132  DAAL_DEPRECATED Batch(size_t nDimensions) : _defaultParameter(nDimensions-1), parameter(_defaultParameter)
133  {
134  initialize();
135  }
136 
143  DAAL_DEPRECATED Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
144  {
145  initialize();
146  }
147 
148 
156  Batch(const Batch<algorithmFPType, method> &other) : super(other),
157  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
158  {
159  initialize();
160  }
161 
167  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
168 
174  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
175 
181  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
182 
188  DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
189  {
190  return getResult();
191  }
192 
198  ResultPtr getResult()
199  {
200  return _result;
201  }
202 
210  DAAL_DEPRECATED 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 
225  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
226  {
227  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
228  }
229 
236  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateResult() DAAL_C11_OVERRIDE
237  {
238  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
239  this->_res = this->_result.get();
240  return s;
241  }
242 
243 protected:
244  /*
245  * \DAAL_DEPRECATED
246  */
247  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
248  {
249  return new Batch<algorithmFPType, method>(*this);
250  }
251 
252  /*
253  * \DAAL_DEPRECATED
254  */
255  void initialize()
256  {
257  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(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 forward
272 } // namespace average_pooling1d
273 } // namespace layers
274 } // namespace neural_networks
275 } // namespace algorithms
276 } // namespace daal
277 
278 #endif
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: average_pooling1d_layer_forward.h:124
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: average_pooling1d_layer_forward.h:156
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: average_pooling1d_layer_forward.h:198
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch
Provides methods for the forward average 1D pooling layer in the batch processing mode...
Definition: average_pooling1d_layer_forward.h:115
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(ParameterType &parameter)
Definition: average_pooling1d_layer_forward.h:143
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: average_pooling1d_layer_forward.h:174
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(size_t nDimensions)
Definition: average_pooling1d_layer_forward.h:132
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::input
InputType input
Definition: average_pooling1d_layer_forward.h:125
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal_defines.h
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: average_pooling1d_layer_forward.h:181
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: average_pooling1d_layer_forward.h:210
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: average_pooling1d_layer_forward.h:225
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::allocateResult
virtual DAAL_DEPRECATED_VIRTUAL services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: average_pooling1d_layer_forward.h:236
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: average_pooling1d_layer_forward.h:167
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: average_pooling1d_layer_forward.h:188
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:70
daal::algorithms::neural_networks::layers::average_pooling1d::forward::interface1::BatchContainer
Provides methods to run implementations of the forward average 1D pooling layer. This class is associ...
Definition: average_pooling1d_layer_forward.h:70

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