ArmNN
 24.02
ConstTensorHandle Class Reference

#include <TensorHandle.hpp>

Inheritance diagram for ConstTensorHandle:
[legend]
Collaboration diagram for ConstTensorHandle:
[legend]

Public Member Functions

template<typename T >
const T * GetConstTensor () const
 
const TensorInfoGetTensorInfo () const
 
virtual void Manage () override
 Indicate to the memory manager that this resource is active. More...
 
virtual ITensorHandleGetParent () const override
 Get the parent tensor if this is a subtensor. More...
 
virtual const void * Map (bool) const override
 Map the tensor data for access. More...
 
virtual void Unmap () const override
 Unmap the tensor data. More...
 
TensorShape GetStrides () const override
 Get the strides for each dimension ordered from largest to smallest where the smallest value is the same as the size of a single element in the tensor. More...
 
TensorShape GetShape () const override
 Get the number of elements for each dimension ordered from slowest iterating dimension to fastest iterating dimension. More...
 
template<>
const void * GetConstTensor () const
 
template<>
const void * GetConstTensor () const
 
- Public Member Functions inherited from ITensorHandle
virtual ~ITensorHandle ()
 
virtual void Allocate ()=0
 Indicate to the memory manager that this resource is no longer active. More...
 
void * Map (bool blocking=true)
 Map the tensor data for access. More...
 
void Unmap ()
 Unmap the tensor data that was previously mapped with call to Map(). More...
 
virtual unsigned int GetImportFlags () const
 Get flags describing supported import sources. More...
 
virtual bool Import (void *memory, MemorySource source)
 Import externally allocated memory. More...
 
virtual bool CanBeImported (void *memory, MemorySource source)
 Implementations must determine if this memory block can be imported. More...
 
virtual void Unimport ()
 Unimport externally allocated memory. More...
 
virtual std::shared_ptr< ITensorHandleDecorateTensorHandle (const TensorInfo &tensorInfo)
 Returns a decorated version of this TensorHandle allowing us to override the TensorInfo for it. More...
 

Protected Member Functions

 ConstTensorHandle (const TensorInfo &tensorInfo)
 
void SetConstMemory (const void *mem)
 

Detailed Description

Definition at line 24 of file TensorHandle.hpp.

Constructor & Destructor Documentation

◆ ConstTensorHandle()

ConstTensorHandle ( const TensorInfo tensorInfo)
protected

Definition at line 31 of file TensorHandle.cpp.

32 : m_TensorInfo(tensorInfo)
33 , m_Memory(nullptr)
34 {
35 }

Member Function Documentation

◆ GetConstTensor() [1/3]

const T* GetConstTensor ( ) const
inline

Definition at line 28 of file TensorHandle.hpp.

29  {
30  if (armnnUtils::CompatibleTypes<T>(GetTensorInfo().GetDataType()))
31  {
32  return reinterpret_cast<const T*>(m_Memory);
33  }
34  else
35  {
36  throw armnn::Exception("Attempting to get not compatible type tensor!");
37  }
38  }

References ConstTensorHandle::GetTensorInfo().

Referenced by ClConstantWorkload::Execute(), GpuFsaConstantWorkload::Execute(), armnn::InitializeArmComputeTensorData(), armnn::PermuteTensor(), and ScopedTensorHandle::ScopedTensorHandle().

◆ GetConstTensor() [2/3]

const void* GetConstTensor ( ) const

Definition at line 38 of file TensorHandle.cpp.

39 {
40  return m_Memory;
41 }

◆ GetConstTensor() [3/3]

const void * GetConstTensor ( ) const

◆ GetParent()

virtual ITensorHandle* GetParent ( ) const
inlineoverridevirtual

Get the parent tensor if this is a subtensor.

Returns
a pointer to the parent tensor. Otherwise nullptr if not a subtensor.

Implements ITensorHandle.

Definition at line 47 of file TensorHandle.hpp.

47 { return nullptr; }

◆ GetShape()

TensorShape GetShape ( ) const
inlineoverridevirtual

Get the number of elements for each dimension ordered from slowest iterating dimension to fastest iterating dimension.

Returns
a TensorShape filled with the number of elements for each dimension.

Implements ITensorHandle.

Definition at line 56 of file TensorHandle.hpp.

56 { return m_TensorInfo.GetShape(); }

References TensorInfo::GetShape().

Referenced by LstmQueueDescriptor::Validate(), and UnidirectionalSequenceLstmQueueDescriptor::Validate().

◆ GetStrides()

TensorShape GetStrides ( ) const
inlineoverridevirtual

Get the strides for each dimension ordered from largest to smallest where the smallest value is the same as the size of a single element in the tensor.

Returns
a TensorShape filled with the strides for each dimension

Implements ITensorHandle.

Definition at line 52 of file TensorHandle.hpp.

53  {
54  return GetUnpaddedTensorStrides(m_TensorInfo);
55  }

References armnn::GetUnpaddedTensorStrides().

◆ GetTensorInfo()

◆ Manage()

virtual void Manage ( )
inlineoverridevirtual

Indicate to the memory manager that this resource is active.

This is used to compute overlapping lifetimes of resources.

Implements ITensorHandle.

Definition at line 45 of file TensorHandle.hpp.

45 {}

◆ Map()

virtual const void* Map ( bool  blocking) const
inlineoverridevirtual

Map the tensor data for access.

Parameters
blockinghint to block the calling thread until all other accesses are complete. (backend dependent)
Returns
pointer to the first element of the mapped data.

Implements ITensorHandle.

Definition at line 49 of file TensorHandle.hpp.

49 { return m_Memory; }

◆ SetConstMemory()

void SetConstMemory ( const void *  mem)
inlineprotected

Definition at line 61 of file TensorHandle.hpp.

61 { m_Memory = mem; }

Referenced by ConstPassthroughTensorHandle::ConstPassthroughTensorHandle(), and TensorHandle::SetMemory().

◆ Unmap()

virtual void Unmap ( ) const
inlineoverridevirtual

Unmap the tensor data.

Implements ITensorHandle.

Definition at line 50 of file TensorHandle.hpp.

50 {}

The documentation for this class was generated from the following files:
armnn::GetUnpaddedTensorStrides
TensorShape GetUnpaddedTensorStrides(const TensorInfo &tensorInfo)
Definition: TensorHandle.cpp:15
armnn::ConstTensorHandle::GetTensorInfo
const TensorInfo & GetTensorInfo() const
Definition: TensorHandle.hpp:40
armnn::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:193