From 8d2ca734165a068478df7cffa46185680b05cd20 Mon Sep 17 00:00:00 2001 From: Nikhil Raj Date: Fri, 24 Feb 2023 10:28:19 +0000 Subject: Update Doxygen docu for 23.02 Signed-off-by: Nikhil Raj Change-Id: Ie6c19a27d50fefab2796b2b5875374e81f5bf971 --- ..._1_1experimental_1_1_i_working_mem_handle.xhtml | 379 +++++++++++++++++++++ 1 file changed, 379 insertions(+) create mode 100644 23.02/classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml (limited to '23.02/classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml') diff --git a/23.02/classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml b/23.02/classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml new file mode 100644 index 0000000000..74dd53290c --- /dev/null +++ b/23.02/classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml @@ -0,0 +1,379 @@ + + + + + + + + + + + + + +ArmNN: IWorkingMemHandle Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  23.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
IWorkingMemHandle Class Referenceabstract
+
+
+ +

#include <IWorkingMemHandle.hpp>

+
+Inheritance diagram for IWorkingMemHandle:
+
+
+ + +WorkingMemHandle + +
+ + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~IWorkingMemHandle ()
 
virtual NetworkId GetNetworkId ()=0
 Returns the NetworkId of the Network that this IWorkingMemHandle works with. More...
 
virtual void Allocate ()=0
 Allocate the backing memory required for execution. More...
 
virtual void Free ()=0
 Free the backing memory required for execution. More...
 
virtual bool IsAllocated ()=0
 IsAllocated returns true if the backing memory is currently allocated. More...
 
virtual WorkingMemDescriptor & GetWorkingMemDescriptorAt (unsigned int id)=0
 Get the WorkingMemDescriptor at an index. More...
 
virtual std::pair< BackendId, ExecutionData > & GetExecutionDataAt (unsigned int id)=0
 Get the ExecutionData at an index. More...
 
+

Detailed Description

+
+

Definition at line 20 of file IWorkingMemHandle.hpp.

+

Constructor & Destructor Documentation

+ +

◆ ~IWorkingMemHandle()

+ +
+
+ + + + + +
+ + + + + + + +
virtual ~IWorkingMemHandle ()
+ 		+inlinevirtual
+
+ +

Definition at line 23 of file IWorkingMemHandle.hpp.

+ +

References IWorkingMemHandle::Allocate(), IWorkingMemHandle::Free(), IWorkingMemHandle::GetExecutionDataAt(), IWorkingMemHandle::GetNetworkId(), IWorkingMemHandle::GetWorkingMemDescriptorAt(), and IWorkingMemHandle::IsAllocated().

+
23 {};
+
+
+

Member Function Documentation

+ +

◆ Allocate()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void Allocate ()
+ 		+pure virtual
+
+ +

Allocate the backing memory required for execution.

+

If this is not called, then allocation will be deferred to execution time.

+ +

Implemented in WorkingMemHandle.

+ +

Referenced by IWorkingMemHandle::~IWorkingMemHandle().

+ +
+
+ +

◆ Free()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void Free ()
+ 		+pure virtual
+
+ +

Free the backing memory required for execution.

+ +

Implemented in WorkingMemHandle.

+ +

Referenced by IWorkingMemHandle::~IWorkingMemHandle().

+ +
+
+ +

◆ GetExecutionDataAt()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual std::pair<BackendId, ExecutionData>& GetExecutionDataAt (unsigned int id)
+ 		+pure virtual
+
+ +

Get the ExecutionData at an index.

+

The ExecutionData is paired with a BackendId to be able to call backend specific functions upon it. The ExecutionData are stored in the same order as the Workloads in a topologically sorted graph.

+ +

Implemented in WorkingMemHandle.

+ +

Referenced by IWorkingMemHandle::~IWorkingMemHandle().

+ +
+
+ +

◆ GetNetworkId()

+ +
+
+ + + + + +
+ + + + + + + +
virtual NetworkId GetNetworkId ()
+ 		+pure virtual
+
+ +

Returns the NetworkId of the Network that this IWorkingMemHandle works with.

+ +

Implemented in WorkingMemHandle.

+ +

Referenced by RuntimeImpl::Execute(), and IWorkingMemHandle::~IWorkingMemHandle().

+ +
+
+ +

◆ GetWorkingMemDescriptorAt()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual WorkingMemDescriptor& GetWorkingMemDescriptorAt (unsigned int id)
+ 		+pure virtual
+
+ +

Get the WorkingMemDescriptor at an index.

+

The WorkingMemDescriptors are stored in the same order as the Workloads in a topologically sorted graph.

+ +

Implemented in WorkingMemHandle.

+ +

Referenced by IWorkingMemHandle::~IWorkingMemHandle().

+ +
+
+ +

◆ IsAllocated()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool IsAllocated ()
+ 		+pure virtual
+
+ +

IsAllocated returns true if the backing memory is currently allocated.

+ +

Implemented in WorkingMemHandle.

+ +

Referenced by IWorkingMemHandle::~IWorkingMemHandle().

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.1