From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- 21.02/classarmnn_1_1_unmap_layer.xhtml | 542 +++++++++++++++++++++++++++++++++ 1 file changed, 542 insertions(+) create mode 100644 21.02/classarmnn_1_1_unmap_layer.xhtml (limited to '21.02/classarmnn_1_1_unmap_layer.xhtml') diff --git a/21.02/classarmnn_1_1_unmap_layer.xhtml b/21.02/classarmnn_1_1_unmap_layer.xhtml new file mode 100644 index 0000000000..e3f14b5c61 --- /dev/null +++ b/21.02/classarmnn_1_1_unmap_layer.xhtml @@ -0,0 +1,542 @@ + + + + + + + + + + + + + +ArmNN: UnmapLayer Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
UnmapLayer Class Reference
+
+
+ +

This layer represents a memory copy operation. + More...

+ +

#include <UnmapLayer.hpp>

+
+Inheritance diagram for UnmapLayer:
+
+
+ + +Layer +IConnectableLayer + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual std::unique_ptr< IWorkload > CreateWorkload (const IWorkloadFactory &factory) const override
 Makes a workload for the Unmap type. More...
 
UnmapLayer * 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 UnmapLayer. More...
 
void Accept (ILayerVisitor &visitor) const override
 Apply a visitor to this layer. 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)
 
void ExecuteStrategy (IStrategy &strategy) const override
 Apply a visitor to this layer. More...
 
const std::string & GetNameStr () const
 
const OutputHandler & GetOutputHandler (unsigned int i=0) const
 
OutputHandler & GetOutputHandler (unsigned int i=0)
 
ShapeInferenceMethod GetShapeInferenceMethod () 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)
 
virtual void CreateTensorHandles (const TensorHandleFactoryRegistry &registry, const IWorkloadFactory &factory, const bool IsMemoryManaged=true)
 
void VerifyLayerConnections (unsigned int expectedConnections, const CheckLocation &location) const
 
std::vector< TensorShape > InferOutputShapes (const std::vector< TensorShape > &inputShapes) const override
 Infer the shape of the output(s) based on the provided input shape(s) More...
 
virtual void SerializeLayerParameters (ParameterStringifyFunction &fn) const
 Helper to serialize the layer parameters to string. More...
 
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)
 
template<typename T >
std::shared_ptr< T > GetAdditionalInformation () const
 
void SetAdditionalInfoForObject (const AdditionalInfoObjectPtr &additionalInfo)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

 UnmapLayer (const char *name)
 Constructor to create a UnmapLayer. More...
 
 ~UnmapLayer ()=default
 Default destructor. 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
 
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 *LayerCreateWorkload. More...
 
template<typename LayerType , typename ... Params>
LayerType * CloneBase (Graph &graph, Params &&... params) const
 
virtual ConstantTensors GetConstantTensorsByRef ()
 
void SetAdditionalInfo (QueueDescriptor &descriptor) const
 
- Protected Member Functions inherited from IConnectableLayer
 ~IConnectableLayer ()
 Objects are not deletable via the handle. More...
 
+ + + + + + + + + + + +

+Additional Inherited Members

- Protected Types inherited from Layer
using ConstantTensors = std::vector< std::reference_wrapper< std::unique_ptr< ScopedCpuTensorHandle > >>
 
- Protected Attributes inherited from Layer
AdditionalInfoObjectPtr m_AdditionalInfoObject
 
std::vector< OutputHandler > m_OutputHandlers
 
ShapeInferenceMethod m_ShapeInferenceMethod
 
+

Detailed Description

+

This layer represents a memory copy operation.

+ +

Definition at line 13 of file UnmapLayer.hpp.

+

Constructor & Destructor Documentation

+ +

◆ UnmapLayer()

+ +
+
+ + + + + +
+ + + + + + + + +
UnmapLayer (const char * name)
+ 		+protected
+
+ +

Constructor to create a UnmapLayer.

+
Parameters
+ + +
[in]nameOptional name for the layer.
+
+
+ +

Definition at line 17 of file UnmapLayer.cpp.

