ArmNN
 20.02
PermuteLayer Class Reference

This layer represents a permutation operation. More...

#include <PermuteLayer.hpp>

Inheritance diagram for PermuteLayer:
LayerWithParameters< PermuteDescriptor > Layer IConnectableLayer

Public Member Functions

virtual std::unique_ptr< IWorkloadCreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the Permute type. More...
 
PermuteLayerClone (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 PermuteLayer. More...
 
std::vector< TensorShapeInferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
 By default returns inputShapes if the number of inputs are equal to number of outputs, otherwise infers the output shapes from given input shapes and layer properties. More...
 
const PermutationVectorGetPermutation () 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 Accept (ILayerVisitor &visitor) const override
 Apply a visitor to this layer. More...
 
- Public Member Functions inherited from LayerWithParameters< PermuteDescriptor >
const PermuteDescriptorGetParameters () const
 
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 OutputHandlerGetOutputHandler (unsigned int i=0) const
 
OutputHandlerGetOutputHandler (unsigned int i=0)
 
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
 
DataType GetDataType () const
 
const BackendIdGetBackendId () const
 
void SetBackendId (const BackendId &id)
 
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 InputSlotGetInputSlot (unsigned int index) const override
 Get a const input slot handle by slot index. More...
 
InputSlotGetInputSlot (unsigned int index) override
 Get the input slot handle by slot index. More...
 
const OutputSlotGetOutputSlot (unsigned int index=0) const override
 Get the const output slot handle by slot index. More...
 
OutputSlotGetOutputSlot (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< BackendIdGetBackendHint () const
 

Protected Member Functions

 PermuteLayer (const PermuteDescriptor &param, const char *name)
 Constructor to create a PermuteLayer. More...
 
 ~PermuteLayer ()=default
 Default destructor. More...
 
- Protected Member Functions inherited from LayerWithParameters< PermuteDescriptor >
 LayerWithParameters (unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const PermuteDescriptor &param, const char *name)
 
 ~LayerWithParameters ()=default
 
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *LayerCreateWorkload. More...
 
- 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
 
template<typename QueueDescriptor >
WorkloadInfo PrepInfoAndDesc (QueueDescriptor &descriptor) const
 Helper function to reduce duplication in *LayerCreateWorkload. More...
 
template<typename LayerType , typename ... Params>
LayerTypeCloneBase (Graph &graph, Params &&... params) const
 
virtual ConstantTensors GetConstantTensorsByRef ()
 
- Protected Member Functions inherited from IConnectableLayer
 ~IConnectableLayer ()
 Objects are not deletable via the handle. More...
 

Additional Inherited Members

- Public Types inherited from LayerWithParameters< PermuteDescriptor >
using DescriptorType = PermuteDescriptor
 
- Protected Types inherited from Layer
using ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>
 
- Protected Attributes inherited from LayerWithParameters< PermuteDescriptor >
PermuteDescriptor m_Param
 The parameters for the layer (not including tensor-valued weights etc.). More...
 
- Protected Attributes inherited from Layer
std::vector< OutputHandlerm_OutputHandlers
 

Detailed Description

This layer represents a permutation operation.

Definition at line 13 of file PermuteLayer.hpp.

Constructor & Destructor Documentation

◆ PermuteLayer()

PermuteLayer ( const PermuteDescriptor param,
const char *  name 
)
protected

Constructor to create a PermuteLayer.

Parameters
[in]paramPermuteDescriptor to configure the permute operation.
[in]nameOptional name for the layer.

Definition at line 20 of file PermuteLayer.cpp.

References armnnUtils::Permute().

Referenced by PermuteLayer::IsEqual().

21  : LayerWithParameters(1, 1, LayerType::Permute, param, name)
22 {
23 }
LayerWithParameters(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const PermuteDescriptor &param, const char *name)

◆ ~PermuteLayer()

~PermuteLayer ( )
protecteddefault

Default destructor.

Referenced by PermuteLayer::IsEqual().

Member Function Documentation

◆ Accept()

void Accept ( ILayerVisitor visitor) const
overridevirtual

Apply a visitor to this layer.

Implements IConnectableLayer.

Definition at line 57 of file PermuteLayer.cpp.

References Layer::GetName(), LayerWithParameters< PermuteDescriptor >::GetParameters(), and ILayerVisitor::VisitPermuteLayer().

Referenced by PermuteLayer::IsEqual().

58 {
59  visitor.VisitPermuteLayer(this, GetParameters(), GetName());
60 }
const PermuteDescriptor & GetParameters() const
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:305

◆ Clone()

PermuteLayer * Clone ( Graph graph) const
overridevirtual

Creates a dynamically-allocated copy of this layer.

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

Implements Layer.

Definition at line 31 of file PermuteLayer.cpp.

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

32 {
33  return CloneBase<PermuteLayer>(graph, m_Param, GetName());
34 }
PermuteDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:305

◆ CreateWorkload()

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

Makes a workload for the Permute type.

Parameters
[in]graphThe graph where this layer can be found.
[in]factoryThe 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 PermuteLayer.cpp.

References IWorkloadFactory::CreatePermute(), and LayerWithParameters< PermuteDescriptor >::PrepInfoAndDesc().

26 {
27  PermuteQueueDescriptor descriptor;
28  return factory.CreatePermute(descriptor, PrepInfoAndDesc(descriptor));
29 }
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *LayerCreateWorkload.

◆ GetPermutation()

const PermutationVector& GetPermutation ( ) const
inline
Returns
a permutation vector represents the memory layout of the tensor elements.

Definition at line 37 of file PermuteLayer.hpp.

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

Referenced by PermuteLayer::IsEqual(), PermuteLayer::IsInverse(), and PermuteAsReshapeImpl::Run().

38  {
39  return m_Param.m_DimMappings;
40  }
PermuteDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
PermutationVector m_DimMappings
Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g.

◆ InferOutputShapes()

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

By default returns inputShapes if the number of inputs are equal to number of outputs, otherwise infers the output shapes from given input shapes and layer properties.

Parameters
[in]inputShapesThe input shapes layer has.
Returns
A vector to the inferred output shape.

Reimplemented from Layer.

Definition at line 36 of file PermuteLayer.cpp.

References PermuteDescriptor::m_DimMappings, LayerWithParameters< PermuteDescriptor >::m_Param, and armnnUtils::Permuted().

Referenced by PermuteLayer::ValidateTensorShapesFromInputs().

37 {
38  BOOST_ASSERT(inputShapes.size() == 1);
39  const TensorShape& inShape = inputShapes[0];
40  return std::vector<TensorShape> ({armnnUtils::Permuted(inShape, m_Param.m_DimMappings)});
41 }
PermuteDescriptor m_Param
The parameters for the layer (not including tensor-valued weights etc.).
PermutationVector m_DimMappings
Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g.
armnn::TensorShape Permuted(const armnn::TensorShape &srcShape, const armnn::PermutationVector &mappings)
Definition: Permute.cpp:98

◆ IsEqual()

bool IsEqual ( const Layer other) const
inline

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

Parameters
otherThe other layer to be compare with.
Returns
true if other layer is equal to this false otherwise.

Definition at line 54 of file PermuteLayer.hpp.

References PermuteLayer::Accept(), PermuteLayer::GetPermutation(), Layer::GetType(), PermutationVector::IsEqual(), armnn::Permute, PermuteLayer::PermuteLayer(), and PermuteLayer::~PermuteLayer().

55  {
56  return (other.GetType() == LayerType::Permute) &&
57  GetPermutation().IsEqual(boost::polymorphic_downcast<const PermuteLayer*>(&other)->GetPermutation());
58  }
bool IsEqual(const PermutationVector &other) const
Definition: Types.hpp:207
const PermutationVector & GetPermutation() const

◆ IsInverse()

bool IsInverse ( const Layer other) const
inline

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

Parameters
otherThe other layer to be compared with.
Returns
true if other layer is inverse of this false otherwise.

Definition at line 45 of file PermuteLayer.hpp.

References PermuteLayer::GetPermutation(), Layer::GetType(), PermutationVector::IsInverse(), and armnn::Permute.

46  {
47  return (other.GetType() == LayerType::Permute) &&
48  GetPermutation().IsInverse(boost::polymorphic_downcast<const PermuteLayer*>(&other)->GetPermutation());
49  }
const PermutationVector & GetPermutation() const
bool IsInverse(const PermutationVector &other) const
Definition: Types.hpp:217

◆ ValidateTensorShapesFromInputs()

void ValidateTensorShapesFromInputs ( )
overridevirtual

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

Implements Layer.

Definition at line 43 of file PermuteLayer.cpp.

References CHECK_LOCATION, InputSlot::GetConnection(), Layer::GetInputSlot(), Layer::GetOutputSlot(), TensorInfo::GetShape(), IOutputSlot::GetTensorInfo(), OutputSlot::GetTensorInfo(), PermuteLayer::InferOutputShapes(), and Layer::VerifyLayerConnections().

44 {
46 
47  auto inferredShapes = InferOutputShapes({ GetInputSlot(0).GetConnection()->GetTensorInfo().GetShape() });
48 
49  BOOST_ASSERT(inferredShapes.size() == 1);
50 
51  ConditionalThrowIfNotEqual<LayerValidationException>(
52  "PermuteLayer: TensorShape set on OutputSlot[0] does not match the inferred shape.",
54  inferredShapes[0]);
55 }
const TensorShape & GetShape() const
Definition: Tensor.hpp:88
const IOutputSlot * GetConnection() const override
Definition: Layer.hpp:199
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, otherwise infers the output shapes from given input shapes and layer properties.
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:338
const InputSlot & GetInputSlot(unsigned int index) const override
Get a const input slot handle by slot index.
Definition: Layer.hpp:310
#define CHECK_LOCATION()
Definition: Exceptions.hpp:192
const OutputSlot & GetOutputSlot(unsigned int index=0) const override
Get the const output slot handle by slot index.
Definition: Layer.hpp:312
virtual const TensorInfo & GetTensorInfo() const =0
const TensorInfo & GetTensorInfo() const override
Definition: Layer.cpp:63

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