C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 5

lrn_layer_forward.h
1 /* file: lrn_layer_forward.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Implementation of the interface for the forward local response normalization layer
19 // in the batch processing mode
20 //--
21 */
22 
23 #ifndef __LRN_LAYER_FORWARD_H__
24 #define __LRN_LAYER_FORWARD_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "data_management/data/tensor.h"
28 #include "services/daal_defines.h"
29 #include "algorithms/neural_networks/layers/layer.h"
30 #include "algorithms/neural_networks/layers/lrn/lrn_layer_types.h"
31 #include "algorithms/neural_networks/layers/lrn/lrn_layer_forward_types.h"
32 
33 namespace daal
34 {
35 namespace algorithms
36 {
37 namespace neural_networks
38 {
39 namespace layers
40 {
41 namespace lrn
42 {
43 namespace forward
44 {
45 namespace interface1
46 {
62 template<typename algorithmFPType, Method method, CpuType cpu>
63 class DAAL_EXPORT BatchContainer : public layers::forward::LayerContainerIfaceImpl
64 {
65 public:
71  BatchContainer(daal::services::Environment::env *daalEnv);
73  ~BatchContainer();
79  services::Status compute() DAAL_C11_OVERRIDE;
80 };
81 
100 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
101 class Batch : public layers::forward::LayerIfaceImpl
102 {
103 public:
104  typedef layers::forward::LayerIfaceImpl super;
105 
106  typedef algorithms::neural_networks::layers::lrn::forward::Input InputType;
107  typedef algorithms::neural_networks::layers::lrn::Parameter ParameterType;
108  typedef algorithms::neural_networks::layers::lrn::forward::Result ResultType;
109 
110  ParameterType &parameter;
111  InputType input;
114  Batch() : parameter(_defaultParameter)
115  {
116  initialize();
117  };
118 
119 
125  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
126  {
127  initialize();
128  }
129 
130 
137  Batch(const Batch<algorithmFPType, method> &other) : super(other),
138  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
139  {
140  initialize();
141  }
142 
147  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
148 
153  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
154 
159  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
160 
165  layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
166  {
167  return getResult();
168  }
169 
174  ResultPtr getResult()
175  {
176  return _result;
177  }
178 
185  services::Status setResult(const ResultPtr& result)
186  {
187  DAAL_CHECK(result, services::ErrorNullResult)
188  _result = result;
189  _res = _result.get();
190  return services::Status();
191  }
192 
199  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
200  {
201  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
202  }
203 
209  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
210  {
211  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
212  this->_res = this->_result.get();
213  return s;
214  }
215 
216 protected:
217  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
218  {
219  return new Batch<algorithmFPType, method>(*this);
220  }
221 
222  void initialize()
223  {
224  Analysis<batch>::_ac = new __DAAL_ALGORITHM_LAYER_CONTAINER(BatchContainer, algorithmFPType, method)(&_env);
225  _in = &input;
226  _par = &parameter;
227  _result.reset(new ResultType());
228  }
229 
230 private:
231  ResultPtr _result;
232  ParameterType _defaultParameter;
233 };
235 } // namespace interface1
236 using interface1::BatchContainer;
237 using interface1::Batch;
238 } // namespace forward
239 } // namespace lrn
240 } // namespace layers
241 } // namespace neural_networks
242 } // namespace algorithms
243 } // namespace daal
244 #endif
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: lrn_layer_forward.h:147
daal
Definition: algorithm_base_common.h:31
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch
Provides methods for the forward local response normalization layer in the batch processing mode...
Definition: lrn_layer_forward.h:101
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::parameter
ParameterType & parameter
Definition: lrn_layer_forward.h:110
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::getResult
ResultPtr getResult()
Definition: lrn_layer_forward.h:174
daal_defines.h
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::getLayerResult
layers::forward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: lrn_layer_forward.h:165
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: lrn_layer_forward.h:125
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: lrn_layer_forward.h:153
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: lrn_layer_forward.h:185
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::Batch
Batch()
Definition: lrn_layer_forward.h:114
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: lrn_layer_forward.h:159
daal::algorithms::neural_networks::layers::lrn::forward::interface1::BatchContainer
Provides methods to run implementations of the of the forward local response normalization layer This...
Definition: lrn_layer_forward.h:63
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:68
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::input
InputType input
Definition: lrn_layer_forward.h:111
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: lrn_layer_forward.h:209
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: lrn_layer_forward.h:137
daal::algorithms::neural_networks::layers::lrn::forward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: lrn_layer_forward.h:199
daal::services::ErrorNullResult
Definition: error_indexes.h:96

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