+ +

References armnn::Unmap.

+
18  : Layer(1, 0, LayerType::Unmap, name)
19 {
20 }
armnn::Layer::Layer
Layer(unsigned int numInputSlots, unsigned int numOutputSlots, LayerType type, const char *name)
Definition: Layer.cpp:218
+ +
+
+
+ +

◆ ~UnmapLayer()

+ +
+
+ + + + + +
+ + + + + + + +
~UnmapLayer ()
+ 		+protecteddefault
+
+ +

Default destructor.

+ +
+
+

Member Function Documentation

+ +

◆ Accept()

+ +
+
+ + + + + +
+ + + + + + + + +
void Accept (ILayerVisitor & visitor) const
+ 		+overridevirtual
+
+ +

Apply a visitor to this layer.

+ +

Implements IConnectableLayer.

+ +

Definition at line 44 of file UnmapLayer.cpp.

+ +

References armnn::IgnoreUnused().

+
45 {
46  IgnoreUnused(visitor);
47  throw armnn::Exception("UnmapLayer should not appear in an input graph");
48 }
armnn::IgnoreUnused
void IgnoreUnused(Ts &&...)
Definition: IgnoreUnused.hpp:14
+
armnn::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
+
+
+
+ +

◆ Clone()

+ +
+
+ + + + + +
+ + + + + + + + +
UnmapLayer * 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 22 of file UnmapLayer.cpp.

+ +

References Layer::GetName().

+
23 {
24  return CloneBase<UnmapLayer>(graph, GetName());
25 }
armnn::Layer::GetName
const char * GetName() const override
Returns the name of the layer.
Definition: Layer.hpp:311
+
+
+
+ +

◆ CreateWorkload()

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

Makes a workload for the Unmap 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 27 of file UnmapLayer.cpp.

+ +

References armnn::IgnoreUnused(), Layer::PrepInfoAndDesc(), and Layer::SetAdditionalInfo().

+
28 {
29  IgnoreUnused(factory);
30  UnmapQueueDescriptor descriptor;
31  SetAdditionalInfo(descriptor);
32 
33  //This is different from other workloads. Does not get created by the workload factory.
34  return std::make_unique<UnmapWorkload>(descriptor, PrepInfoAndDesc(descriptor));
35 }
armnn::IgnoreUnused
void IgnoreUnused(Ts &&...)
Definition: IgnoreUnused.hpp:14
+
armnn::Layer::PrepInfoAndDesc
WorkloadInfo PrepInfoAndDesc(QueueDescriptor &descriptor) const
Helper function to reduce duplication in *LayerCreateWorkload.
Definition: Layer.hpp:381
+
armnn::Layer::SetAdditionalInfo
void SetAdditionalInfo(QueueDescriptor &descriptor) const
Definition: Layer.cpp:245
+
+
+
+ +

◆ ValidateTensorShapesFromInputs()

+ +
+
+ + + + + +
+ + + + + + + +
void ValidateTensorShapesFromInputs ()
+ 		+overridevirtual
+
+ +

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

+
Parameters
+ + +
[in]shapeInferenceMethodIndicates if output shape shall be overwritten or just validated.
+
+
+ +

Implements Layer.

+ +

Definition at line 37 of file UnmapLayer.cpp.

+ +

References ARMNN_ASSERT, CHECK_LOCATION, Layer::GetNumOutputSlots(), and Layer::VerifyLayerConnections().

+
38 {
39  // validates that the input is connected.
40  VerifyLayerConnections(1, CHECK_LOCATION());
41  ARMNN_ASSERT(GetNumOutputSlots() == 0);
42 }
armnn::Layer::GetNumOutputSlots
unsigned int GetNumOutputSlots() const override
Returns the number of connectable output slots.
Definition: Layer.hpp:314
+
armnn::Layer::VerifyLayerConnections
void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &location) const
Definition: Layer.cpp:348
+
ARMNN_ASSERT
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
CHECK_LOCATION
#define CHECK_LOCATION()
Definition: Exceptions.hpp:197
+
+
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1