• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //
2 // Copyright © 2017 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] 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     PermuteLayer* Clone(Graph& graph) const override;
27 
28     /// Check if the input tensor shape(s)
29     /// will lead to a valid configuration of @ref PermuteLayer.
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     /// @return a permutation vector represents the memory layout of the tensor elements.
GetPermutation() const40     const PermutationVector& GetPermutation() const
41     {
42         return m_Param.m_DimMappings;
43     }
44 
45     /// Indicates if the other layer received is inverse of this one.
46     /// @param other The other layer to be compared with.
47     /// @return true if other layer is inverse of this false otherwise.
IsInverse(const Layer & other) const48     bool IsInverse(const Layer& other) const
49     {
50         return (other.GetType() == LayerType::Permute) &&
51             GetPermutation().IsInverse(PolymorphicDowncast<const PermuteLayer*>(&other)->GetPermutation());
52     }
53 
54     /// Indicates if the other layer received is equal to this one.
55     /// @param other The other layer to be compare with.
56     /// @return true if other layer is equal to this false otherwise.
IsEqual(const Layer & other) const57     bool IsEqual(const Layer& other) const
58     {
59         return (other.GetType() == LayerType::Permute) &&
60                GetPermutation().IsEqual(PolymorphicDowncast<const PermuteLayer*>(&other)->GetPermutation());
61     }
62 
63     void Accept(ILayerVisitor& visitor) const override;
64 
65 protected:
66     /// Constructor to create a PermuteLayer.
67     /// @param [in] param PermuteDescriptor to configure the permute operation.
68     /// @param [in] name Optional name for the layer.
69     PermuteLayer(const PermuteDescriptor& param, const char* name);
70 
71     /// Default destructor
72     ~PermuteLayer() = default;
73 };
74 
75 } // namespace
76