ArmNN
 24.02
IWorkingMemHandle Class Referenceabstract

#include <IWorkingMemHandle.hpp>

Inheritance diagram for IWorkingMemHandle:
[legend]

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 WorkingMemDescriptorGetWorkingMemDescriptorAt (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.

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.

◆ Free()

virtual void Free ( )
pure virtual

Free the backing memory required for execution.

Implemented in WorkingMemHandle.

◆ 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.

◆ GetNetworkId()

virtual NetworkId GetNetworkId ( )
pure virtual

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

Implemented in WorkingMemHandle.

Referenced by RuntimeImpl::Execute().

◆ 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.

◆ IsAllocated()

virtual bool IsAllocated ( )
pure virtual

IsAllocated returns true if the backing memory is currently allocated.

Implemented in WorkingMemHandle.


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