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

prelu_layer_forward.h
1 /* file: prelu_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 parametric rectified linear unit (pReLU) layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __PRELU_LAYER_FORWARD_H__
26 #define __PRELU_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/prelu/prelu_layer_types.h"
33 #include "algorithms/neural_networks/layers/prelu/prelu_layer_forward_types.h"
34 
35 namespace daal
36 {
37 namespace algorithms
38 {
39 namespace neural_networks
40 {
41 namespace layers
42 {
46 namespace prelu
47 {
48 namespace forward
49 {
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  * \DAAL_DEPRECATED
94  */
95  DAAL_DEPRECATED services::Status setupCompute() DAAL_C11_OVERRIDE;
96  /*
97  * \DAAL_DEPRECATED
98  */
99  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateInput() DAAL_C11_OVERRIDE
100  {
101  Input *input = static_cast<Input *>(_in);
102  return input->allocate<algorithmFPType>(_par, (int) method);
103  }
104 };
105 
126 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
127 class Batch : public layers::forward::LayerIfaceImpl
128 {
129 public:
130  typedef layers::forward::LayerIfaceImpl super;
131 
132  typedef algorithms::neural_networks::layers::prelu::forward::Input InputType;
133  typedef algorithms::neural_networks::layers::prelu::Parameter ParameterType;
134  typedef algorithms::neural_networks::layers::prelu::forward::Result ResultType;
135 
136  ParameterType &parameter;
137  InputType input;
143  DAAL_DEPRECATED Batch() : parameter(_defaultParameter)
144  {
145  initialize();
146  };
147 
154  DAAL_DEPRECATED Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
155  {
156  initialize();
157  }
158 
166  Batch(const Batch<algorithmFPType, method> &other) : super(other),
167  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
168  {
169  initialize();
170  }
171 
177  DAAL_DEPRECATED_VIRTUAL virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
178 
184  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
185 
191  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
192 
198  DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
199  {
200  return _result;
201  }
202 
208  DAAL_DEPRECATED ResultPtr getResult()
209  {
210  return _result;
211  }
212 
220  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
221  {
222  DAAL_CHECK(result, services::ErrorNullResult)
223  _result = result;
224  _res = _result.get();
225  return services::Status();
226  }
227 
234  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
235  {
236  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
237  }
238 
245  DAAL_DEPRECATED_VIRTUAL virtual services::Status allocateResult() DAAL_C11_OVERRIDE
246  {
247  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
248  this->_res = this->_result.get();
249  return s;
250  }
251 
252 protected:
253  /*
254  * \DAAL_DEPRECATED
255  */
256  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
257  {
258  return new Batch<algorithmFPType, method>(*this);
259  }
260 
261  /*
262  * \DAAL_DEPRECATED
263  */
264  void initialize()
265  {
266  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
267  _in = &input;
268  _par = &parameter;
269  _result.reset(new ResultType());
270  }
271 
272 private:
273  ResultPtr _result;
274  ParameterType _defaultParameter;
275 };
277 } // namespace interface1
278 using interface1::BatchContainer;
279 using interface1::Batch;
280 } // namespace forward
281 } // namespace prelu
282 } // namespace layers
283 } // namespace neural_networks
284 } // namespace algorithms
285 } // namespace daal
286 #endif
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: prelu_layer_forward.h:184
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::allocateResult
virtual DAAL_DEPRECATED_VIRTUAL services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: prelu_layer_forward.h:245
daal::algorithms::neural_networks::layers::prelu::forward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: prelu_layer_forward.h:198
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: prelu_layer_forward.h:191
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(ParameterType &parameter)
Definition: prelu_layer_forward.h:154
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: prelu_layer_forward.h:136
daal::algorithms::neural_networks::layers::prelu::forward::interface1::BatchContainer
Provides methods to run implementations of the of the forward prelu layer This class is associated wi...
Definition: prelu_layer_forward.h:70
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal_defines.h
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::getResult
DAAL_DEPRECATED ResultPtr getResult()
Definition: prelu_layer_forward.h:208
daal::algorithms::neural_networks::layers::prelu::forward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::Batch
DAAL_DEPRECATED Batch()
Default constructor.
Definition: prelu_layer_forward.h:143
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::input
InputType input
Definition: prelu_layer_forward.h:137
daal::algorithms::neural_networks::layers::prelu::forward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: prelu_layer_forward.h:220
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Input::allocate
DAAL_EXPORT services::Status allocate(const daal::algorithms::Parameter *par, const int method)
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::getMethod
virtual DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: prelu_layer_forward.h:177
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::prelu::forward::interface1::Batch
Computes the results of the forward prelu layer in the batch processing mode.
Definition: prelu_layer_forward.h:127
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Input
Input objects for the forward prelu layer
Definition: prelu_layer_forward_types.h:68
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: prelu_layer_forward.h:166
daal::algorithms::neural_networks::layers::prelu::forward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: prelu_layer_forward.h:234

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