This layer represents a transpose operation. More...

#include <TransposeLayer.hpp>

Inheritance diagram for TransposeLayer:

Collaboration diagram for TransposeLayer:

Public Member Functions
virtual std::unique_ptr< IWorkload >	CreateWorkload (const IWorkloadFactory &factory) const override
	Makes a workload for the Transpose type. More...

TransposeLayer *	Clone (Graph &graph) const override
	Creates a dynamically-allocated copy of this layer. More...

void	ValidateTensorShapesFromInputs () override
	Check if the input tensor shape(s) will lead to a valid configuration of TransposeLayer. More...

std::vector< TensorShape >	InferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
	Infers the output shapes from given input shapes and the permutation vector. More...

const PermutationVector &	GetPermutation () const

bool	IsInverse (const Layer &other) const
	Indicates if the other layer received is inverse of this one. More...

bool	IsEqual (const Layer &other) const
	Indicates if the other layer received is equal to this one. More...

void	ExecuteStrategy (IStrategy &strategy) const override
	Apply a visitor to this layer. More...

Public Member Functions inherited from LayerWithParameters< TransposeDescriptor >
const TransposeDescriptor &	GetParameters () const override
	If the layer has a descriptor return it. More...

void	SerializeLayerParameters (ParameterStringifyFunction &fn) const override
	Helper to serialize the layer parameters to string (currently used in DotSerializer and company). More...

Public Member Functions inherited from Layer
	Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)

	Layer (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, DataLayout layout, const char *name)

const std::string &	GetNameStr () const

const OutputHandler &	GetOutputHandler (unsigned int i=0) const

OutputHandler &	GetOutputHandler (unsigned int i=0)

ShapeInferenceMethod	GetShapeInferenceMethod () const

bool	GetAllowExpandedDims () const

const std::vector< InputSlot > &	GetInputSlots () const

const std::vector< OutputSlot > &	GetOutputSlots () const

std::vector< InputSlot >::iterator	BeginInputSlots ()

std::vector< InputSlot >::iterator	EndInputSlots ()

std::vector< OutputSlot >::iterator	BeginOutputSlots ()

std::vector< OutputSlot >::iterator	EndOutputSlots ()

bool	IsOutputUnconnected ()

void	ResetPriority () const

LayerPriority	GetPriority () const

LayerType	GetType () const override
	Returns the armnn::LayerType of this layer. More...

DataType	GetDataType () const

const BackendId &	GetBackendId () const

void	SetBackendId (const BackendId &id) override
	Set the backend of the IConnectableLayer. More...

virtual void	CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)

void	VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const

virtual void	ReleaseConstantData ()

template<typename Op >
void	OperateOnConstantTensors (Op op)

const char *	GetName () const override
	Returns the name of the layer. More...

unsigned int	GetNumInputSlots () const override
	Returns the number of connectable input slots. More...

unsigned int	GetNumOutputSlots () const override
	Returns the number of connectable output slots. More...

const InputSlot &	GetInputSlot (unsigned int index) const override
	Get a const input slot handle by slot index. More...

InputSlot &	GetInputSlot (unsigned int index) override
	Get the input slot handle by slot index. More...

const OutputSlot &	GetOutputSlot (unsigned int index=0) const override
	Get the const output slot handle by slot index. More...

OutputSlot &	GetOutputSlot (unsigned int index=0) override
	Get the output slot handle by slot index. More...

void	SetGuid (LayerGuid guid)

LayerGuid	GetGuid () const final
	Returns the unique id of the layer. More...

void	AddRelatedLayerName (const std::string layerName)

const std::list< std::string > &	GetRelatedLayerNames ()

virtual void	Reparent (Graph &dest, std::list< Layer * >::const_iterator iterator)=0

void	BackendSelectionHint (Optional< BackendId > backend) final
	Provide a hint for the optimizer as to which backend to prefer for this layer. More...

Optional< BackendId >	GetBackendHint () const

void	SetShapeInferenceMethod (ShapeInferenceMethod shapeInferenceMethod)

void	SetAllowExpandedDims (bool allowExpandedDims)

template<typename T >
std::shared_ptr< T >	GetAdditionalInformation () const

void	SetAdditionalInfoForObject (const AdditionalInfoObjectPtr &additionalInfo)

virtual const BaseDescriptor &	GetParameters () const override
	If the layer has a descriptor return it. More...

Protected Member Functions
	TransposeLayer (const TransposeDescriptor &param, const char *name)
	Constructor to create a TransposeLayer. More...

	~TransposeLayer ()=default
	Default destructor. More...

Protected Member Functions inherited from LayerWithParameters< TransposeDescriptor >
	LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const TransposeDescriptor &param, const char *name)

	~LayerWithParameters ()=default

