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

eltwise_sum_layer_backward.h
1 /* file: eltwise_sum_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 element-wise sum layer
21 // in the batch processing mode
22 //--
23 */
24 
25 #ifndef __ELTWISE_SUM_LAYER_BACKWARD_H__
26 #define __ELTWISE_SUM_LAYER_BACKWARD_H__
27 
28 #include "algorithms/algorithm.h"
29 #include "services/daal_defines.h"
30 
31 #include "data_management/data/tensor.h"
32 
33 #include "algorithms/neural_networks/layers/layer.h"
34 #include "algorithms/neural_networks/layers/eltwise_sum/eltwise_sum_layer_types.h"
35 #include "algorithms/neural_networks/layers/eltwise_sum/eltwise_sum_layer_backward_types.h"
36 
37 namespace daal
38 {
39 namespace algorithms
40 {
41 namespace neural_networks
42 {
43 namespace layers
44 {
45 namespace eltwise_sum
46 {
47 namespace backward
48 {
49 namespace interface1
50 {
68 template<typename algorithmFPType, Method method, CpuType cpu>
69 class BatchContainer : public AnalysisContainerIface<batch>
70 {
71 public:
78  DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv);
83  DAAL_DEPRECATED ~BatchContainer();
90  DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE;
91 };
92 
110 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
111 class Batch : public layers::backward::LayerIfaceImpl
112 {
113 public:
114  typedef layers::backward::LayerIfaceImpl super;
115 
116  typedef algorithms::neural_networks::layers::eltwise_sum::backward::Input InputType;
117  typedef algorithms::neural_networks::layers::eltwise_sum::Parameter ParameterType;
118  typedef algorithms::neural_networks::layers::eltwise_sum::backward::Result ResultType;
119 
120  ParameterType &parameter;
121  InputType input;
127  DAAL_DEPRECATED Batch() : parameter(_defaultParameter)
128  {
129  initialize();
130  };
131 
138  DAAL_DEPRECATED Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
139  {
140  initialize();
141  }
142 
149  Batch(const Batch<algorithmFPType, method> &other) : super(other),
150  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
151  {
152  initialize();
153  }
154 
160  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
161 
167  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
168 
174  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
175 
181  virtual layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
182  {
183  return getResult();
184  }
185 
191  ResultPtr getResult()
192  {
193  return _result;
194  }
195 
203  DAAL_DEPRECATED services::Status setResult(const ResultPtr& result)
204  {
205  DAAL_CHECK(result, services::ErrorNullResult)
206  _result = result;
207  _res = _result.get();
208  return services::Status();
209  }
210 
217  DAAL_DEPRECATED services::SharedPtr<Batch<algorithmFPType, method> > clone() const
218  {
219  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
220  }
221 
228  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
229  {
230  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
231  this->_res = this->_result.get();
232  return s;
233  }
234 
235 protected:
236  /*
237  * \DAAL_DEPRECATED
238  */
239  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
240  {
241  return new Batch<algorithmFPType, method>(*this);
242  }
243 
244  /*
245  * \DAAL_DEPRECATED
246  */
247  void initialize()
248  {
249  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
250  _in = &input;
251  _par = &parameter;
252  _result.reset(new ResultType());
253  }
254 
255 private:
256  ResultPtr _result;
257  ParameterType _defaultParameter;
258 };
260 } // namespace interface1
261 using interface1::BatchContainer;
262 using interface1::Batch;
263 } // namespace backward
264 } // namespace eltwise_sum
265 } // namespace layers
266 } // namespace neural_networks
267 } // namespace algorithms
268 } // namespace daal
269 #endif
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::BatchContainer::~BatchContainer
DAAL_DEPRECATED ~BatchContainer()
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch()
Definition: eltwise_sum_layer_backward.h:127
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::BatchContainer::compute
DAAL_DEPRECATED services::Status compute() DAAL_C11_OVERRIDE
daal::batch
Definition: daal_defines.h:112
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::getLayerResult
virtual layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:181
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:160
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::input
InputType input
Definition: eltwise_sum_layer_backward.h:121
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::clone
DAAL_DEPRECATED services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: eltwise_sum_layer_backward.h:217
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::BatchContainer::BatchContainer
DAAL_DEPRECATED BatchContainer(daal::services::Environment::env *daalEnv)
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:167
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: eltwise_sum_layer_backward.h:191
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: eltwise_sum_layer_backward.h:120
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch
Provides methods for backward element-wise sum layer computations in the batch processing mode...
Definition: eltwise_sum_layer_backward.h:111
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::eltwise_sum::backward::interface1::BatchContainer
Provides methods to run implementations of the of the backward element-wise sum layer This class is a...
Definition: eltwise_sum_layer_backward.h:69
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:228
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: eltwise_sum_layer_backward.h:149
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::Batch
DAAL_DEPRECATED Batch(ParameterType &parameter)
Definition: eltwise_sum_layer_backward.h:138
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::setResult
DAAL_DEPRECATED services::Status setResult(const ResultPtr &result)
Definition: eltwise_sum_layer_backward.h:203
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::eltwise_sum::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:174

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