From 6f92c8e9f8bb38dcf5dccf8deeff5112ecd8e37c Mon Sep 17 00:00:00 2001 From: Nikhil Raj Date: Wed, 22 Nov 2023 11:41:15 +0000 Subject: Update Doxygen for 23.11 Signed-off-by: Nikhil Raj Change-Id: I47cd933f5002cb94a73aa97689d7b3d9c93cb849 --- ...classarmnn_1_1_managed_const_tensor_handle.html | 437 +++++++++++++++++++++ 1 file changed, 437 insertions(+) create mode 100644 23.11/classarmnn_1_1_managed_const_tensor_handle.html (limited to '23.11/classarmnn_1_1_managed_const_tensor_handle.html') diff --git a/23.11/classarmnn_1_1_managed_const_tensor_handle.html b/23.11/classarmnn_1_1_managed_const_tensor_handle.html new file mode 100644 index 0000000000..54a3e25781 --- /dev/null +++ b/23.11/classarmnn_1_1_managed_const_tensor_handle.html @@ -0,0 +1,437 @@ + + + + + + + + +Arm NN: ManagedConstTensorHandle Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  23.11 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
ManagedConstTensorHandle Class Reference
+
+
+ +

#include <TensorHandle.hpp>

+ + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ManagedConstTensorHandle (std::shared_ptr< ConstTensorHandle > ptr)
 
const void * Map (bool blocking=true)
 RAII Managed resource Unmaps MemoryArea once out of scope. More...
 
 ManagedConstTensorHandle (const ConstTensorHandle &other)=delete
 
ManagedConstTensorHandle & operator= (const ManagedConstTensorHandle &other)=delete
 
ManagedConstTensorHandle & operator= (ManagedConstTensorHandle &&other) noexcept=delete
 
 ~ManagedConstTensorHandle ()
 
void Unmap ()
 
const TensorInfo & GetTensorInfo () const
 
bool IsMapped () const
 
+

Detailed Description

+
+

Definition at line 187 of file TensorHandle.hpp.

+

Constructor & Destructor Documentation

+ +

◆ ManagedConstTensorHandle() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
ManagedConstTensorHandle (std::shared_ptr< ConstTensorHandle > ptr)
+ 		+inlineexplicit
+
+ +

Definition at line 191 of file TensorHandle.hpp.

+
192  : m_Mapped(false)
+
193  , m_TensorHandle(std::move(ptr)) {};
+
+
+
+ +

◆ ManagedConstTensorHandle() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
ManagedConstTensorHandle (const ConstTensorHandle & other)
+ 		+delete
+
+ +
+
+ +

◆ ~ManagedConstTensorHandle()

+ +
+
+ + + + + +
+ + + + + + + +
~ManagedConstTensorHandle ()
+ 		+inline
+
+ +

Definition at line 220 of file TensorHandle.hpp.

+
221  {
+
222  // Bias tensor handles need to be initialized empty before entering scope of if statement checking if enabled
+
223  if (m_TensorHandle)
+
224  {
+
225  Unmap();
+
226  }
+
227  }
+
+

References ManagedConstTensorHandle::Unmap().

+ +
+
+

Member Function Documentation

+ +

◆ GetTensorInfo()

+ +
+
+ + + + + +
+ + + + + + + +
const TensorInfo& GetTensorInfo () const
+ 		+inline
+
+ +

Definition at line 239 of file TensorHandle.hpp.

+
240  {
+
241  return m_TensorHandle->GetTensorInfo();
+
242  }
+
+

Referenced by BatchNormalizationLayer::ExecuteStrategy(), ConstantLayer::ExecuteStrategy(), DetectionPostProcessLayer::ExecuteStrategy(), TransposeConvolution2dLayer::ExecuteStrategy(), LstmLayer::ExecuteStrategy(), UnidirectionalSequenceLstmLayer::ExecuteStrategy(), QuantizedLstmLayer::ExecuteStrategy(), and QLstmLayer::ExecuteStrategy().

+ +
+
+ +

◆ IsMapped()

+ +
+
+ + + + + +
+ + + + + + + +
bool IsMapped () const
+ 		+inline
+
+ +

Definition at line 244 of file TensorHandle.hpp.

+
245  {
+
246  return m_Mapped;
+
247  }
+
+
+
+ +

◆ Map()

+ +
+
+ + + + + +
+ + + + + + + + +
const void* Map (bool blocking = true)
+ 		+inline
+
+ +

RAII Managed resource Unmaps MemoryArea once out of scope.

+ +

Definition at line 196 of file TensorHandle.hpp.

+
197  {
+
198  if (m_TensorHandle)
+
199  {
+
200  auto pRet = m_TensorHandle->Map(blocking);
+
201  m_Mapped = true;
+
202  return pRet;
+
203  }
+
204  else
+
205  {
+
206  throw armnn::Exception("Attempting to Map null TensorHandle");
+
207  }
+
208 
+
209  }
+
+

Referenced by BatchNormalizationLayer::ExecuteStrategy(), ConstantLayer::ExecuteStrategy(), DetectionPostProcessLayer::ExecuteStrategy(), TransposeConvolution2dLayer::ExecuteStrategy(), LstmLayer::ExecuteStrategy(), UnidirectionalSequenceLstmLayer::ExecuteStrategy(), QuantizedLstmLayer::ExecuteStrategy(), and QLstmLayer::ExecuteStrategy().

+ +
+
+ +

◆ operator=() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + +
ManagedConstTensorHandle& operator= (const ManagedConstTensorHandle & other)
+ 		+delete
+
+ +
+
+ +

◆ operator=() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
ManagedConstTensorHandle& operator= (ManagedConstTensorHandle && other)
+ 		+deletenoexcept
+
+ +
+
+ +

◆ Unmap()

+ +
+
+ + + + + +
+ + + + + + + +
void Unmap ()
+ 		+inline
+
+ +

Definition at line 229 of file TensorHandle.hpp.

+
230  {
+
231  // Only unmap if mapped and TensorHandle exists.
+
232  if (m_Mapped && m_TensorHandle)
+
233  {
+
234  m_TensorHandle->Unmap();
+
235  m_Mapped = false;
+
236  }
+
237  }
+
+

Referenced by ManagedConstTensorHandle::~ManagedConstTensorHandle().

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ +
armnn::Exception
Base class for all ArmNN exceptions so that users can filter to just those.
Definition: Exceptions.hpp:46
+ + + + -- cgit v1.2.1