WorkloadInfo	PrepInfoAndDesc (QueueDescriptor &descriptor) const
	Helper function to reduce duplication in *Layer::CreateWorkload. More...

void	ExecuteStrategy (IStrategy &strategy) const override
	Apply a visitor to this layer. More...

Layer::ImmutableConstantTensors	GetConnectedConstantAsInputTensors () const

Protected Member Functions inherited from Layer
virtual	~Layer ()=default

template<typename QueueDescriptor >
void	CollectQueueDescriptorInputs (QueueDescriptor &descriptor, WorkloadInfo &info) const

template<typename QueueDescriptor >
void	CollectQueueDescriptorOutputs (QueueDescriptor &descriptor, WorkloadInfo &info) const

void	ValidateAndCopyShape (const TensorShape &outputShape, const TensorShape &inferredShape, const ShapeInferenceMethod shapeInferenceMethod, const std::string &layerName, const unsigned int outputSlotIndex=0)

void	VerifyShapeInferenceType (const TensorShape &outputShape, ShapeInferenceMethod shapeInferenceMethod)

template<typename QueueDescriptor >
WorkloadInfo	PrepInfoAndDesc (QueueDescriptor &descriptor) const
	Helper function to reduce duplication in *Layer::CreateWorkload. More...

template<typename LayerType , typename ... Params>
LayerType *	CloneBase (Graph &graph, Params &&... params) const

virtual ConstantTensors	GetConstantTensorsByRef () override final

virtual ImmutableConstantTensors	GetConstantTensorsByRef () const override

void	SetAdditionalInfo (QueueDescriptor &descriptor) const

Protected Member Functions inherited from IConnectableLayer
	~IConnectableLayer ()
	Objects are not deletable via the handle. More...

Additional Inherited Members
Public Types inherited from LayerWithParameters< TransposeDescriptor >
using	DescriptorType = TransposeDescriptor

Public Types inherited from IConnectableLayer
using	ConstantTensors = std::vector< std::reference_wrapper< std::shared_ptr< ConstTensorHandle > >>

using	ImmutableConstantTensors = std::vector< std::reference_wrapper< const std::shared_ptr< ConstTensorHandle > >>

Protected Attributes inherited from LayerWithParameters< TransposeDescriptor >
TransposeDescriptor	m_Param
	The parameters for the layer (not including tensor-valued weights etc.). More...

Protected Attributes inherited from Layer
AdditionalInfoObjectPtr	m_AdditionalInfoObject

std::vector< OutputHandler >	m_OutputHandlers

ShapeInferenceMethod	m_ShapeInferenceMethod

Detailed Description

This layer represents a transpose operation.

Definition at line 15 of file TransposeLayer.hpp.

Constructor & Destructor Documentation

◆ TransposeLayer()

TransposeLayer	(	const TransposeDescriptor &	param,
		const char *	name
	)

protected

Constructor to create a TransposeLayer.

Parameters

[in]	param	TransposeDescriptor to configure the permute operation.
[in]	name	Optional name for the layer.

Definition at line 20 of file TransposeLayer.cpp.

     : LayerWithParameters(1, 1, LayerType::Transpose, param, name)
 {
 }

References armnnUtils::Transpose().

◆ ~TransposeLayer()

~TransposeLayer ( )

protecteddefault

Default destructor.

Member Function Documentation

◆ Clone()

TransposeLayer * Clone ( Graph & graph ) const

overridevirtual

Creates a dynamically-allocated copy of this layer.

Parameters

[in] graph The graph into which this layer is being cloned.

Implements Layer.

Definition at line 33 of file TransposeLayer.cpp.

 {
     return CloneBase<TransposeLayer>(graph, m_Param, GetName());
 }

References Layer::GetName(), and LayerWithParameters< TransposeDescriptor >::m_Param.

◆ CreateWorkload()

std::unique_ptr< IWorkload > CreateWorkload ( const IWorkloadFactory & factory ) const

overridevirtual

Makes a workload for the Transpose type.

Parameters

[in] factory The workload factory which will create the workload.

Returns: A pointer to the created workload, or nullptr if not created.

Implements Layer.

Definition at line 25 of file TransposeLayer.cpp.

 {
     TransposeQueueDescriptor descriptor;
     SetAdditionalInfo(descriptor);
  
     return factory.CreateWorkload(LayerType::Transpose, descriptor, PrepInfoAndDesc(descriptor));
 }

References IWorkloadFactory::CreateWorkload(), LayerWithParameters< TransposeDescriptor >::PrepInfoAndDesc(), Layer::SetAdditionalInfo(), and armnn::Transpose.

◆ ExecuteStrategy()

void ExecuteStrategy ( IStrategy & strategy ) const

overridevirtual

Apply a visitor to this layer.

