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/_cpu_tensor_handle_8hpp_source.xhtml | 147 +++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 21.02/_cpu_tensor_handle_8hpp_source.xhtml (limited to '21.02/_cpu_tensor_handle_8hpp_source.xhtml') diff --git a/21.02/_cpu_tensor_handle_8hpp_source.xhtml b/21.02/_cpu_tensor_handle_8hpp_source.xhtml new file mode 100644 index 0000000000..fc95132355 --- /dev/null +++ b/21.02/_cpu_tensor_handle_8hpp_source.xhtml @@ -0,0 +1,147 @@ + + + + + + + + + + + + + +ArmNN: src/backends/backendsCommon/CpuTensorHandle.hpp Source File + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
CpuTensorHandle.hpp
+
+
+Go to the documentation of this file.
1 //
2 // Copyright © 2017 Arm Ltd. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
6 #pragma once
7 
8 #include <armnn/backends/CpuTensorHandleFwd.hpp>
9 #include <armnn/backends/ITensorHandle.hpp>
10 
11 #include <armnn/TypesUtils.hpp>
12 
13 #include <CompatibleTypes.hpp>
14 
15 #include <algorithm>
16 
17 #include <armnn/utility/Assert.hpp>
18 
19 namespace armnn
20 {
21 
22 // Get a TensorShape representing the strides (in bytes) for each dimension
23 // of a tensor, assuming fully packed data with no padding
24 TensorShape GetUnpaddedTensorStrides(const TensorInfo& tensorInfo);
25 
26 // Abstract tensor handles wrapping a CPU-readable region of memory, interpreting it as tensor data.
27 class ConstCpuTensorHandle : public ITensorHandle
28 {
29 public:
30  template <typename T>
31  const T* GetConstTensor() const
32  {
33  ARMNN_ASSERT(CompatibleTypes<T>(GetTensorInfo().GetDataType()));
34  return reinterpret_cast<const T*>(m_Memory);
35  }
36 
37  const TensorInfo& GetTensorInfo() const
38  {
39  return m_TensorInfo;
40  }
41 
42  virtual void Manage() override {}
43 
44  virtual ITensorHandle* GetParent() const override { return nullptr; }
45 
46  virtual const void* Map(bool /* blocking = true */) const override { return m_Memory; }
47  virtual void Unmap() const override {}
48 
49  TensorShape GetStrides() const override
50  {
51  return GetUnpaddedTensorStrides(m_TensorInfo);
52  }
53  TensorShape GetShape() const override { return m_TensorInfo.GetShape(); }
54 
55 protected:
56  ConstCpuTensorHandle(const TensorInfo& tensorInfo);
57 
58  void SetConstMemory(const void* mem) { m_Memory = mem; }
59 
60 private:
61  // Only used for testing
62  void CopyOutTo(void *) const override { ARMNN_ASSERT_MSG(false, "Unimplemented"); }
63  void CopyInFrom(const void*) override { ARMNN_ASSERT_MSG(false, "Unimplemented"); }
64 
65  ConstCpuTensorHandle(const ConstCpuTensorHandle& other) = delete;
66  ConstCpuTensorHandle& operator=(const ConstCpuTensorHandle& other) = delete;
67 
68  TensorInfo m_TensorInfo;
69  const void* m_Memory;
70 };
71 
72 template<>
73 const void* ConstCpuTensorHandle::GetConstTensor<void>() const;
74 
75 // Abstract specialization of ConstCpuTensorHandle that allows write access to the same data.
76 class CpuTensorHandle : public ConstCpuTensorHandle
77 {
78 public:
79  template <typename T>
80  T* GetTensor() const
81  {
82  ARMNN_ASSERT(CompatibleTypes<T>(GetTensorInfo().GetDataType()));
83  return reinterpret_cast<T*>(m_MutableMemory);
84  }
85 
86 protected:
87  CpuTensorHandle(const TensorInfo& tensorInfo);
88 
89  void SetMemory(void* mem)
90  {
91  m_MutableMemory = mem;
92  SetConstMemory(m_MutableMemory);
93  }
94 
95 private:
96 
97  CpuTensorHandle(const CpuTensorHandle& other) = delete;
98  CpuTensorHandle& operator=(const CpuTensorHandle& other) = delete;
99  void* m_MutableMemory;
100 };
101 
102 template <>
103 void* CpuTensorHandle::GetTensor<void>() const;
104 
105 // A CpuTensorHandle that owns the wrapped memory region.
106 class ScopedCpuTensorHandle : public CpuTensorHandle
107 {
108 public:
109  explicit ScopedCpuTensorHandle(const TensorInfo& tensorInfo);
110 
111  // Copies contents from Tensor.
112  explicit ScopedCpuTensorHandle(const ConstTensor& tensor);
113 
114  // Copies contents from ConstCpuTensorHandle
115  explicit ScopedCpuTensorHandle(const ConstCpuTensorHandle& tensorHandle);
116 
117  ScopedCpuTensorHandle(const ScopedCpuTensorHandle& other);
118  ScopedCpuTensorHandle& operator=(const ScopedCpuTensorHandle& other);
119  ~ScopedCpuTensorHandle();
120 
121  virtual void Allocate() override;
122 
123 private:
124  // Only used for testing
125  void CopyOutTo(void* memory) const override;
126  void CopyInFrom(const void* memory) override;
127 
128  void CopyFrom(const ScopedCpuTensorHandle& other);
129  void CopyFrom(const void* srcMemory, unsigned int numBytes);
130 };
131 
132 // A CpuTensorHandle that wraps an already allocated memory region.
133 //
134 // Clients must make sure the passed in memory region stays alive for the lifetime of
135 // the PassthroughCpuTensorHandle instance.
136 //
137 // Note there is no polymorphism to/from ConstPassthroughCpuTensorHandle.
138 class PassthroughCpuTensorHandle : public CpuTensorHandle
139 {
140 public:
141  PassthroughCpuTensorHandle(const TensorInfo& tensorInfo, void* mem)
142  : CpuTensorHandle(tensorInfo)
143  {
144  SetMemory(mem);
145  }
146 
147  virtual void Allocate() override;
148 };
149 
150 // A ConstCpuTensorHandle that wraps an already allocated memory region.
151 //
152 // This allows users to pass in const memory to a network.
153 // Clients must make sure the passed in memory region stays alive for the lifetime of
154 // the PassthroughCpuTensorHandle instance.
155 //
156 // Note there is no polymorphism to/from PassthroughCpuTensorHandle.
157 class ConstPassthroughCpuTensorHandle : public ConstCpuTensorHandle
158 {
159 public:
160  ConstPassthroughCpuTensorHandle(const TensorInfo& tensorInfo, const void* mem)
161  : ConstCpuTensorHandle(tensorInfo)
162  {
163  SetConstMemory(mem);
164  }
165 
166  virtual void Allocate() override;
167 };
168 
169 
170 // Template specializations.
171 
172 template <>
173 const void* ConstCpuTensorHandle::GetConstTensor() const;
174 
175 template <>
176 void* CpuTensorHandle::GetTensor() const;
177 
178 } // namespace armnn
+
armnn::TensorInfo::GetShape
const TensorShape & GetShape() const
Definition: Tensor.hpp:187
+ + +
armnn::ConstCpuTensorHandle::GetParent
virtual ITensorHandle * GetParent() const override
Get the parent tensor if this is a subtensor.
Definition: CpuTensorHandle.hpp:44
+ +
armnn::ITensorHandle::Allocate
virtual void Allocate()=0
Indicate to the memory manager that this resource is no longer active.
+ +
armnn::CpuTensorHandle::SetMemory
void SetMemory(void *mem)
Definition: CpuTensorHandle.hpp:89
+
armnn::ConstCpuTensorHandle::Unmap
virtual void Unmap() const override
Unmap the tensor data.
Definition: CpuTensorHandle.hpp:47
+
armnn::PassthroughCpuTensorHandle::PassthroughCpuTensorHandle
PassthroughCpuTensorHandle(const TensorInfo &tensorInfo, void *mem)
Definition: CpuTensorHandle.hpp:141
+
armnn::ConstCpuTensorHandle::GetConstTensor
const T * GetConstTensor() const
Definition: CpuTensorHandle.hpp:31
+
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_software_tools.dox:6
+ +
armnn::ConstCpuTensorHandle::Manage
virtual void Manage() override
Indicate to the memory manager that this resource is active.
Definition: CpuTensorHandle.hpp:42
+
TypesUtils.hpp
+
ARMNN_ASSERT_MSG
#define ARMNN_ASSERT_MSG(COND, MSG)
Definition: Assert.hpp:15
+
armnn::ConstCpuTensorHandle::GetShape
TensorShape GetShape() const override
Get the number of elements for each dimension ordered from slowest iterating dimension to fastest ite...
Definition: CpuTensorHandle.hpp:53
+ +
armnn::ConstCpuTensorHandle::GetStrides
TensorShape GetStrides() const override
Get the strides for each dimension ordered from largest to smallest where the smallest value is the s...
Definition: CpuTensorHandle.hpp:49
+
armnn::ConstTensor
A tensor defined by a TensorInfo (shape and data type) and an immutable backing store.
Definition: Tensor.hpp:314
+ +
armnn::ConstPassthroughCpuTensorHandle::ConstPassthroughCpuTensorHandle
ConstPassthroughCpuTensorHandle(const TensorInfo &tensorInfo, const void *mem)
Definition: CpuTensorHandle.hpp:160
+
ARMNN_ASSERT
#define ARMNN_ASSERT(COND)
Definition: Assert.hpp:14
+
armnn::ConstCpuTensorHandle::Map
virtual const void * Map(bool) const override
Map the tensor data for access.
Definition: CpuTensorHandle.hpp:46
+
armnn::GetUnpaddedTensorStrides
TensorShape GetUnpaddedTensorStrides(const TensorInfo &tensorInfo)
Definition: CpuTensorHandle.cpp:15
+
armnn::ConstCpuTensorHandle::ConstCpuTensorHandle
ConstCpuTensorHandle(const TensorInfo &tensorInfo)
Definition: CpuTensorHandle.cpp:31
+
Assert.hpp
+ +
armnn::ConstCpuTensorHandle::SetConstMemory
void SetConstMemory(const void *mem)
Definition: CpuTensorHandle.hpp:58
+
CompatibleTypes.hpp
+ + +
armnn::ConstCpuTensorHandle::GetTensorInfo
const TensorInfo & GetTensorInfo() const
Definition: CpuTensorHandle.hpp:37
+
+
+ + + + -- cgit v1.2.1