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_const_tensor.xhtml | 298 ++++++++++++++++++++++++++++++++ 1 file changed, 298 insertions(+) create mode 100644 21.02/classarmnn_1_1_const_tensor.xhtml (limited to '21.02/classarmnn_1_1_const_tensor.xhtml') diff --git a/21.02/classarmnn_1_1_const_tensor.xhtml b/21.02/classarmnn_1_1_const_tensor.xhtml new file mode 100644 index 0000000000..cfc17be8aa --- /dev/null +++ b/21.02/classarmnn_1_1_const_tensor.xhtml @@ -0,0 +1,298 @@ + + + + + + + + + + + + + +ArmNN: ConstTensor Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
ConstTensor Class Reference
+
+
+ +

A tensor defined by a TensorInfo (shape and data type) and an immutable backing store. + More...

+ +

#include <Tensor.hpp>

+
+Inheritance diagram for ConstTensor:
+
+
+ + +BaseTensor< const void *> + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ConstTensor ()
 
 ConstTensor (const Tensor &other)
 Can be implicitly constructed from non-const Tensor. More...
 
template<template< typename, typename... > class ContainerType, typename T , typename... ContainerArgs>
 ConstTensor (const TensorInfo &info, const ContainerType< T, ContainerArgs... > &container)
 Constructor from a backing container. More...
 
- Public Member Functions inherited from BaseTensor< const void *>
 BaseTensor ()
 Empty (invalid) constructor. More...
 
 BaseTensor (const TensorInfo &info, const void * 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
 
const void * GetMemoryArea () const
 
+ + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from BaseTensor< const void *>
 ~BaseTensor ()
 Protected destructor to stop users from making these (could still new one on the heap and then leak it...) More...
 
- Protected Attributes inherited from BaseTensor< const void *>
const void * m_MemoryArea
 
+

Detailed Description

+

A tensor defined by a TensorInfo (shape and data type) and an immutable backing store.

+ +

Definition at line 314 of file Tensor.hpp.

+

Constructor & Destructor Documentation

+ +

◆ ConstTensor() [1/3]

+ +
+
+ + + + + +
+ + + + + + + +
ConstTensor ()
+ 		+inline
+
+ +

Definition at line 319 of file Tensor.hpp.

+
319 : BaseTensor<const void*>() {} // This needs to be redefined explicitly??
+
+
+ +

◆ ConstTensor() [2/3]

+ +
+
+ + + + + +
+ + + + + + + + +
ConstTensor (const Tensor & other)
+ 		+inline
+
+ +

Can be implicitly constructed from non-const Tensor.

+ +

Definition at line 322 of file Tensor.hpp.

+
322 : BaseTensor<const void*>(other.GetInfo(), other.GetMemoryArea()) {}
+
+
+ +

◆ ConstTensor() [3/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
ConstTensor (const TensorInfo & info,
const ContainerType< T, ContainerArgs... > & container 
)
+ 		+inline
+
+ +

Constructor from a backing container.

+
Parameters
+ + +
container- An stl-like container type which implements data() and size() methods. Presence of data() and size() is a strong indicator of the continuous memory layout of the container, which is a requirement for Tensor data. 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 330 of file Tensor.hpp.

+ +

References TensorInfo::GetNumBytes().

+
331  : BaseTensor<const void*>(info, container.data())
332  {
333  if (container.size() * sizeof(T) != info.GetNumBytes())
334  {
335  throw InvalidArgumentException("Container size is not correct");
336  }
337  }
+
+
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.1