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

batch_normalization_layer_forward_types.h
1 /* file: batch_normalization_layer_forward_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 the forward batch normalization layer.
45 //--
46 */
47 
48 #ifndef __BATCH_NORMALIZATION_LAYER_FORWARD_TYPES_H__
49 #define __BATCH_NORMALIZATION_LAYER_FORWARD_TYPES_H__
50 
51 #include "algorithms/algorithm.h"
52 #include "data_management/data/tensor.h"
53 #include "data_management/data/homogen_tensor.h"
54 #include "services/daal_defines.h"
55 #include "algorithms/neural_networks/layers/layer_forward_types.h"
56 #include "algorithms/neural_networks/layers/batch_normalization/batch_normalization_layer_types.h"
57 
58 namespace daal
59 {
60 namespace algorithms
61 {
62 namespace neural_networks
63 {
64 namespace layers
65 {
66 namespace batch_normalization
67 {
77 namespace forward
78 {
83 enum InputLayerDataId
84 {
85  populationMean = layers::forward::lastInputLayerDataId + 1,
86  populationVariance,
87  lastInputLayerDataId = populationVariance
88 };
89 
93 namespace interface1
94 {
99 class DAAL_EXPORT Input : public layers::forward::Input
100 {
101 public:
102  typedef layers::forward::Input super;
104  Input();
105 
107  Input(const Input& other);
108 
109  virtual ~Input() {}
110 
114  using layers::forward::Input::get;
118  using layers::forward::Input::set;
119 
120 
128  template <typename algorithmFPType>
129  DAAL_EXPORT services::Status allocate(const daal::algorithms::Parameter *parameter, const int method);
130 
135  virtual const services::Collection<size_t> getWeightsSizes(const layers::Parameter *parameter) const DAAL_C11_OVERRIDE;
136 
141  virtual const services::Collection<size_t> getBiasesSizes(const layers::Parameter *parameter) const DAAL_C11_OVERRIDE;
142 
148  data_management::TensorPtr get(InputLayerDataId id) const;
149 
155  void set(InputLayerDataId id, const data_management::TensorPtr &ptr);
156 
164  services::Status check(const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
165 };
166 
172 class DAAL_EXPORT Result : public layers::forward::Result
173 {
174 public:
175  DECLARE_SERIALIZABLE_CAST(Result);
177  Result();
178  virtual ~Result() {}
179 
180  using layers::forward::Result::get;
181  using layers::forward::Result::set;
182 
187  virtual const services::Collection<size_t> getValueSize(const services::Collection<size_t> &inputSize,
188  const daal::algorithms::Parameter *par, const int method) const DAAL_C11_OVERRIDE;
189 
198  template <typename algorithmFPType>
199  DAAL_EXPORT services::Status allocate(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, const int method);
200 
207  virtual services::Status setResultForBackward(const daal::algorithms::Input *input) DAAL_C11_OVERRIDE;
208 
214  data_management::TensorPtr get(LayerDataId id) const;
215 
221  void set(LayerDataId id, const data_management::TensorPtr &ptr);
222 
231  services::Status check(const daal::algorithms::Input *input, const daal::algorithms::Parameter *parameter, int method) const DAAL_C11_OVERRIDE;
232 
233 protected:
235  template<typename Archive, bool onDeserialize>
236  services::Status serialImpl(Archive *arch)
237  {
238  return daal::algorithms::Result::serialImpl<Archive, onDeserialize>(arch);
239  }
240 };
241 typedef services::SharedPtr<Result> ResultPtr;
242 
243 } // namespace interface1
244 using interface1::Input;
245 using interface1::Result;
246 using interface1::ResultPtr;
247 
248 } // namespace forward
249 
251 } // namespace batch_normalization
252 } // namespace layers
253 } // namespace neural_networks
254 } // namespace algorithm
255 } // namespace daal
256 
257 #endif
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the forward batch normali...
Definition: batch_normalization_layer_forward_types.h:172
daal::algorithms::neural_networks::layers::batch_normalization::forward::InputLayerDataId
InputLayerDataId
Definition: batch_normalization_layer_forward_types.h:83
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::interface1::Parameter
Definition: layer_types.h:110
daal::algorithms::neural_networks::layers::batch_normalization::forward::interface1::Input
Input objects for the forward batch normalization layer.
Definition: batch_normalization_layer_forward_types.h:99
daal::algorithms::neural_networks::layers::forward::interface1::Result::get
data_management::TensorPtr get(ResultId id) const
daal::algorithms::neural_networks::layers::batch_normalization::forward::populationMean
Definition: batch_normalization_layer_forward_types.h:85
daal_defines.h
daal::algorithms::neural_networks::layers::forward::interface1::Result::set
void set(ResultId id, const data_management::TensorPtr &ptr)
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::forward::interface1::Result
Provides methods to access the result obtained with the compute() method of the layer algorithm...
Definition: layer_forward_types.h:241
daal::algorithms::neural_networks::layers::forward::interface1::Input::set
void set(InputId id, const data_management::TensorPtr &ptr)
daal::algorithms::neural_networks::layers::forward::interface1::Input::get
data_management::TensorPtr get(forward::InputId id) const
daal::algorithms::neural_networks::layers::batch_normalization::LayerDataId
LayerDataId
Identifiers of input objects for the backward batch normalization layer and results for the forward b...
Definition: batch_normalization_layer_types.h:86
daal::algorithms::neural_networks::layers::forward::interface1::Input
Input objects for layer algorithm
Definition: layer_forward_types.h:149
daal::algorithms::neural_networks::layers::batch_normalization::forward::populationVariance
Definition: batch_normalization_layer_forward_types.h:86
daal::algorithms::interface1::Input
Base class to represent computation input arguments. Algorithm-specific input arguments are represent...
Definition: algorithm_types.h:217
daal::services::interface1::Collection
Class that implements functionality of the Collection container.
Definition: collection.h:69

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