xref: /aosp_15_r20/external/armnn/src/armnn/layers/PermuteLayer.hpp (revision 89c4ff92f2867872bb9e2354d150bf0c8c502810)
1 //
2 // Copyright © 2017,2022 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
7 #include "LayerWithParameters.hpp"
8 
9 #include <armnn/utility/PolymorphicDowncast.hpp>
10 
11 namespace armnn
12 {
13 
14 /// This layer represents a permutation operation.
15 class PermuteLayer : public LayerWithParameters<PermuteDescriptor>
16 {
17 public:
18     /// Makes a workload for the Permute type.
19     /// @param [in] factory The workload factory which will create the workload.
20     /// @return A pointer to the created workload, or nullptr if not created.
21     virtual std::unique_ptr<IWorkload> CreateWorkload(const IWorkloadFactory& factory) const override;
22 
23     /// Creates a dynamically-allocated copy of this layer.
24     /// @param [in] graph The graph into which this layer is being cloned.
25     PermuteLayer* Clone(Graph& graph) const override;
26 
27     /// Check if the input tensor shape(s)
28     /// will lead to a valid configuration of @ref PermuteLayer.
29     void ValidateTensorShapesFromInputs() override;
30 
31     /// By default returns inputShapes if the number of inputs are equal to number of outputs,
32     /// otherwise infers the output shapes from given input shapes and layer properties.
33     /// @param [in] inputShapes The input shapes layer has.
34     /// @return A vector to the inferred output shape.
35     std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
36 
37     /// @return a permutation vector represents the memory layout of the tensor elements.
GetPermutation() const38     const PermutationVector& GetPermutation() const
39     {
40         return m_Param.m_DimMappings;
41     }
42 
43     /// Indicates if the other layer received is inverse of this one.
44     /// @param other The other layer to be compared with.
45     /// @return true if other layer is inverse of this false otherwise.
IsInverse(const Layer & other) const46     bool IsInverse(const Layer& other) const
47     {
48         return (other.GetType() == LayerType::Permute) &&
49             GetPermutation().IsInverse(PolymorphicDowncast<const PermuteLayer*>(&other)->GetPermutation());
50     }
51 
52     /// Indicates if the other layer received is equal to this one.
53     /// @param other The other layer to be compare with.
54     /// @return true if other layer is equal to this false otherwise.
IsEqual(const Layer & other) const55     bool IsEqual(const Layer& other) const
56     {
57         return (other.GetType() == LayerType::Permute) &&
58                GetPermutation().IsEqual(PolymorphicDowncast<const PermuteLayer*>(&other)->GetPermutation());
59     }
60 
61     void ExecuteStrategy(IStrategy& strategy) const override;
62 
63 
64 protected:
65     /// Constructor to create a PermuteLayer.
66     /// @param [in] param PermuteDescriptor to configure the permute operation.
67     /// @param [in] name Optional name for the layer.
68     PermuteLayer(const PermuteDescriptor& param, const char* name);
69 
70     /// Default destructor
71     ~PermuteLayer() = default;
72 };
73 
74 } // namespace
75