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