ie_pooling_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 <vector>
10 #include <string>
11 
12 namespace InferenceEngine {
13 namespace Builder {
14 
15 /**
16  * @brief The class represents a builder for Pooling layer
17  */
18 class INFERENCE_ENGINE_API_CLASS(PoolingLayer): public LayerFragment {
19 public:
20  /**
21  * @brief The enum defines available pooling types
22  */
23  enum PoolingType {
24  MAX = 1,
25  AVG = 2
26  };
27 
28  /**
29  * @brief The enum defines available rounding types
30  */
31  enum RoundingType {
32  CEIL = 1,
33  FLOOR = 2
34  };
35 
36  /**
37  * @brief The constructor creates a builder with the name
38  * @param name Layer name
39  */
40  explicit PoolingLayer(const std::string& name = "");
41  /**
42  * @brief The constructor creates a builder from generic builder
43  * @param genLayer generic builder
44  */
45  explicit PoolingLayer(Layer& genLayer);
46  /**
47  * @brief Operator creates generic layer builder
48  * @return Generic layer builder
49  */
50  operator Layer() const override;
51  /**
52  * @brief Sets the name for the layer
53  * @param name Layer name
54  * @return reference to layer builder
55  */
56  PoolingLayer& setName(const std::string& name);
57 
58  /**
59  * @brief Returns input port
60  * @return Input port
61  */
62  const Port& getInputPort() const;
63  /**
64  * @brief Sets input port
65  * @param port Input port
66  * @return reference to layer builder
67  */
68  PoolingLayer& setInputPort(const Port& port);
69  /**
70  * @brief Returns output port
71  * @return Output port
72  */
73  const Port& getOutputPort() const;
74  /**
75  * @brief Sets output port
76  * @param port Output port
77  * @return reference to layer builder
78  */
79  PoolingLayer& setOutputPort(const Port& port);
80  /**
81  * @brief Returns kernel size
82  * @return Kernel size
83  */
84  const std::vector<size_t> getKernel() const;
85  /**
86  * @brief Sets kernel size
87  * @param kernel Kernel size
88  * @return reference to layer builder
89  */
90  PoolingLayer& setKernel(const std::vector<size_t>& kernel);
91  /**
92  * @brief Returns vector of strides
93  * @return vector of strides
94  */
95  const std::vector<size_t> getStrides() const;
96  /**
97  * @brief Sets strides
98  * @param strides vector of strides
99  * @return reference to layer builder
100  */
101  PoolingLayer& setStrides(const std::vector<size_t>& strides);
102  /**
103  * @brief Returns begin paddings
104  * @return vector of paddings
105  */
106  const std::vector<size_t> getPaddingsBegin() const;
107  /**
108  * @brief Sets begin paddings
109  * @param paddings Vector of paddings
110  * @return reference to layer builder
111  */
112  PoolingLayer& setPaddingsBegin(const std::vector<size_t>& paddings);
113  /**
114  * @brief Return end paddings
115  * @return Vector of paddings
116  */
117  const std::vector<size_t> getPaddingsEnd() const;
118  /**
119  * @brief Sets end paddings
120  * @param paddings Vector of paddings
121  * @return reference to layer builder
122  */
123  PoolingLayer& setPaddingsEnd(const std::vector<size_t>& paddings);
124  /**
125  * @brief Returns pooling type
126  * @return Pooling type
127  */
128  PoolingType getPoolingType() const;
129  /**
130  * @brief Sets pooling type
131  * @param type Pooling type
132  * @return reference to layer builder
133  */
134  PoolingLayer& setPoolingType(PoolingType type);
135  /**
136  * @brief Returns rounding type
137  * @return Rounding type
138  */
139  RoundingType getRoundingType() const;
140  /**
141  * @brief Sets rounding types
142  * @param type Rounding type
143  * @return reference to layer builder
144  */
145  PoolingLayer& setRoundingType(RoundingType type);
146  /**
147  * @brief Returns a type of pooling strategy
148  * @return true if zero-values in the padding are not used
149  */
150  bool getExcludePad() const;
151  /**
152  * @brief Sets a type of pooling strategy
153  * @param exclude zero-values in the padding are not used if true
154  * @return reference to layer builder
155  */
156  PoolingLayer& setExcludePad(bool exclude);
157 
158  /**
159  * @brief Validates layer before creation
160  * @param layer generic layer builder
161  */
162  static void validate(const Layer& layer);
163 
164 private:
165  PoolingType type;
166  RoundingType roundingType;
167 };
168 
169 } // namespace Builder
170 } // namespace InferenceEngine
InferenceEngine
Definition: ie_argmax_layer.hpp:11
ie_inetwork.hpp
a header file for the Inference Engine Network interface