C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

eltwise_sum_layer_backward.h
1 /* file: eltwise_sum_layer_backward.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the interface for the backward element-wise sum layer
45 // in the batch processing mode
46 //--
47 */
48 
49 #ifndef __ELTWISE_SUM_LAYER_BACKWARD_H__
50 #define __ELTWISE_SUM_LAYER_BACKWARD_H__
51 
52 #include "algorithms/algorithm.h"
53 #include "services/daal_defines.h"
54 
55 #include "data_management/data/tensor.h"
56 
57 #include "algorithms/neural_networks/layers/layer.h"
58 #include "algorithms/neural_networks/layers/eltwise_sum/eltwise_sum_layer_types.h"
59 #include "algorithms/neural_networks/layers/eltwise_sum/eltwise_sum_layer_backward_types.h"
60 
61 namespace daal
62 {
63 namespace algorithms
64 {
65 namespace neural_networks
66 {
67 namespace layers
68 {
69 namespace eltwise_sum
70 {
71 namespace backward
72 {
73 namespace interface1
74 {
90 template<typename algorithmFPType, Method method, CpuType cpu>
91 class DAAL_EXPORT BatchContainer : public AnalysisContainerIface<batch>
92 {
93 public:
99  BatchContainer(daal::services::Environment::env *daalEnv);
101  ~BatchContainer();
107  services::Status compute() DAAL_C11_OVERRIDE;
108 };
109 
125 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
126 class Batch : public layers::backward::LayerIfaceImpl
127 {
128 public:
129  typedef layers::backward::LayerIfaceImpl super;
130 
131  typedef algorithms::neural_networks::layers::eltwise_sum::backward::Input InputType;
132  typedef algorithms::neural_networks::layers::eltwise_sum::Parameter ParameterType;
133  typedef algorithms::neural_networks::layers::eltwise_sum::backward::Result ResultType;
134 
135  ParameterType &parameter;
136  InputType input;
141  Batch() : parameter(_defaultParameter)
142  {
143  initialize();
144  };
145 
151  Batch(ParameterType& parameter) : parameter(parameter), _defaultParameter(parameter)
152  {
153  initialize();
154  }
155 
161  Batch(const Batch<algorithmFPType, method> &other) : super(other),
162  _defaultParameter(other.parameter), parameter(_defaultParameter), input(other.input)
163  {
164  initialize();
165  }
166 
171  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int) method; }
172 
177  virtual InputType *getLayerInput() DAAL_C11_OVERRIDE { return &input; }
178 
183  virtual ParameterType *getLayerParameter() DAAL_C11_OVERRIDE { return &parameter; };
184 
189  virtual layers::backward::ResultPtr getLayerResult() DAAL_C11_OVERRIDE
190  {
191  return getResult();
192  }
193 
198  ResultPtr getResult()
199  {
200  return _result;
201  }
202 
209  services::Status setResult(const ResultPtr& result)
210  {
211  DAAL_CHECK(result, services::ErrorNullResult)
212  _result = result;
213  _res = _result.get();
214  return services::Status();
215  }
216 
222  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
223  {
224  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
225  }
226 
232  virtual services::Status allocateResult() DAAL_C11_OVERRIDE
233  {
234  services::Status s = this->_result->template allocate<algorithmFPType>(&(this->input), &parameter, (int) method);
235  this->_res = this->_result.get();
236  return s;
237  }
238 
239 protected:
240  virtual Batch<algorithmFPType, method> *cloneImpl() const DAAL_C11_OVERRIDE
241  {
242  return new Batch<algorithmFPType, method>(*this);
243  }
244 
245  void initialize()
246  {
247  Analysis<batch>::_ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
248  _in = &input;
249  _par = &parameter;
250  _result.reset(new ResultType());
251  }
252 
253 private:
254  ResultPtr _result;
255  ParameterType _defaultParameter;
256 };
258 } // namespace interface1
259 using interface1::BatchContainer;
260 using interface1::Batch;
261 } // namespace backward
262 } // namespace eltwise_sum
263 } // namespace layers
264 } // namespace neural_networks
265 } // namespace algorithms
266 } // namespace daal
267 #endif
daal::algorithms::neural_networks::layers::backward::interface1::LayerIfaceImpl
Implements the abstract interface LayerIface. LayerIfaceImpl is, in turn, the base class for the clas...
Definition: layer_backward.h:153
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:171
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:91
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::algorithms::AnalysisContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the analy...
Definition: analysis.h:79
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Result
Results obtained with the compute() method of the backward element-wise sum layer.
Definition: eltwise_sum_layer_backward_types.h:170
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: eltwise_sum_layer_backward.h:222
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: eltwise_sum_layer_backward.h:161
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::input
InputType input
Definition: eltwise_sum_layer_backward.h:136
daal_defines.h
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::Batch
Batch()
Definition: eltwise_sum_layer_backward.h:141
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::parameter
ParameterType & parameter
Definition: eltwise_sum_layer_backward.h:135
daal::batch
Definition: daal_defines.h:132
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::getLayerParameter
virtual ParameterType * getLayerParameter() DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:183
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::Batch
Batch(ParameterType &parameter)
Definition: eltwise_sum_layer_backward.h:151
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::getResult
ResultPtr getResult()
Definition: eltwise_sum_layer_backward.h:198
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::neural_networks::layers::eltwise_sum::interface1::Parameter
Parameters for the element-wise sum layer.
Definition: eltwise_sum_layer_types.h:114
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::allocateResult
virtual services::Status allocateResult() DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:232
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::setResult
services::Status setResult(const ResultPtr &result)
Definition: eltwise_sum_layer_backward.h:209
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:126
daal::algorithms::Analysis
Provides methods for execution of operations over data, such as computation of Summary Statistics est...
Definition: analysis.h:94
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Batch::getLayerInput
virtual InputType * getLayerInput() DAAL_C11_OVERRIDE
Definition: eltwise_sum_layer_backward.h:177
daal::algorithms::neural_networks::layers::eltwise_sum::backward::interface1::Input
Input objects for the backward element-wise sum layer
Definition: eltwise_sum_layer_backward_types.h:90
daal::services::ErrorNullResult
Definition: error_indexes.h:122

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