ArmNN
 24.02
PermuteLayer.hpp
Go to the documentation of this file.
1 //
2 // Copyright © 2017,2022 Arm Ltd and Contributors. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
8 
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.
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.
46  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.
55  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
armnn::PermutationVector::IsEqual
bool IsEqual(const PermutationVector &other) const
Definition: Types.hpp:366
armnn::LayerType::Permute
@ Permute
armnn::PermuteLayer::PermuteLayer
PermuteLayer(const PermuteDescriptor &param, const char *name)
Constructor to create a PermuteLayer.
Definition: PermuteLayer.cpp:20
armnn::PermutationVector::IsInverse
bool IsInverse(const PermutationVector &other) const
Definition: Types.hpp:376
armnn::PermuteLayer::IsEqual
bool IsEqual(const Layer &other) const
Indicates if the other layer received is equal to this one.
Definition: PermuteLayer.hpp:55
armnn::PermuteLayer::ExecuteStrategy
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
Definition: PermuteLayer.cpp:60
armnn::IStrategy
Definition: IStrategy.hpp:16
armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:14
armnn::PermuteLayer::Clone
PermuteLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: PermuteLayer.cpp:33
armnn::Layer
Definition: Layer.hpp:230
armnn::PermuteLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Permute type.
Definition: PermuteLayer.cpp:25
armnn::LayerWithParameters< PermuteDescriptor >::m_Param
PermuteDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:52
armnn::PermuteLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of PermuteLayer.
Definition: PermuteLayer.cpp:45
PolymorphicDowncast.hpp
armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnn::PermuteLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
By default returns inputShapes if the number of inputs are equal to number of outputs,...
Definition: PermuteLayer.cpp:38
armnn::PermuteDescriptor
A PermuteDescriptor for the PermuteLayer.
Definition: Descriptors.hpp:149
armnn::PermuteLayer::IsInverse
bool IsInverse(const Layer &other) const
Indicates if the other layer received is inverse of this one.
Definition: PermuteLayer.hpp:46
armnn::PermutationVector
Definition: Types.hpp:314
armnn::PermuteDescriptor::m_DimMappings
PermutationVector m_DimMappings
Indicates how to translate tensor elements from a given source into the target destination,...
Definition: Descriptors.hpp:173
LayerWithParameters.hpp
armnn::Layer::GetType
LayerType GetType() const override
Returns the armnn::LayerType of this layer.
Definition: Layer.hpp:286
armnn::PermuteLayer::~PermuteLayer
~PermuteLayer()=default
Default destructor.
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
armnn::PermuteLayer
This layer represents a permutation operation.
Definition: PermuteLayer.hpp:15
armnn::Graph
Definition: Graph.hpp:30
armnn::PermuteLayer::GetPermutation
const PermutationVector & GetPermutation() const
Definition: PermuteLayer.hpp:38