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 --- ...n_2backends_2_i_tensor_handle_8hpp_source.xhtml | 134 +++++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 21.02/include_2armnn_2backends_2_i_tensor_handle_8hpp_source.xhtml (limited to '21.02/include_2armnn_2backends_2_i_tensor_handle_8hpp_source.xhtml') diff --git a/21.02/include_2armnn_2backends_2_i_tensor_handle_8hpp_source.xhtml b/21.02/include_2armnn_2backends_2_i_tensor_handle_8hpp_source.xhtml new file mode 100644 index 0000000000..21523ad933 --- /dev/null +++ b/21.02/include_2armnn_2backends_2_i_tensor_handle_8hpp_source.xhtml @@ -0,0 +1,134 @@ + + + + + + + + + + + + + +ArmNN: include/armnn/backends/ITensorHandle.hpp Source File + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
ITensorHandle.hpp
+
+
+Go to the documentation of this file.
1 //
2 // Copyright © 2017 Arm Ltd. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 #pragma once
6 
7 #include <armnn/MemorySources.hpp>
8 #include <armnn/utility/IgnoreUnused.hpp>
9 
10 namespace armnn
11 {
12 
13 class TensorShape;
14 
15 class ITensorHandle
16 {
17 public:
18  virtual ~ITensorHandle(){}
19 
20  /// Indicate to the memory manager that this resource is active.
21  /// This is used to compute overlapping lifetimes of resources.
22  virtual void Manage() = 0;
23 
24  /// Indicate to the memory manager that this resource is no longer active.
25  /// This is used to compute overlapping lifetimes of resources.
26  virtual void Allocate() = 0;
27 
28  /// Get the parent tensor if this is a subtensor.
29  /// \return a pointer to the parent tensor. Otherwise nullptr if not a subtensor.
30  virtual ITensorHandle* GetParent() const = 0;
31 
32  /// Map the tensor data for access.
33  /// \param blocking hint to block the calling thread until all other accesses are complete. (backend dependent)
34  /// \return pointer to the first element of the mapped data.
35  virtual const void* Map(bool blocking=true) const = 0;
36 
37  /// Unmap the tensor data
38  virtual void Unmap() const = 0;
39 
40  /// Map the tensor data for access. Must be paired with call to Unmap().
41  /// \param blocking hint to block the calling thread until all other accesses are complete. (backend dependent)
42  /// \return pointer to the first element of the mapped data.
43  void* Map(bool blocking=true)
44  {
45  return const_cast<void*>(static_cast<const ITensorHandle*>(this)->Map(blocking));
46  }
47 
48  /// Unmap the tensor data that was previously mapped with call to Map().
49  void Unmap()
50  {
51  return static_cast<const ITensorHandle*>(this)->Unmap();
52  }
53 
54  /// Get the strides for each dimension ordered from largest to smallest where
55  /// the smallest value is the same as the size of a single element in the tensor.
56  /// \return a TensorShape filled with the strides for each dimension
57  virtual TensorShape GetStrides() const = 0;
58 
59  /// Get the number of elements for each dimension ordered from slowest iterating dimension
60  /// to fastest iterating dimension.
61  /// \return a TensorShape filled with the number of elements for each dimension.
62  virtual TensorShape GetShape() const = 0;
63 
64  /// Testing support to be able to verify and set tensor data content
65  virtual void CopyOutTo(void* memory) const = 0;
66  virtual void CopyInFrom(const void* memory) = 0;
67 
68  /// Get flags describing supported import sources.
69  virtual unsigned int GetImportFlags() const { return 0; }
70 
71  /// Import externally allocated memory
72  /// \param memory base address of the memory being imported.
73  /// \param source source of the allocation for the memory being imported.
74  /// \return true on success or false on failure
75  virtual bool Import(void* memory, MemorySource source)
76  {
77  IgnoreUnused(memory, source);
78  return false;
79  };
80 };
81 
82 }
IgnoreUnused.hpp
+
armnn::ITensorHandle::Import
virtual bool Import(void *memory, MemorySource source)
Import externally allocated memory.
Definition: ITensorHandle.hpp:75
+
armnn::ITensorHandle::GetImportFlags
virtual unsigned int GetImportFlags() const
Get flags describing supported import sources.
Definition: ITensorHandle.hpp:69
+
armnn::ITensorHandle::GetStrides
virtual TensorShape GetStrides() const =0
Get the strides for each dimension ordered from largest to smallest where the smallest value is the s...
+
armnn::ITensorHandle::Allocate
virtual void Allocate()=0
Indicate to the memory manager that this resource is no longer active.
+
armnn::ITensorHandle::Manage
virtual void Manage()=0
Indicate to the memory manager that this resource is active.
+
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_software_tools.dox:6
+
armnn::IgnoreUnused
void IgnoreUnused(Ts &&...)
Definition: IgnoreUnused.hpp:14
+ +
MemorySources.hpp
+ + +
armnn::ITensorHandle::Unmap
void Unmap()
Unmap the tensor data that was previously mapped with call to Map().
Definition: ITensorHandle.hpp:49
+
armnn::ITensorHandle::GetParent
virtual ITensorHandle * GetParent() const =0
Get the parent tensor if this is a subtensor.
+
armnn::ITensorHandle::GetShape
virtual TensorShape GetShape() const =0
Get the number of elements for each dimension ordered from slowest iterating dimension to fastest ite...
+
armnn::ITensorHandle::CopyOutTo
virtual void CopyOutTo(void *memory) const =0
Testing support to be able to verify and set tensor data content.
+
armnn::ITensorHandle::Map
virtual const void * Map(bool blocking=true) const =0
Map the tensor data for access.
+
armnn::ITensorHandle::Unmap
virtual void Unmap() const =0
Unmap the tensor data.
+
armnn::ITensorHandle::CopyInFrom
virtual void CopyInFrom(const void *memory)=0
+ +
armnn::ITensorHandle::Map
void * Map(bool blocking=true)
Map the tensor data for access.
Definition: ITensorHandle.hpp:43
+
+
+ + + + -- cgit v1.2.1