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

layer_backward_types.h
1 /* file: layer_backward_types.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 neural_networks Network layer.
19 //--
20 */
21 
22 #ifndef __LAYERS__BACKWARD__TYPES__H__
23 #define __LAYERS__BACKWARD__TYPES__H__
24 
25 #include "algorithms/algorithm.h"
26 #include "data_management/data/tensor.h"
27 #include "services/daal_defines.h"
28 #include "services/collection.h"
29 #include "data_management/data/data_collection.h"
30 #include "algorithms/neural_networks/layers/layer_types.h"
31 #include "algorithms/neural_networks/layers/layer_forward_types.h"
32 
33 namespace daal
34 {
35 namespace algorithms
36 {
40 namespace neural_networks
41 {
45 namespace layers
46 {
56 namespace backward
57 {
62 enum InputId
63 {
64  inputGradient,
65  lastInputId = inputGradient
66 };
67 
72 enum InputLayerDataId
73 {
74  inputFromForward = lastInputId + 1,
75  lastInputLayerDataId = inputFromForward
76 };
77 
82 enum ResultId
83 {
84  gradient,
85  weightDerivatives,
86  biasDerivatives,
87  lastResultId = biasDerivatives
88 };
89 
94 enum ResultLayerDataId
95 {
96  resultLayerData = lastResultId + 1,
97  lastResultLayerDataId = resultLayerData
98 };
99 
103 namespace interface1
104 {
109 class DAAL_EXPORT InputIface : public daal::algorithms::Input
110 {
111 public:
115  InputIface(size_t nElements) : daal::algorithms::Input(nElements) {}
116  InputIface(const InputIface& other);
117  virtual ~InputIface() {}
118 };
119 
124 class DAAL_EXPORT Input : public InputIface
125 {
126 public:
128  Input();
129  Input(const Input& other);
130 
131  virtual ~Input() {}
132 
138  data_management::TensorPtr get(InputId id) const;
139 
145  LayerDataPtr get(InputLayerDataId id) const;
146 
152  void set(InputId id, const data_management::TensorPtr &ptr);
153 
159  void set(InputLayerDataId id, const LayerDataPtr &ptr);
160 
168  virtual services::Status addInputGradient(const data_management::TensorPtr &igTensor, size_t index);
169 
176  virtual services::Status setInputFromForward(forward::ResultPtr result);
177 
185  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
186 
191  virtual LayerInputLayout getLayout() const;
192 };
193 
198 class DAAL_EXPORT Result : public daal::algorithms::Result
199 {
200  DECLARE_SERIALIZABLE_IMPL();
201 public:
202  DAAL_CAST_OPERATOR(Result);
204  Result();
205 
206  virtual ~Result() {};
207 
216  template <typename algorithmFPType>
217  services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method)
218  {
219  return services::Status();
220  }
221 
227  data_management::TensorPtr get(ResultId id) const;
228 
234  void set(ResultId id, const data_management::TensorPtr &ptr);
235 
241  LayerDataPtr get(backward::ResultLayerDataId id) const;
242 
248  void set(ResultLayerDataId id, const LayerDataPtr &ptr);
249 
253  int getSerializationTag() const DAAL_C11_OVERRIDE { return SERIALIZATION_NEURAL_NETWORKS_LAYERS_BACKWARD_RESULT_ID; }
254 
263  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter,
264  int method) const DAAL_C11_OVERRIDE;
265 
270  virtual LayerResultLayout getLayout() const;
271 
277  virtual data_management::TensorPtr getGradient(size_t index) const;
278 protected:
280  template<typename Archive, bool onDeserialize>
281  services::Status serialImpl(Archive *arch)
282  {
283  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
284  }
285 };
286 typedef services::SharedPtr<Result> ResultPtr;
287 } // namespace interface1
288 using interface1::InputIface;
289 using interface1::Input;
290 using interface1::Result;
291 using interface1::ResultPtr;
292 } // backward
293 
295 } // namespace layer
296 } // namespace neural_networks
297 } // namespace algorithm
298 } // namespace daal
299 #endif
daal::algorithms::neural_networks::layers::backward::weightDerivatives
Definition: layer_backward_types.h:85
daal
Definition: algorithm_base_common.h:31
daal::algorithms::interface1::Result
Base class to represent final results of the computation. Algorithm-specific final results are repres...
Definition: algorithm_types.h:307
daal::algorithms::neural_networks::layers::backward::gradient
Definition: layer_backward_types.h:84
daal::algorithms::neural_networks::layers::backward::InputId
InputId
Definition: layer_backward_types.h:62
daal::algorithms::neural_networks::layers::backward::inputFromForward
Definition: layer_backward_types.h:74
daal::algorithms::neural_networks::layers::backward::biasDerivatives
Definition: layer_backward_types.h:86
daal_defines.h
daal::algorithms::neural_networks::layers::backward::InputLayerDataId
InputLayerDataId
Definition: layer_backward_types.h:72
daal::algorithms::neural_networks::layers::backward::interface1::Result::allocate
services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method)
Definition: layer_backward_types.h:217
daal::algorithms::neural_networks::layers::LayerInputLayout
LayerInputLayout
Definition: layer_types.h:57
daal::algorithms::neural_networks::layers::backward::ResultLayerDataId
ResultLayerDataId
Definition: layer_backward_types.h:94
daal::algorithms::neural_networks::layers::backward::interface1::InputIface
Abstract class that specifies interface of the input objects for the neural network layer algorithm...
Definition: layer_backward_types.h:109
daal::algorithms::neural_networks::layers::backward::inputGradient
Definition: layer_backward_types.h:64
daal::algorithms::neural_networks::layers::LayerResultLayout
LayerResultLayout
Definition: layer_types.h:68
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:198
daal::algorithms::neural_networks::layers::backward::ResultId
ResultId
Definition: layer_backward_types.h:82
daal::algorithms::neural_networks::layers::backward::interface1::InputIface::InputIface
InputIface(size_t nElements)
Constructor.
Definition: layer_backward_types.h:115
daal::algorithms::neural_networks::layers::backward::interface1::Result::getSerializationTag
int getSerializationTag() const DAAL_C11_OVERRIDE
Definition: layer_backward_types.h:253
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:191
daal::algorithms::neural_networks::layers::backward::interface1::Input
Input parameters for the layer algorithm
Definition: layer_backward_types.h:124

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