From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- 21.02/classarmnn_1_1_base_tensor.xhtml | 602 +++++++++++++++++++++++++++++++++ 1 file changed, 602 insertions(+) create mode 100644 21.02/classarmnn_1_1_base_tensor.xhtml (limited to '21.02/classarmnn_1_1_base_tensor.xhtml') diff --git a/21.02/classarmnn_1_1_base_tensor.xhtml b/21.02/classarmnn_1_1_base_tensor.xhtml new file mode 100644 index 0000000000..11c755d8f2 --- /dev/null +++ b/21.02/classarmnn_1_1_base_tensor.xhtml @@ -0,0 +1,602 @@ + + + + + + + + + + + + + +ArmNN: BaseTensor< MemoryType > Class Template Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
BaseTensor< MemoryType > Class Template Reference
+
+
+ +

#include <Tensor.hpp>

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

+Public Member Functions

 BaseTensor ()
 Empty (invalid) constructor. More...
 
 BaseTensor (const TensorInfo &info, MemoryType memoryArea)
 Constructor from a raw memory pointer. More...
 
 BaseTensor (const BaseTensor &other)
 Tensors are copyable. More...
 
BaseTensor & operator= (const BaseTensor &)
 Tensors are copyable. More...
 
const TensorInfo & GetInfo () const
 
TensorInfo & GetInfo ()
 
const TensorShape & GetShape () const
 
TensorShape & GetShape ()
 
DataType GetDataType () const
 
unsigned int GetNumDimensions () const
 
unsigned int GetNumBytes () const
 
unsigned int GetNumElements () const
 
MemoryType GetMemoryArea () const
 
+ + + + +

+Protected Member Functions

 ~BaseTensor ()
 Protected destructor to stop users from making these (could still new one on the heap and then leak it...) More...
 
+ + + +

+Protected Attributes

MemoryType m_MemoryArea
 
+

Detailed Description

+

template<typename MemoryType>
+class armnn::BaseTensor< MemoryType >

+ + +

Definition at line 264 of file Tensor.hpp.

+

Constructor & Destructor Documentation

+ +

◆ BaseTensor() [1/3]

+ +
+
+ + + + + + + +
BaseTensor ()
+
+ +

Empty (invalid) constructor.

+ +

Definition at line 505 of file Tensor.cpp.

+
506  : m_MemoryArea(nullptr)
507 {
508 }
armnn::BaseTensor::m_MemoryArea
MemoryType m_MemoryArea
Definition: Tensor.hpp:299
+
+
+
+ +

◆ BaseTensor() [2/3]

+ +
+
+ + + + + + + + + + + + + + + + + + +
BaseTensor (const TensorInfo & info,
MemoryType memoryArea 
)
+
+ +

Constructor from a raw memory pointer.

+
Parameters
+ + +
memoryArea- Region of CPU-addressable memory where tensor data will be stored. Must be valid while workloads are on the fly. Tensor instances do not claim ownership of referenced memory regions, that is, no attempt will be made by ArmNN to free these memory regions automatically.
+
+
+ +

Definition at line 511 of file Tensor.cpp.

+
512  : m_MemoryArea(memoryArea)
513  , m_Info(info)
514 {
515 }
armnn::BaseTensor::m_MemoryArea
MemoryType m_MemoryArea
Definition: Tensor.hpp:299
+ +
+
+
+ +

◆ BaseTensor() [3/3]

+ +
+
+ + + + + + + + +
BaseTensor (const BaseTensor< MemoryType > & other)
+
+ +

Tensors are copyable.

+ +
+
+ +

◆ ~BaseTensor()

+ +
+
+ + + + + +
+ + + + + + + +
~BaseTensor ()
+ 		+inlineprotected
+
+ +

Protected destructor to stop users from making these (could still new one on the heap and then leak it...)

+ +

Definition at line 297 of file Tensor.hpp.

+
297 {}
+
+
+

Member Function Documentation

+ +

◆ GetDataType()

+ +
+
+ + + + + +
+ + + + + + + +
DataType GetDataType () const
+ 		+inline
+
+ +

Definition at line 287 of file Tensor.hpp.

+ +

Referenced by CompareConstTensor(), and armnn::ConvertWeightTensorFromArmnnToAcl().

+
287 { return m_Info.GetDataType(); }
armnn::TensorInfo::GetDataType
DataType GetDataType() const
Definition: Tensor.hpp:194
+
+
+
+ +

◆ GetInfo() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
const TensorInfo& GetInfo () const
+ 		+inline
+
+ +

Definition at line 282 of file Tensor.hpp.

+ +