Reimplemented from Layer.

Definition at line 70 of file TransposeLayer.cpp.

 {
     strategy.ExecuteStrategy(this, GetParameters(), {}, GetName());
 }

References IStrategy::ExecuteStrategy(), Layer::GetName(), and LayerWithParameters< TransposeDescriptor >::GetParameters().

◆ GetPermutation()

const PermutationVector& GetPermutation ( ) const

inline

Returns: a permutation vector describing the permutation for the dimensions of the input tensor.

Definition at line 37 of file TransposeLayer.hpp.

     {
         return m_Param.m_DimMappings;
     }

References TransposeDescriptor::m_DimMappings, and LayerWithParameters< TransposeDescriptor >::m_Param.

Referenced by TransposeLayer::IsEqual(), and TransposeLayer::IsInverse().

◆ InferOutputShapes()

std::vector< TensorShape > InferOutputShapes ( const std::vector< TensorShape > & inputShapes ) const

overridevirtual

Infers the output shapes from given input shapes and the permutation vector.

Parameters

[in] inputShapes The input shapes layer has.

Returns: A vector to the inferred output shape.

Reimplemented from Layer.

Definition at line 38 of file TransposeLayer.cpp.

 {
     if (inputShapes.size() != 1)
     {
         throw armnn::Exception("inputShapes' size is \"" + std::to_string(inputShapes.size()) +
                                "\" - should be \"1\".");
     }
  
     const TensorShape& inShape = inputShapes[0];
     return std::vector<TensorShape> ({armnnUtils::TransposeTensorShape(inShape, m_Param.m_DimMappings)});
 }

References TransposeDescriptor::m_DimMappings, LayerWithParameters< TransposeDescriptor >::m_Param, and armnnUtils::TransposeTensorShape().

Referenced by TransposeLayer::ValidateTensorShapesFromInputs().

◆ IsEqual()

bool IsEqual ( const Layer & other ) const

inline

Indicates if the other layer received is equal to this one.

Parameters

[in] other The other layer to be compare with.

Returns: true if other layer is equal to this false otherwise.

Definition at line 54 of file TransposeLayer.hpp.

     {
         return (other.GetType() == LayerType::Transpose) &&
                GetPermutation().IsEqual(PolymorphicDowncast<const TransposeLayer*>(&other)->GetPermutation());
     }

References TransposeLayer::GetPermutation(), Layer::GetType(), PermutationVector::IsEqual(), and armnn::Transpose.

◆ IsInverse()

bool IsInverse ( const Layer & other ) const

inline

Indicates if the other layer received is inverse of this one.

Parameters

[in] other The other layer to be compared with.

Returns: true if other layer is inverse of this false otherwise.

Definition at line 45 of file TransposeLayer.hpp.

     {
         return (other.GetType() == LayerType::Transpose) &&
             GetPermutation().IsInverse(PolymorphicDowncast<const TransposeLayer*>(&other)->GetPermutation());
     }

References TransposeLayer::GetPermutation(), Layer::GetType(), PermutationVector::IsInverse(), and armnn::Transpose.

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )

overridevirtual

Check if the input tensor shape(s) will lead to a valid configuration of TransposeLayer.

Implements Layer.

Definition at line 50 of file TransposeLayer.cpp.

 {
     VerifyLayerConnections(1, CHECK_LOCATION());
  
     const TensorShape& outputShape = GetOutputSlot(0).GetTensorInfo().GetShape();
  
     VerifyShapeInferenceType(outputShape, m_ShapeInferenceMethod);
  
     auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetTensorInfo().GetShape() });
  
     if (inferredShapes.size() != 1)
     {
         throw armnn::LayerValidationException("inferredShapes has "
                                               + std::to_string(inferredShapes.size()) +
                                               " elements - should only have 1.");
     }
  
     ValidateAndCopyShape(outputShape, inferredShapes[0], m_ShapeInferenceMethod, "TransposeLayer");
 }

References CHECK_LOCATION, Layer::GetInputSlot(), Layer::GetOutputSlot(), TensorInfo::GetShape(), InputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), TransposeLayer::InferOutputShapes(), Layer::m_ShapeInferenceMethod, Layer::ValidateAndCopyShape(), Layer::VerifyLayerConnections(), and Layer::VerifyShapeInferenceType().

The documentation for this class was generated from the following files:

src/armnn/layers/TransposeLayer.hpp
src/armnn/layers/TransposeLayer.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TransposeLayer()

◆ ~TransposeLayer()

Member Function Documentation

◆ Clone()

◆ CreateWorkload()

◆ ExecuteStrategy()

◆ GetPermutation()

◆ InferOutputShapes()

◆ IsEqual()

◆ IsInverse()

◆ ValidateTensorShapesFromInputs()