ie_norm_layer.hpp
1 // Copyright (C) 2018-2019 Intel Corporation
2 // SPDX-License-Identifier: Apache-2.0
3 //
4 
5 #pragma once
6 
7 #include <builders/ie_layer_decorator.hpp>
8 #include <ie_network.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 LayerDecorator {
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 layer pointer to generic builder
34  */
35  explicit NormLayer(const Layer::Ptr& layer);
36  /**
37  * @brief The constructor creates a builder from generic builder
38  * @param layer constant pointer to generic builder
39  */
40  explicit NormLayer(const Layer::CPtr& layer);
41  /**
42  * @brief Sets the name for the layer
43  * @param name Layer name
44  * @return reference to layer builder
45  */
46  NormLayer& setName(const std::string& name);
47 
48  /**
49  * @brief Returns port with shapes for the layer
50  * @return Port with shapes
51  */
52  const Port& getPort() const;
53  /**
54  * @brief Sets port shapes for the layer
55  * @param port Port with shapes
56  * @return reference to layer builder
57  */
58  NormLayer& setPort(const Port& port);
59  /**
60  * @brief Returns side length of the region
61  * @return Size
62  */
63  size_t getSize() const;
64  /**
65  * @brief Sets side length of the region
66  * @param size Size
67  * @return reference to layer builder
68  */
69  NormLayer& setSize(size_t size);
70  /**
71  * @brief Returns scaling parameter for the normalizing sum
72  * @return Scaling parameter
73  */
74  float getAlpha() const;
75  /**
76  * @brief Sets scaling parameter for the normalizing sum
77  * @param alpha Scaling parameter
78  * @return reference to layer builder
79  */
80  NormLayer& setAlpha(float alpha);
81  /**
82  * @brief Returns exponent for the normalizing sum
83  * @return Exponent
84  */
85  float getBeta() const;
86  /**
87  * @brief Sets exponent for the normalizing sum
88  * @param beta Exponent
89  * @return reference to layer builder
90  */
91  NormLayer& setBeta(float beta);
92  /**
93  * @brief Returns region type
94  * @return true if normalizing sum is performed over adjacent channels
95  */
96  bool getAcrossMaps() const;
97  /**
98  * @brief Sets region type
99  * @param acrossMap true if normalizing sum is performed over adjacent channels
100  * @return reference to layer builder
101  */
102  NormLayer& setAcrossMaps(bool acrossMap);
103  /**
104  * @brief Returns region type
105  * @return Norm type
106  */
107  NormType getRegion() const;
108  /**
109  * @brief Sets region type
110  * @param type region type
111  * @return reference to layer builder
112  */
113  NormLayer& setRegion(NormType type);
114 };
115 
116 } // namespace Builder
117 } // namespace InferenceEngine
InferenceEngine
Definition: ie_argmax_layer.hpp:11