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

layer_forward_types.h
1 /* file: layer_forward_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__FORWARD__TYPES__H__
23 #define __LAYERS__FORWARD__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 
32 namespace daal
33 {
34 namespace algorithms
35 {
39 namespace neural_networks
40 {
44 namespace layers
45 {
55 namespace forward
56 {
61 enum InputId
62 {
63  data,
64  weights, /* Weights of the neural network layer */
65  biases, /* Biases of the neural network layer */
66  lastInputId = biases
67 };
68 
73 enum InputLayerDataId
74 {
75  inputLayerData = lastInputId + 1,
76  lastInputLayerDataId = inputLayerData
77 };
78 
83 enum ResultId
84 {
85  value,
86  lastResultId = value
87 };
88 
93 enum ResultLayerDataId
94 {
95  resultForBackward = lastResultId + 1,
96  lastResultLayerDataId = resultForBackward
97 };
98 
102 namespace interface1
103 {
108 class DAAL_EXPORT InputIface : public daal::algorithms::Input
109 {
110 public:
114  InputIface(size_t nElements) : daal::algorithms::Input(nElements) {}
115  InputIface(const InputIface& other);
116  virtual ~InputIface() {}
117 };
118 
123 class DAAL_EXPORT Input : public InputIface
124 {
125 public:
130  Input(size_t nElements = lastInputLayerDataId + 1);
131  Input(const Input& other);
132 
133  virtual ~Input() {}
134 
140  data_management::TensorPtr get(forward::InputId id) const;
141 
147  void set(InputId id, const data_management::TensorPtr &ptr);
148 
154  LayerDataPtr get(forward::InputLayerDataId id) const;
155 
161  void set(InputLayerDataId id, const LayerDataPtr &ptr);
162 
170  services::Status check(const daal::algorithms::Parameter *par, int method) const DAAL_C11_OVERRIDE;
171 
176  virtual LayerInputLayout getLayout();
177 
182  virtual const services::Collection<size_t> getWeightsSizes(const layers::Parameter *parameter) const;
183 
188  virtual const services::Collection<size_t> getBiasesSizes(const layers::Parameter *parameter) const;
189 
197  virtual services::Status addData(const data_management::TensorPtr &dataTensor, size_t index);
198 
204  virtual services::Status eraseInputData()
205  {
206  set(layers::forward::data, data_management::TensorPtr());
207  return services::Status();
208  }
209 };
210 
215 class DAAL_EXPORT Result : public daal::algorithms::Result
216 {
217  DECLARE_SERIALIZABLE_IMPL();
218 public:
219  DAAL_CAST_OPERATOR(Result);
221  Result();
222 
223  virtual ~Result() {};
224 
233  template <typename algorithmFPType>
234  services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method)
235  {
236  return services::Status();
237  }
238 
246  virtual const services::Collection<size_t> getValueSize(const services::Collection<size_t> &inputSize,
247  const daal::algorithms::Parameter *par, const int method) const = 0;
248 
256  virtual services::Collection<size_t> getValueSize(const services::Collection< services::Collection<size_t> > &inputSize,
257  const daal::algorithms::Parameter *par, const int method);
258 
266  virtual services::Collection< services::Collection<size_t> > getValueCollectionSize(const services::Collection<size_t> &inputSize,
267  const daal::algorithms::Parameter *par, const int method);
268 
274  data_management::TensorPtr get(ResultId id) const;
275 
281  LayerDataPtr get(ResultLayerDataId id) const;
282 
288  void set(ResultId id, const data_management::TensorPtr &ptr);
289 
295  void set(ResultLayerDataId id, const LayerDataPtr &ptr);
296 
300  int getSerializationTag() const DAAL_C11_OVERRIDE { return SERIALIZATION_NEURAL_NETWORKS_LAYERS_FORWARD_RESULT_ID; }
301 
310  virtual services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter,
311  int method) const DAAL_C11_OVERRIDE;
312 
317  virtual LayerResultLayout getLayout();
318 
325  virtual services::Status setResultForBackward(const daal::algorithms::Input *input)
326  {
327  return services::Status();
328  }
329 
335  virtual data_management::TensorPtr getValue(size_t index) const;
336 
337 protected:
339  template<typename Archive, bool onDeserialize>
340  services::Status serialImpl(Archive *arch)
341  {
342  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
343  }
344 };
345 typedef services::SharedPtr<Result> ResultPtr;
346 } // interface1
347 using interface1::InputIface;
348 using interface1::Input;
349 using interface1::Result;
350 using interface1::ResultPtr;
351 } // forward
353 } // namespace layer
354 } // namespace neural_networks
355 } // namespace algorithm
356 } // namespace daal
357 #endif
daal::algorithms::neural_networks::layers::forward::interface1::Result::allocate
services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *par, const int method)
Definition: layer_forward_types.h:234
daal::algorithms::neural_networks::layers::forward::InputId
InputId
Definition: layer_forward_types.h:61
daal::algorithms::neural_networks::layers::forward::ResultId
ResultId
Definition: layer_forward_types.h:83
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::forward::ResultLayerDataId
ResultLayerDataId
Definition: layer_forward_types.h:93
daal::algorithms::neural_networks::layers::forward::resultForBackward
Definition: layer_forward_types.h:95
daal_defines.h
daal::algorithms::neural_networks::layers::LayerInputLayout
LayerInputLayout
Definition: layer_types.h:57
daal::algorithms::neural_networks::layers::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_forward_types.h:215
daal::algorithms::neural_networks::layers::forward::interface1::Result::setResultForBackward
virtual services::Status setResultForBackward(const daal::algorithms::Input *input)
Definition: layer_forward_types.h:325
daal::algorithms::neural_networks::layers::forward::value
Definition: layer_forward_types.h:85
daal::algorithms::neural_networks::layers::forward::interface1::Input::eraseInputData
virtual services::Status eraseInputData()
Definition: layer_forward_types.h:204
daal::algorithms::neural_networks::layers::forward::data
Definition: layer_forward_types.h:63
daal::algorithms::neural_networks::layers::LayerResultLayout
LayerResultLayout
Definition: layer_types.h:68
daal::algorithms::neural_networks::layers::forward::interface1::InputIface
Abstract class that specifies interface of the input objects for the neural network layer algorithm...
Definition: layer_forward_types.h:108
daal::algorithms::neural_networks::layers::forward::interface1::Input
Input objects for layer algorithm
Definition: layer_forward_types.h:123
daal::algorithms::neural_networks::layers::forward::interface1::Result::getSerializationTag
int getSerializationTag() const DAAL_C11_OVERRIDE
Definition: layer_forward_types.h:300
daal::algorithms::neural_networks::layers::forward::interface1::InputIface::InputIface
InputIface(size_t nElements)
Constructor.
Definition: layer_forward_types.h:114
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::forward::InputLayerDataId
InputLayerDataId
Definition: layer_forward_types.h:73

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