ie_norm_layer.hpp
1 // Copyright (C) 2018 Intel Corporation
2 // SPDX-License-Identifier: Apache-2.0
3 //
4 
5 #pragma once
6 
7 #include <builders/ie_layer_fragment.hpp>
8 #include <ie_inetwork.hpp>
9 #include <string>
10 
11 namespace InferenceEngine {
12 namespace Builder {
13 
14 /**
15  * @brief The class represents a builder for Norm layer
16  */
17 class INFERENCE_ENGINE_API_CLASS(NormLayer): public LayerFragment {
18 public:
19  /**
20  * @brief The enum defines all Norm types
21  */
22  enum NormType {
23  WITHIN_CHANNEL = 0,
24  ACROSS_CHANNELS = 1
25  };
26  /**
27  * @brief The constructor creates a builder with the name
28  * @param name Layer name
29  */
30  explicit NormLayer(const std::string& name = "");
31  /**
32  * @brief The constructor creates a builder from generic builder
33  * @param genLayer generic builder
34  */
35  explicit NormLayer(Layer& genLayer);
36  /**
37  * @brief Sets the name for the layer
38  * @param name Layer name
39  * @return reference to layer builder
40  */
41  NormLayer& setName(const std::string& name);
42 
43  /**
44  * @brief Returns port with shapes for the layer
45  * @return Port with shapes
46  */
47  const Port& getPort() const;
48  /**
49  * @brief Sets port shapes for the layer
50  * @param port Port with shapes
51  * @return reference to layer builder
52  */
53  NormLayer& setPort(const Port& port);
54  /**
55  * @brief Returns side length of the region
56  * @return Size
57  */
58  size_t getSize() const;
59  /**
60  * @brief Sets side length of the region
61  * @param size Size
62  * @return reference to layer builder
63  */
64  NormLayer& setSize(size_t size);
65  /**
66  * @brief Returns scaling parameter for the normalizing sum
67  * @return Scaling parameter
68  */
69  float getAlpha() const;
70  /**
71  * @brief Sets scaling parameter for the normalizing sum
72  * @param alpha Scaling parameter
73  * @return reference to layer builder
74  */
75  NormLayer& setAlpha(float alpha);
76  /**
77  * @brief Returns exponent for the normalizing sum
78  * @return Exponent
79  */
80  float getBeta() const;
81  /**
82  * @brief Sets exponent for the normalizing sum
83  * @param beta Exponent
84  * @return reference to layer builder
85  */
86  NormLayer& setBeta(float beta);
87  /**
88  * @brief Returns region type
89  * @return true if normalizing sum is performed over adjacent channels
90  */
91  bool getAcrossMaps() const;
92  /**
93  * @brief Sets region type
94  * @param acrossMap true if normalizing sum is performed over adjacent channels
95  * @return reference to layer builder
96  */
97  NormLayer& setAcrossMaps(bool acrossMap);
98  /**
99  * @brief Returns region type
100  * @return Norm type
101  */
102  NormType getRegion() const;
103  /**
104  * @brief Sets region type
105  * @param type region type
106  * @return reference to layer builder
107  */
108  NormLayer& setRegion(NormType type);
109 };
110 
111 } // namespace Builder
112 } // namespace InferenceEngine
InferenceEngine
Definition: ie_argmax_layer.hpp:11
ie_inetwork.hpp
a header file for the Inference Engine Network interface