ie_memory_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  * @deprecated Use ngraph API instead.
16  * @brief The class represents a builder for Memory layer
17  */
18 IE_SUPPRESS_DEPRECATED_START
19 class INFERENCE_ENGINE_NN_BUILDER_API_CLASS(MemoryLayer): public LayerDecorator {
20 public:
21  /**
22  * @brief The constructor creates a builder with the name
23  * @param name Layer name
24  */
25  explicit MemoryLayer(const std::string& name = "");
26  /**
27  * @brief The constructor creates a builder from generic builder
28  * @param layer pointer to generic builder
29  */
30  explicit MemoryLayer(const Layer::Ptr& layer);
31  /**
32  * @brief The constructor creates a builder from generic builder
33  * @param layer constant pointer to generic builder
34  */
35  explicit MemoryLayer(const Layer::CPtr& layer);
36  /**
37  * @brief Sets the name for the layer
38  * @param name Layer name
39  * @return reference to layer builder
40  */
41  MemoryLayer& setName(const std::string& name);
42 
43  /**
44  * @brief Returns output port
45  * @return Output port
46  */
47  const Port& getOutputPort() const;
48  /**
49  * @brief Sets output port
50  * @param port Output port
51  * @return reference to layer builder
52  */
53  MemoryLayer& setOutputPort(const Port& port);
54  /**
55  * @brief Returns input port
56  * @return Input port
57  */
58  const Port& getInputPort() const;
59  /**
60  * @brief Sets input port
61  * @param port Input port
62  * @return reference to layer builder
63  */
64  MemoryLayer& setInputPort(const Port& port);
65  /**
66  * @brief Returns memory ID
67  * @return String with memory ID
68  */
69  const std::string getId() const;
70  /**
71  * @brief Sets memory ID
72  * @param id Memory ID
73  * @return reference to layer builder
74  */
75  MemoryLayer& setId(const std::string& id);
76  /**
77  * @brief Returns the index of memory layer
78  * @return Index
79  */
80  size_t getIndex() const;
81  /**
82  * @brief Sets the index of memory layer
83  * @param index Index equal 0 means this layer is output one.
84  * @return reference to layer builder
85  */
86  MemoryLayer& setIndex(size_t index);
87  /**
88  * @brief Returns size of the group
89  * @return Size of the group
90  */
91  size_t getSize() const;
92  /**
93  * @brief Sets size of the group
94  * @param size Size if size equals 2 means this group is a pair (only 2 is supported).
95  * @return reference to layer builder
96  */
97  MemoryLayer& setSize(size_t size);
98 };
99 IE_SUPPRESS_DEPRECATED_END
100 
101 } // namespace Builder
102 } // namespace InferenceEngine
InferenceEngine
Inference Engine API.
Definition: ie_argmax_layer.hpp:11