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

lrn_layer_backward.h
1 /* file: lrn_layer_backward.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 backward local response normalization layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __LRN_LAYER_BACKWARD_H__
26 #define __LRN_LAYER_BACKWARD_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/lrn/lrn_layer_types.h"
33 #include "algorithms/neural_networks/layers/lrn/lrn_layer_backward_types.h"
34 
35 namespace daal
36 {
37 namespace algorithms
38 {
39 namespace neural_networks
40 {
41 namespace layers
42 {
43 namespace lrn
44 {
45 namespace backward
46 {
47 namespace interface1
48 {
66 template<typename algorithmFPType, Method method, CpuType cpu>
67 class BatchContainer : public AnalysisContainerIface<batch>
68 {
69 public:
76  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
81  DAAL_DEPRECATED ~BatchContainer();
88  DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
89 };
90 
111 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
112 class Batch : public layers::backward::LayerIfaceImpl
113 {
114 public:
115  typedef layers::backward::LayerIfaceImpl super;
116 
117  typedef algorithms::neural_networks::layers::lrn::backward::Input InputType;
118  typedef algorithms::neural_networks::layers::lrn::Parameter ParameterType;
119  typedef algorithms::neural_networks::layers::lrn::backward::Result ResultType;
120 
121  ParameterType &parameter;
122  InputType input;
128  DAAL_DEPRECATED Batch() : parameter(_defaultParameter)
129  {
130  initialize();
131  };
132 
139  DAAL_DEPRECATED Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
140  {
141  initialize();
142  }
143 
151  DAAL_DEPRECATED Batch(const Batch<algorithmFPType, method> &other) : super(other),
152  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
153  {
154  initialize();
155  }
156 
162  DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
163 
169  DAAL_DEPRECATED_VIRTUAL virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
170 
176  DAAL_DEPRECATED_VIRTUAL virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
177 
183  DAAL_DEPRECATED layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
184  {
185  return _result;
186  }
187 
193  DAAL_DEPRECATED ResultPtr getResult()
194  {
195  return _result;
196  }
197 
205  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
206  {
207  DAAL_CHECK(result, services::ErrorNullResult)
208  _result = result;
209  _res = _result.get();
210  return services::Status();
211  }
212 
220  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
221  {
222  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
223  }
224 
231  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
232  {
233  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
234  this->_res = this->_result.get();
235  return s;
236  }
237 
238 protected:
239  /*
240  * \DAAL_DEPRECATED
241  */
242  DAAL_DEPRECATED_VIRTUAL virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
243  {
244  return new Batch<algorithmFPType, method>(*this);
245  }
246 
247  /*
248  * \DAAL_DEPRECATED
249  */
250  DAAL_DEPRECATED void initialize()
251  {
252  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
253  _in = &input;
254  _par = &parameter;
255  _result.reset(new ResultType());
256  }
257 
258 private:
259  ResultPtr _result;
260  ParameterType _defaultParameter;
261 };
263 } // namespace interface1
264 using interface1::BatchContainer;
265 using interface1::Batch;
266 } // namespace backward
267 } // namespace lrn
268 } // namespace layers
269 } // namespace neural_networks
270 } // namespace algorithms
271 } // namespace daal
272 #endif
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: lrn_layer_backward.h:205
daal::batch
Definition: daal_defines.h:112
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::getLayerParameter
virtual DAAL_DEPRECATED_VIRTUAL ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: lrn_layer_backward.h:176
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(const Batch< algorithmFPType, method > &other)
Definition: lrn_layer_backward.h:151
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: lrn_layer_backward.h:220
daal::algorithms::neural_networks::layers::lrn::backward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: lrn_layer_backward.h:231
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::getResult
DAAL_DEPRECATED ResultPtr getResult()
Definition: lrn_layer_backward.h:193
daal::services::ErrorNullResult
Definition: error_indexes.h:98
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:55
daal_defines.h
daal::algorithms::neural_networks::layers::lrn::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward local response normalization layer Thi...
Definition: lrn_layer_backward.h:67
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(ParameterType &parameter)
Definition: lrn_layer_backward.h:139
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: lrn_layer_backward.h:121
daal::algorithms::neural_networks::layers::lrn::backward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch()
Definition: lrn_layer_backward.h:128
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::input
InputType input
Definition: lrn_layer_backward.h:122
daal::algorithms::neural_networks::layers::lrn::backward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::getMethod
DAAL_DEPRECATED_VIRTUAL int getMethod() const DAAL_C11_OVERRIDE
Definition: lrn_layer_backward.h:162
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::getLayerResult
DAAL_DEPRECATED layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: lrn_layer_backward.h:183
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::lrn::backward::interface1::Batch
Provides methods for the backward local response normalization layer in the batch processing mode...
Definition: lrn_layer_backward.h:112
daal::algorithms::neural_networks::layers::lrn::backward::interface1::Batch::getLayerInput
virtual DAAL_DEPRECATED_VIRTUAL InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: lrn_layer_backward.h:169

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