From de36e4a9c299028e792c3a5bd99ad0816d806077 Mon Sep 17 00:00:00 2001 From: Ryan OShea Date: Fri, 13 Mar 2020 16:26:19 +0000 Subject: IVGCVSW-3726 Upload ArmNN Doxygen files * Upload current ArmNN Doxygen files Signed-off-by: Ryan OShea Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285 --- .../classarmnn_1_1_neon_sub_tensor_handle.xhtml | 577 +++++++++++++++++++++ 1 file changed, 577 insertions(+) create mode 100644 Documentation/classarmnn_1_1_neon_sub_tensor_handle.xhtml (limited to 'Documentation/classarmnn_1_1_neon_sub_tensor_handle.xhtml') diff --git a/Documentation/classarmnn_1_1_neon_sub_tensor_handle.xhtml b/Documentation/classarmnn_1_1_neon_sub_tensor_handle.xhtml new file mode 100644 index 0000000000..92e039ed84 --- /dev/null +++ b/Documentation/classarmnn_1_1_neon_sub_tensor_handle.xhtml @@ -0,0 +1,577 @@ + + + + + + + + + + + + + +ArmNN: NeonSubTensorHandle Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  20.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
NeonSubTensorHandle Class Reference
+
+
+ +

#include <NeonTensorHandle.hpp>

+
+Inheritance diagram for NeonSubTensorHandle:
+
+
+ + +IAclTensorHandle +ITensorHandle + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NeonSubTensorHandle (IAclTensorHandle *parent, const arm_compute::TensorShape &shape, const arm_compute::Coordinates &coords)
 
arm_compute::ITensor & GetTensor () override
 
arm_compute::ITensor const & GetTensor () const override
 
virtual void Allocate () override
 Indicate to the memory manager that this resource is no longer active. More...
 
virtual void Manage () override
 Indicate to the memory manager that this resource is active. More...
 
virtual ITensorHandle * GetParent () const override
 Get the parent tensor if this is a subtensor. More...
 
virtual arm_compute::DataType GetDataType () const override
 
virtual void SetMemoryGroup (const std::shared_ptr< arm_compute::IMemoryGroup > &) override
 
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...
 
- Public Member Functions inherited from ITensorHandle
virtual ~ITensorHandle ()
 
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...
 
+

Detailed Description

+
+

Definition at line 240 of file NeonTensorHandle.hpp.

+

Constructor & Destructor Documentation

+ +

◆ NeonSubTensorHandle()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
NeonSubTensorHandle (IAclTensorHandle * parent,
const arm_compute::TensorShape & shape,
const arm_compute::Coordinates & coords 
)
+ 		+inline
+
+ +

Definition at line 243 of file NeonTensorHandle.hpp.

+
246  : m_Tensor(&parent->GetTensor(), shape, coords)
247  {
248  parentHandle = parent;
249  }
+
+
+

Member Function Documentation

+ +

◆ Allocate()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void Allocate ()
+ 		+inlineoverridevirtual
+
+ +

Indicate to the memory manager that this resource is no longer active.

+

This is used to compute overlapping lifetimes of resources.

+ +

Implements ITensorHandle.

+ +

Definition at line 254 of file NeonTensorHandle.hpp.

+
254 {}
+
+
+ +

◆ GetDataType()

+ +
+
+ + + + + +
+ + + + + + + +
virtual arm_compute::DataType GetDataType () const
+ 		+inlineoverridevirtual
+
+ +

Implements IAclTensorHandle.

+ +

Definition at line 259 of file NeonTensorHandle.hpp.

+
260  {
261  return m_Tensor.info()->data_type();
262  }
+
+
+ +

◆ 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 257 of file NeonTensorHandle.hpp.

+
257 { return parentHandle; }
+
+
+ +

◆ 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 277 of file NeonTensorHandle.hpp.

+
278  {
279  return armcomputetensorutils::GetShape(m_Tensor.info()->tensor_shape());
280  }
+
+
+ +

◆ 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 272 of file NeonTensorHandle.hpp.

+
273  {
274  return armcomputetensorutils::GetStrides(m_Tensor.info()->strides_in_bytes());
275  }
+
+
+ +

◆ GetTensor() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
arm_compute::ITensor& GetTensor ()
+ 		+inlineoverridevirtual
+
+ +

Implements IAclTensorHandle.

+ +

Definition at line 251 of file NeonTensorHandle.hpp.

+
251 { return m_Tensor; }
+
+
+ +

◆ GetTensor() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
arm_compute::ITensor const& GetTensor () const
+ 		+inlineoverridevirtual
+
+ +

Implements IAclTensorHandle.

+ +

Definition at line 252 of file NeonTensorHandle.hpp.

+
252 { return m_Tensor; }
+
+
+ +

◆ 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 255 of file NeonTensorHandle.hpp.

+
255 {}
+
+
+ +

◆ 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 266 of file NeonTensorHandle.hpp.

+
267  {
268  return static_cast<const void*>(m_Tensor.buffer() + m_Tensor.info()->offset_first_element_in_bytes());
269  }
+
+
+ +

◆ SetMemoryGroup()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual void SetMemoryGroup (const std::shared_ptr< arm_compute::IMemoryGroup > & )
+ 		+inlineoverridevirtual
+
+ +

Implements IAclTensorHandle.

+ +

Definition at line 264 of file NeonTensorHandle.hpp.

+
264 {}
+
+
+ +

◆ Unmap()

+ +
+
+ + + + + +
+ + + + + + + +
virtual void Unmap () const
+ 		+inlineoverridevirtual
+
+ +

Unmap the tensor data.

+ +

Implements ITensorHandle.

+ +

Definition at line 270 of file NeonTensorHandle.hpp.

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