ArmNN
 24.02
TransposeLayer.hpp
Go to the documentation of this file.
1 //
2 // Copyright © 2020,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 transpose operation.
15 class TransposeLayer : public LayerWithParameters<TransposeDescriptor>
16 {
17 public:
18  /// Makes a workload for the Transpose 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  TransposeLayer* Clone(Graph& graph) const override;
26 
27  /// Check if the input tensor shape(s)
28  /// will lead to a valid configuration of @ref TransposeLayer.
29  void ValidateTensorShapesFromInputs() override;
30 
31  /// Infers the output shapes from given input shapes and the permutation vector.
32  /// @param [in] inputShapes The input shapes layer has.
33  /// @return A vector to the inferred output shape.
34  std::vector<TensorShape> InferOutputShapes(const std::vector<TensorShape>& inputShapes) const override;
35 
36  /// @return a permutation vector describing the permutation for the dimensions of the input tensor.
38  {
39  return m_Param.m_DimMappings;
40  }
41 
42  /// Indicates if the other layer received is inverse of this one.
43  /// @param [in] other The other layer to be compared with.
44  /// @return true if other layer is inverse of this false otherwise.
45  bool IsInverse(const Layer& other) const
46  {
47  return (other.GetType() == LayerType::Transpose) &&
48  GetPermutation().IsInverse(PolymorphicDowncast<const TransposeLayer*>(&other)->GetPermutation());
49  }
50 
51  /// Indicates if the other layer received is equal to this one.
52  /// @param [in] other The other layer to be compare with.
53  /// @return true if other layer is equal to this false otherwise.
54  bool IsEqual(const Layer& other) const
55  {
56  return (other.GetType() == LayerType::Transpose) &&
57  GetPermutation().IsEqual(PolymorphicDowncast<const TransposeLayer*>(&other)->GetPermutation());
58  }
59 
60  void ExecuteStrategy(IStrategy& strategy) const override;
61 
62 
63 protected:
64  /// Constructor to create a TransposeLayer.
65  /// @param [in] param TransposeDescriptor to configure the permute operation.
66  /// @param [in] name Optional name for the layer.
67  TransposeLayer(const TransposeDescriptor& param, const char* name);
68 
69  /// Default destructor
70  ~TransposeLayer() = default;
71 };
72 
73 } // namespace
armnn::PermutationVector::IsEqual
bool IsEqual(const PermutationVector &other) const
Definition: Types.hpp:366
armnn::TransposeLayer::IsEqual
bool IsEqual(const Layer &other) const
Indicates if the other layer received is equal to this one.
Definition: TransposeLayer.hpp:54
armnn::PermutationVector::IsInverse
bool IsInverse(const PermutationVector &other) const
Definition: Types.hpp:376
armnn::TransposeLayer::Clone
TransposeLayer * Clone(Graph &graph) const override
Creates a dynamically-allocated copy of this layer.
Definition: TransposeLayer.cpp:33
armnn::LayerType::Transpose
@ Transpose
armnn::IStrategy
Definition: IStrategy.hpp:16
armnn::LayerWithParameters
Definition: LayerWithParameters.hpp:14
armnn::TransposeLayer::ValidateTensorShapesFromInputs
void ValidateTensorShapesFromInputs() override
Check if the input tensor shape(s) will lead to a valid configuration of TransposeLayer.
Definition: TransposeLayer.cpp:45
armnn::Layer
Definition: Layer.hpp:230
armnn::TransposeLayer
This layer represents a transpose operation.
Definition: TransposeLayer.hpp:15
armnn::LayerWithParameters< TransposeDescriptor >::m_Param
TransposeDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
Definition: LayerWithParameters.hpp:52
armnn::TransposeDescriptor
A TransposeDescriptor for the TransposeLayer.
Definition: Descriptors.hpp:1490
PolymorphicDowncast.hpp
armnn::IWorkloadFactory
Definition: WorkloadFactory.hpp:22
armnn::TransposeLayer::IsInverse
bool IsInverse(const Layer &other) const
Indicates if the other layer received is inverse of this one.
Definition: TransposeLayer.hpp:45
armnn::TransposeLayer::ExecuteStrategy
void ExecuteStrategy(IStrategy &strategy) const override
Apply a visitor to this layer.
Definition: TransposeLayer.cpp:60
armnn::PermutationVector
Definition: Types.hpp:314
LayerWithParameters.hpp
armnn::TransposeLayer::TransposeLayer
TransposeLayer(const TransposeDescriptor &param, const char *name)
Constructor to create a TransposeLayer.
Definition: TransposeLayer.cpp:20
armnn::TransposeLayer::GetPermutation
const PermutationVector & GetPermutation() const
Definition: TransposeLayer.hpp:37
armnn::Layer::GetType
LayerType GetType() const override
Returns the armnn::LayerType of this layer.
Definition: Layer.hpp:286
armnn::TransposeDescriptor::m_DimMappings
PermutationVector m_DimMappings
Indicates how to translate tensor elements from a given source into the target destination,...
Definition: Descriptors.hpp:1514
armnn::TransposeLayer::~TransposeLayer
~TransposeLayer()=default
Default destructor.
armnn::TransposeLayer::InferOutputShapes
std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override
Infers the output shapes from given input shapes and the permutation vector.
Definition: TransposeLayer.cpp:38
armnn::TransposeLayer::CreateWorkload
virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override
Makes a workload for the Transpose type.
Definition: TransposeLayer.cpp:25
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_quick_start.dox:6
armnn::Graph
Definition: Graph.hpp:30