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

eltwise_sum_layer_backward_types.h
1 /* file: eltwise_sum_layer_backward_types.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 backward element-wise sum layer.
45 //--
46 */
47 
48 #ifndef __ELTWISE_SUM_LAYER_BACKWARD_TYPES_H__
49 #define __ELTWISE_SUM_LAYER_BACKWARD_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "services/daal_defines.h"
53 
54 #include "data_management/data/tensor.h"
55 
56 #include "algorithms/neural_networks/layers/layer_backward_types.h"
57 #include "algorithms/neural_networks/layers/eltwise_sum/eltwise_sum_layer_types.h"
58 
59 namespace daal
60 {
61 namespace algorithms
62 {
63 namespace neural_networks
64 {
65 namespace layers
66 {
67 namespace eltwise_sum
68 {
78 namespace backward
79 {
83 namespace interface1
84 {
85 
90 class DAAL_EXPORT Input : public layers::backward::Input
91 {
92 public:
93  typedef layers::backward::Input super;
97  Input();
98 
100  Input(const Input& other);
101 
102  virtual ~Input() {}
103 
107  using layers::backward::Input::get;
108 
112  using layers::backward::Input::set;
113 
119  data_management::TensorPtr get(LayerDataId id) const;
120 
126  data_management::NumericTablePtr get(LayerDataNumericTableId id) const;
127 
133  void set(LayerDataId id, const data_management::TensorPtr &value);
134 
140  void set(LayerDataNumericTableId id, const data_management::NumericTablePtr &value);
141 
149  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
150 
156  size_t getNumberOfCoefficients() const;
157 
158 private:
159  size_t getNumberOfAuxCoefficientsFromTable() const;
160 
161  services::Status checkInputGradient() const;
162  services::Status checkAuxCoefficients() const;
163  services::Status checkAuxNumberOfCoefficients() const;
164 };
165 
170 class DAAL_EXPORT Result : public layers::backward::Result
171 {
172 public:
173  DECLARE_SERIALIZABLE_CAST(Result);
174 
178  Result();
179 
180  virtual ~Result() {}
181 
185  using layers::backward::Result::get;
186 
190  using layers::backward::Result::set;
191 
198  data_management::TensorPtr get(layers::backward::ResultLayerDataId id, size_t index) const;
199 
206  void set(layers::backward::ResultLayerDataId id, const data_management::TensorPtr &value, size_t index);
207 
213  virtual data_management::TensorPtr getGradient(size_t index) const DAAL_C11_OVERRIDE;
214 
223  template <typename algorithmFPType>
224  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input,
225  const daal::algorithms::Parameter *parameter, const int method);
226 
235  services::Status check(const daal::algorithms::Input *input,
236  const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
237 
242  virtual LayerResultLayout getLayout() const DAAL_C11_OVERRIDE;
243 
244 protected:
246  template<typename Archive, bool onDeserialize>
247  services::Status serialImpl(Archive *arch)
248  {
249  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
250  }
251 
252 private:
253  template<typename algorithmFPType>
254  services::Status allocateNewOutputTensors(const data_management::TensorPtr &inputGradient, size_t nOutputs);
255 
256  LayerDataPtr getResultLayerDataAllocateIfEmpty();
257 
258  void useInputGradientTensorAsOutput(const data_management::TensorPtr &inputGradient, size_t nOutputs);
259 
260  services::Status checkResultLayerData(const Input *input) const;
261  services::Status checkOutputGradients(const Input *input) const;
262 };
263 
264 typedef services::SharedPtr<Result> ResultPtr;
265 } // namespace interface1
266 
267 using interface1::Input;
268 using interface1::Result;
269 using interface1::ResultPtr;
270 
271 } // namespace backward
273 } // namespace eltwise_sum
274 } // namespace layers
275 } // namespace neural_networks
276 } // namespace algorithms
277 } // namespace daal
278 #endif
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::neural_networks::layers::eltwise_sum::LayerDataNumericTableId
LayerDataNumericTableId
Available identifiers of input numeric tables for the backward element-wise sum layer and identifiers...
Definition: eltwise_sum_layer_types.h:98
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::backward::interface1::Result::get
data_management::TensorPtr get(ResultId id) const
daal::algorithms::neural_networks::layers::LayerResultLayout
LayerResultLayout
Definition: layer_types.h:94
daal::algorithms::neural_networks::layers::backward::ResultLayerDataId
ResultLayerDataId
Definition: layer_backward_types.h:120
daal_defines.h
daal::algorithms::neural_networks::layers::eltwise_sum::LayerDataId
LayerDataId
Available identifiers of input tensors for the backward element-wise sum layer and identifiers of res...
Definition: eltwise_sum_layer_types.h:87
daal::algorithms::interface1::Parameter
Base class to represent computation parameters. Algorithm-specific parameters are represented as deri...
Definition: algorithm_types.h:86
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::backward::interface1::Input::set
void set(InputId id, const data_management::TensorPtr &ptr)
daal::algorithms::neural_networks::layers::backward::interface1::Input::get
data_management::TensorPtr get(InputId id) const
daal::algorithms::math::abs::value
Definition: abs_types.h:112
daal::algorithms::neural_networks::layers::backward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_backward_types.h:224
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::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::algorithms::neural_networks::layers::backward::interface1::Input
Input parameters for the layer algorithm
Definition: layer_backward_types.h:150
daal::algorithms::neural_networks::layers::backward::interface1::Result::set
void set(ResultId id, const data_management::TensorPtr &ptr)

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