xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/nodes/PrintLayerNode.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2020 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_PRINT_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_PRINT_LAYER_NODE_H
26 
27 #include "arm_compute/graph/INode.h"
28 
29 namespace arm_compute
30 {
31 // Forward declarations
32 class ITensor;
33 
34 namespace graph
35 {
36 /** Print Layer node */
37 class PrintLayerNode final : public INode
38 {
39 public:
40     /** Constructor
41      *
42      * @param[in] stream      Output stream.
43      * @param[in] format_info (Optional) Format info.
44      * @param[in] transform   (Optional) Input transform function.
45      */
46     PrintLayerNode(std::ostream &stream, const IOFormatInfo &format_info = IOFormatInfo(), const std::function<ITensor *(ITensor *)> transform = nullptr);
47 
48     /** Stream metadata accessor
49      *
50      * @return Print Layer stream
51      */
52     std::ostream &stream() const;
53 
54     /** Formatting metadata accessor
55      *
56      * @return Print Layer format info
57      */
58     const IOFormatInfo format_info() const;
59 
60     /** Transform function metadata accessor
61      *
62      * @return Print Layer transform function
63      */
64     const std::function<ITensor *(ITensor *)> transform() const;
65 
66     // Inherited overridden methods:
67     NodeType         type() const override;
68     bool             forward_descriptors() override;
69     TensorDescriptor configure_output(size_t idx) const override;
70     void accept(INodeVisitor &v) override;
71 
72 private:
73     std::ostream                             &_stream;
74     const IOFormatInfo                        _format_info;
75     const std::function<ITensor *(ITensor *)> _transform;
76 };
77 } // namespace graph
78 } // namespace arm_compute
79 #endif /* ARM_COMPUTE_GRAPH_PRINT_LAYER_NODE_H */
80