xref: /aosp_15_r20/external/armnn/src/armnn/layers/OutputLayer.hpp (revision 89c4ff92f2867872bb9e2354d150bf0c8c502810)
1 //
2 // Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
7 #include <Layer.hpp>
8 
9 namespace armnn
10 {
11 
12 /// A layer user-provided data can be bound to (e.g. inputs, outputs).
13 class OutputLayer : public BindableLayer
14 {
15 public:
16     /// Returns nullptr for Output type.
17     /// @param [in] graph The graph where this layer can be found.
18     /// @param [in] factory The workload factory which will create the workload.
19     /// @return A pointer to the created workload, or nullptr if not created.
20     virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
21 
22     /// Set the outputs to be appropriate sub tensors of the input if sub tensors are supported
23     /// otherwise creates tensor handlers by default. Ignores parameters for Output type.
24     /// @param [in] registry Contains all the registered tensor handle factories available for use.
25     /// @param [in] factory The workload factory which will create the workload.
26     /// @param [in] IsMemoryManaged Determine whether or not to assign a memory manager during creation
CreateTensorHandles(const TensorHandleFactoryRegistry & registry,const IWorkloadFactory & factory,const bool isMemoryManaged=true)27     virtual void CreateTensorHandles(const TensorHandleFactoryRegistry& registry,
28                                      const IWorkloadFactory& factory,
29                                      const bool isMemoryManaged = true) override
30     {
31         IgnoreUnused(registry, factory, isMemoryManaged);
32     }
33 
34     /// Creates a dynamically-allocated copy of this layer.
35     /// @param [in] graph The graph into which this layer is being cloned.
36     OutputLayer* Clone(Graph& graph) const override;
37 
38     /// Check if the input tensor shape(s)
39     /// will lead to a valid configuration of @ref OutputLayer.
40     /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
41     void ValidateTensorShapesFromInputs() override;
42 
43     void ExecuteStrategy(IStrategy& strategy) const override;
44 
45 
46 protected:
47     /// Constructor to create an OutputLayer.
48     /// @param id The layer binding id number.
49     /// @param name Optional name for the layer.
50     OutputLayer(LayerBindingId id, const char* name);
51 
52     /// Default destructor
53     ~OutputLayer() = default;
54 };
55 
56 } // namespace
57