Compute Library
 22.05
ILayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2019 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_GRAPH_ILAYER_H
25 #define ARM_COMPUTE_GRAPH_ILAYER_H
26 
27 namespace arm_compute
28 {
29 namespace graph
30 {
31 namespace frontend
32 {
33 // Forward declarations
34 class IStream;
35 
36 /** ILayer interface */
37 class ILayer
38 {
39 public:
40  /** Default destructor */
41  virtual ~ILayer() = default;
42  /** Create layer and add to the given stream.
43  *
44  * @param[in] s Stream to add layer to.
45  *
46  * @return ID of the created node.
47  */
48  virtual NodeID create_layer(IStream &s) = 0;
49  /** Sets the name of the layer
50  *
51  * @param[in] name Name of the layer
52  *
53  * @return The layer object
54  */
55  ILayer &set_name(std::string name)
56  {
57  _name = name;
58  return *this;
59  }
60  /** Layer name accessor
61  *
62  * @return Returns the name of the layer
63  */
64  const std::string &name() const
65  {
66  return _name;
67  }
68 
69 private:
70  std::string _name = {};
71 };
72 } // namespace frontend
73 } // namespace graph
74 } // namespace arm_compute
75 #endif /* ARM_COMPUTE_GRAPH_ILAYER_H */
Copyright (c) 2017-2022 Arm Limited.
unsigned int NodeID
Definition: Types.h:69
virtual ~ILayer()=default
Default destructor.
const std::string & name() const
Layer name accessor.
Definition: ILayer.h:64
virtual NodeID create_layer(IStream &s)=0
Create layer and add to the given stream.
ILayer & set_name(std::string name)
Sets the name of the layer.
Definition: ILayer.h:55