Referenced by BaseTensor< const void *>::BaseTensor(), BOOST_AUTO_TEST_CASE(), TestLayerVisitor::CheckConstTensors(), CheckTensor(), armnn::ConvertWeightTensorFromArmnnToAcl(), armnn::CreateQuantizedConst(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), armnn::GetInputTensorInfo(), QuantizerStrategy::QuantizerStrategy(), armnn::ReorderWeightChannelsForAcl(), and LayerVerifierBase::VerifyConstTensors().

+
282 { return m_Info; }
+
+
+ +

◆ GetInfo() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
TensorInfo& GetInfo ()
+ 		+inline
+
+ +

Definition at line 283 of file Tensor.hpp.

+
283 { return m_Info; }
+
+
+ +

◆ GetMemoryArea()

+ +
+
+ + + + + +
+ + + + + + + +
MemoryType GetMemoryArea () const
+ 		+inline
+
+ +

Definition at line 292 of file Tensor.hpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), TestLayerVisitor::CheckConstTensors(), CompareConstTensor(), armnn::CreateQuantizedConst(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), ScopedCpuTensorHandle::ScopedCpuTensorHandle(), and LayerVerifierBase::VerifyConstTensors().

+
292 { return m_MemoryArea; }
armnn::BaseTensor::m_MemoryArea
MemoryType m_MemoryArea
Definition: Tensor.hpp:299
+
+
+
+ +

◆ GetNumBytes()

+ +
+
+ + + + + +
+ + + + + + + +
unsigned int GetNumBytes () const
+ 		+inline
+
+ +

Definition at line 289 of file Tensor.hpp.

+ +

Referenced by TestLayerVisitor::CheckConstTensors(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), ScopedCpuTensorHandle::ScopedCpuTensorHandle(), and LayerVerifierBase::VerifyConstTensors().

+
289 { return m_Info.GetNumBytes(); }
armnn::TensorInfo::GetNumBytes
unsigned int GetNumBytes() const
Definition: Tensor.cpp:418
+
+
+
+ +

◆ GetNumDimensions()

+ +
+
+ + + + + +
+ + + + + + + +
unsigned int GetNumDimensions () const
+ 		+inline
+
+ +

Definition at line 288 of file Tensor.hpp.

+ +

Referenced by TestLayerVisitor::CheckConstTensors().

+
288 { return m_Info.GetNumDimensions(); }
armnn::TensorInfo::GetNumDimensions
unsigned int GetNumDimensions() const
Definition: Tensor.hpp:191
+
+
+
+ +

◆ GetNumElements()

+ +
+
+ + + + + +
+ + + + + + + +
unsigned int GetNumElements () const
+ 		+inline
+
+ +

Definition at line 290 of file Tensor.hpp.

+ +

Referenced by TestLayerVisitor::CheckConstTensors(), and CompareConstTensor().

+
290 { return m_Info.GetNumElements(); }
armnn::TensorInfo::GetNumElements
unsigned int GetNumElements() const
Definition: Tensor.hpp:192
+
+
+
+ +

◆ GetShape() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
const TensorShape& GetShape () const
+ 		+inline
+
+ +

Definition at line 284 of file Tensor.hpp.

+ +

Referenced by ITfParser::TfParserImpl::AddFullyConnectedLayer(), BOOST_AUTO_TEST_CASE(), armnnTfParser::CheckPaddingTensor(), CompareConstTensor(), ITfParser::TfParserImpl::ParseConv2D(), ITfParser::TfParserImpl::ParseDepthwiseConv2D(), and armnn::ReorderWeightChannelsForAcl().

+
284 { return m_Info.GetShape(); }
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:187
+
+
+
+ +

◆ GetShape() [2/2]

+ +
+
+ + + + + +
+ + + + + + + +
TensorShape& GetShape ()
+ 		+inline
+
+ +

Definition at line 285 of file Tensor.hpp.

+
285 { return m_Info.GetShape(); }
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:187
+
+
+
+ +

◆ operator=()

+ +
+
+ + + + + + + + +
BaseTensor< MemoryType > & operator= (const BaseTensor< MemoryType > & )
+
+ +

Tensors are copyable.

+ +

Definition at line 525 of file Tensor.cpp.

+
526 {
527  m_Info = other.m_Info;
528  m_MemoryArea = other.m_MemoryArea;
529  return *this;
530 }
armnn::BaseTensor::m_MemoryArea
MemoryType m_MemoryArea
Definition: Tensor.hpp:299
+
+
+
+

Member Data Documentation

+ +

◆ m_MemoryArea

+ +
+
+ + + + + +
+ + + + +
MemoryType m_MemoryArea
+ 		+protected
+
+ +

Definition at line 299 of file Tensor.hpp.

+ +

Referenced by BaseTensor< const void *>::BaseTensor(), and BaseTensor< const void *>::operator=().

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