xref: /aosp_15_r20/external/armnn/src/armnn/layers/ConstantLayer.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 class ScopedTensorHandle;
13 
14 /// A layer that the constant data can be bound to.
15 class ConstantLayer : public Layer
16 {
17 public:
18     /// Makes a workload for the Constant type.
19     /// @param [in] graph The graph where this layer can be found.
20     /// @param [in] factory The workload factory which will create the workload.
21     /// @return A pointer to the created workload, or nullptr if not created.
22     virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
23 
24     /// Creates a dynamically-allocated copy of this layer.
25     /// @param [in] graph The graph into which this layer is being cloned.
26     ConstantLayer* Clone(Graph& graph) const override;
27 
28     /// Check if the input tensor shape(s)
29     /// will lead to a valid configuration of @ref ConstantLayer
30     /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.
31     void ValidateTensorShapesFromInputs() override;
32 
33     /// By default returns inputShapes if the number of inputs are equal to number of outputs,
34     /// otherwise infers the output shapes from given input shapes and layer properties.
35     /// @param [in] inputShapes The input shapes layer has.
36     /// @return a vector to the inferred output shape.
37     std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
38 
39     /// Free up the constant source data stored by the layer.
ReleaseConstantData()40     void ReleaseConstantData() override {}
41 
42     void ExecuteStrategy(IStrategy& strategy) const override;
43 
44     std::shared_ptr<ConstTensorHandle> m_LayerOutput;
45 
46 protected:
47     /// Constructor to create a ConstantLayer.
48     /// @param [in] name Optional name for the layer.
49     ConstantLayer(const char* name);
50 
51     /// Default destructor
52     ~ConstantLayer() = default;
53 
54     /// Retrieve the handles to the constant values stored by the layer.
55     // For API stability DO NOT ALTER order and add new members to the end of vector
GetConstantTensorsByRef() const56     ImmutableConstantTensors GetConstantTensorsByRef() const override { return {m_LayerOutput}; }
57 };
58 
59 } // namespace
60