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

lcn_layer_backward.h
1 /* file: lcn_layer_backward.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 backward local contrast normalization layer in the batch
19 // processing mode
20 //--
21 */
22 
23 #ifndef __NEURAL_NETWORK_LCN_LAYER_BACKWARD_H__
24 #define __NEURAL_NETWORK_LCN_LAYER_BACKWARD_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/lcn/lcn_layer_types.h"
31 #include "algorithms/neural_networks/layers/lcn/lcn_layer_backward_types.h"
32 
33 namespace daal
34 {
35 namespace algorithms
36 {
37 namespace neural_networks
38 {
39 namespace layers
40 {
41 namespace lcn
42 {
43 namespace backward
44 {
45 namespace interface1
46 {
62 template<typename algorithmFPType, Method method, CpuType cpu>
63 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
64 {
65 public:
71  BatchContainer(daal::services::Environment::env *daalEnv);
73  ~BatchContainer();
79  services::Status compute() DAAL_C11_OVERRIDE;
80  services::Status setupCompute() DAAL_C11_OVERRIDE;
81  services::Status resetCompute() DAAL_C11_OVERRIDE;
82 };
83 
99 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
100 class Batch : public layers::backward::LayerIfaceImpl
101 {
102 public:
103  typedef layers::backward::LayerIfaceImpl super;
104 
105  typedef algorithms::neural_networks::layers::lcn::backward::Input InputType;
106  typedef algorithms::neural_networks::layers::lcn::Parameter ParameterType;
107  typedef algorithms::neural_networks::layers::lcn::backward::Result ResultType;
108 
109  ParameterType &parameter;
110  InputType input;
113  Batch() : parameter(_defaultParameter)
114  {
115  initialize();
116  };
117 
123  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
124  {
125  initialize();
126  }
127 
133  Batch(const Batch<algorithmFPType, method> &other) : super(other),
134  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
135  {
136  initialize();
137  }
138 
143  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
144 
149  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
150 
155  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
156 
161  layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
162  {
163  return getResult();
164  }
165 
170  ResultPtr getResult()
171  {
172  return _result;
173  }
174 
181  services::Status setResult(const ResultPtr& result)
182  {
183  DAAL_CHECK(result, services::ErrorNullResult);
184  _result = result;
185  _res = _result.get();
186  return services::Status();
187  }
188 
194  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
195  {
196  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
197  }
198 
199  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
200  {
201  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
202  this->_res = this->_result.get();
203  return s;
204  }
205 
206 protected:
207  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
208  {
209  return new Batch<algorithmFPType, method>(*this);
210  }
211 
212  void initialize()
213  {
214  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
215  _in = &input;
216  _par = &parameter;
217  _result.reset(new ResultType());
218  }
219 
220 private:
221  ResultPtr _result;
222  ParameterType _defaultParameter;
223 };
225 } // namespace interface1
226 using interface1::BatchContainer;
227 using interface1::Batch;
228 } // namespace backward
229 } // namespace lcn
230 } // namespace layers
231 } // namespace neural_networks
232 } // namespace algorithms
233 } // namespace daal
234 #endif
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::getLayerResult
layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: lcn_layer_backward.h:161
daal::algorithms::neural_networks::layers::lcn::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward local contrast normalization layer Thi...
Definition: lcn_layer_backward.h:63
daal
Definition: algorithm_base_common.h:31
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:53
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: lcn_layer_backward.h:181
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::Batch
Batch()
Definition: lcn_layer_backward.h:113
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: lcn_layer_backward.h:143
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: lcn_layer_backward.h:133
daal_defines.h
daal::batch
Definition: daal_defines.h:110
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: lcn_layer_backward.h:123
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::input
InputType input
Definition: lcn_layer_backward.h:110
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch
Provides methods for backward local contrast normalization layer computations in the batch processing...
Definition: lcn_layer_backward.h:100
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: lcn_layer_backward.h:155
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: lcn_layer_backward.h:109
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: lcn_layer_backward.h:170
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::lcn::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: lcn_layer_backward.h:149
daal::algorithms::neural_networks::layers::lcn::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: lcn_layer_backward.h:194
daal::services::ErrorNullResult
Definition: error_indexes.h:96

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