From ae050524109f1ce827962665436ef7430f2ac479 Mon Sep 17 00:00:00 2001 From: David Monahan Date: Wed, 22 Mar 2023 16:48:58 +0000 Subject: IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub. * Updating Doxygen documentation for 23.02 release. Signed-off-by: David Monahan Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82 --- 23.02/structarmnn_1_1_origins_descriptor.xhtml | 245 ++++++++++++++++++------- 1 file changed, 178 insertions(+), 67 deletions(-) (limited to '23.02/structarmnn_1_1_origins_descriptor.xhtml') diff --git a/23.02/structarmnn_1_1_origins_descriptor.xhtml b/23.02/structarmnn_1_1_origins_descriptor.xhtml index 87871cb479..bb25c63db4 100644 --- a/23.02/structarmnn_1_1_origins_descriptor.xhtml +++ b/23.02/structarmnn_1_1_origins_descriptor.xhtml @@ -8,7 +8,7 @@ - + ArmNN: OriginsDescriptor Struct Reference @@ -19,9 +19,6 @@ - @@ -30,7 +27,8 @@ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); - + + @@ -51,18 +49,21 @@ - + +/* @license-end */
@@ -76,7 +77,9 @@ $(function() {
@@ -103,7 +106,7 @@ $(document).ready(function(){initNavTree('structarmnn_1_1_origins_descriptor.xht
-

An OriginsDescriptor for the ConcatLayer. +

An OriginsDescriptor for the ConcatLayer. More...

#include <Descriptors.hpp>

@@ -113,9 +116,9 @@ Inheritance diagram for OriginsDescriptor:
-BaseDescriptor - -
+BaseDescriptor + + @@ -134,25 +137,25 @@ Public Member Functions - + - + - + - + - + - + - + @@ -163,11 +166,11 @@ Public Member Functions - +

Public Member Functions

bool operator== (const OriginsDescriptor &rhs) const
 
Status SetViewOriginCoord (uint32_t view, uint32_t coord, uint32_t value)
 Set the view origin coordinates. More...
 @Brief Set the view origin coordinates. More...
 
uint32_t GetNumViews () const
 Get the number of views. More...
 Get the number of views. More...
 
uint32_t GetNumDimensions () const
 Get the number of dimensions. More...
 Get the number of dimensions. More...
 
const uint32_t * GetViewOrigin (uint32_t idx) const
 Return the view origin at the int value idx. More...
 Return the view origin at the int value idx. More...
 
void ReorderOrigins (unsigned int *newOrdering, unsigned int numNewOrdering)
 Reorders the viewOrigins in accordance with the indices presented in newOrdering array. More...
 Reorders the viewOrigins in accordance with the indices presented in newOrdering array. More...
 
void SetConcatAxis (unsigned int concatAxis)
 Set the concatenation axis value. More...
 Set the concatenation axis value. More...
 
unsigned int GetConcatAxis () const
 Get the concatenation axis value. More...
 Get the concatenation axis value. More...
 
- Public Member Functions inherited from BaseDescriptor
virtual bool IsNull () const

Friends

void swap (OriginsDescriptor &first, OriginsDescriptor &second)
 Swap the ViewsDescriptor values first and second. More...
 Swap the ViewsDescriptor values first and second. More...
 

Detailed Description

-

An OriginsDescriptor for the ConcatLayer.

+

An OriginsDescriptor for the ConcatLayer.

Descriptor to configure the concatenation process. Number of views must be equal to the number of inputs, and their order must match - e.g. first view corresponds to the first input, second view to the second input, etc.

Definition at line 181 of file Descriptors.hpp.

@@ -188,7 +191,12 @@ Friends

Definition at line 82 of file Descriptors.cpp.

-
83 : m_ConcatAxis(1)
84 , m_NumViews(0)
85 , m_NumDimensions(0)
86 , m_ViewOrigins(nullptr)
87 {}
+
83 : m_ConcatAxis(1)
+
84 , m_NumViews(0)
+
85 , m_NumDimensions(0)
+
86 , m_ViewOrigins(nullptr)
+
87 {}
+
@@ -218,7 +226,17 @@ Friends

Definition at line 89 of file Descriptors.cpp.

-
90 : m_ConcatAxis(1)
91 , m_NumViews(numViews)
92 , m_NumDimensions(numDimensions)
93 , m_ViewOrigins(numViews && numDimensions > 0 ? new uint32_t *[numViews]() : nullptr)
94 {
95  for (uint32_t i = 0; m_NumDimensions > 0 && i < m_NumViews; ++i)
96  {
97  m_ViewOrigins[i] = new uint32_t[m_NumDimensions]();
98  }
99 }
+
90 : m_ConcatAxis(1)
+
91 , m_NumViews(numViews)
+
92 , m_NumDimensions(numDimensions)
+
93 , m_ViewOrigins(numViews && numDimensions > 0 ? new uint32_t *[numViews]() : nullptr)
+
94 {
+
95  for (uint32_t i = 0; m_NumDimensions > 0 && i < m_NumViews; ++i)
+
96  {
+
97  m_ViewOrigins[i] = new uint32_t[m_NumDimensions]();
+
98  }
+
99 }
+
@@ -238,7 +256,18 @@ Friends

Definition at line 101 of file Descriptors.cpp.

-
102 : m_ConcatAxis(other.m_ConcatAxis)
103 , m_NumViews(other.m_NumViews)
104 , m_NumDimensions(other.m_NumDimensions)
105 , m_ViewOrigins(other.m_NumViews && other.m_NumDimensions > 0 ? new uint32_t *[other.m_NumViews]() : nullptr)
106 {
107  for (uint32_t i = 0; m_NumDimensions > 0 && i < m_NumViews; ++i)
108  {
109  m_ViewOrigins[i] = new uint32_t[m_NumDimensions]();
110  memcpy(m_ViewOrigins[i], other.m_ViewOrigins[i], m_NumDimensions * sizeof(uint32_t));
111  }
112 }
+
102 : m_ConcatAxis(other.m_ConcatAxis)
+
103 , m_NumViews(other.m_NumViews)
+
104 , m_NumDimensions(other.m_NumDimensions)
+
105 , m_ViewOrigins(other.m_NumViews && other.m_NumDimensions > 0 ? new uint32_t *[other.m_NumViews]() : nullptr)
+
106 {
+
107  for (uint32_t i = 0; m_NumDimensions > 0 && i < m_NumViews; ++i)
+
108  {
+
109  m_ViewOrigins[i] = new uint32_t[m_NumDimensions]();
+
110  memcpy(m_ViewOrigins[i], other.m_ViewOrigins[i], m_NumDimensions * sizeof(uint32_t));
+
111  }
+
112 }
+
@@ -258,11 +287,13 @@ Friends

Definition at line 114 of file Descriptors.cpp.

- -

References OriginsDescriptor::swap.

-
115 : OriginsDescriptor()
116 {
117  swap(*this, other);
118 }
armnn::OriginsDescriptor::swap
friend void swap(OriginsDescriptor &first, OriginsDescriptor &second)
Swap the ViewsDescriptor values first and second.
Definition: Descriptors.cpp:350
- +
115 : OriginsDescriptor()
+
116 {
+
117  swap(*this, other);
+
118 }
+

References OriginsDescriptor::swap.

+
@@ -281,7 +312,14 @@ Friends

Definition at line 120 of file Descriptors.cpp.

-
121 {
122  for (uint32_t i = 0; m_NumDimensions > 0 && i < m_NumViews; ++i)
123  {
124  delete[] m_ViewOrigins[i];
125  }
126  delete[] m_ViewOrigins;
127 }
+
121 {
+
122  for (uint32_t i = 0; m_NumDimensions > 0 && i < m_NumViews; ++i)
+
123  {
+
124  delete[] m_ViewOrigins[i];
+
125  }
+
126  delete[] m_ViewOrigins;
+
127 }
+

Member Function Documentation

@@ -303,9 +341,12 @@ Friends

Get the concatenation axis value.

Definition at line 162 of file Descriptors.cpp.

+
163 {
+
164  return m_ConcatAxis;
+
165 }
+
+

Referenced by ConvertConcatToTosaOperator(), OriginsDescriptor::operator==(), StringifyLayerParameters< OriginsDescriptor >::Serialize(), and ConcatQueueDescriptor::Validate().

-

Referenced by ConvertConcatToTosaOperator(), ConcatLayer::CreateWorkload(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), ClLayerSupport::IsConcatSupported(), NeonLayerSupport::IsConcatSupported(), OriginsDescriptor::operator==(), and StringifyLayerParameters< OriginsDescriptor >::Serialize().

-
163 {
164  return m_ConcatAxis;
165 }
@@ -326,9 +367,12 @@ Friends

Get the number of dimensions.

Definition at line 192 of file Descriptors.cpp.

+
193 {
+
194  return m_NumDimensions;
+
195 }
+
+

Referenced by ConcatLayer::CreateWorkload(), ViewsDescriptor::GetNumDimensions(), ConcatLayer::InferOutputShapes(), OriginsDescriptor::operator==(), armnnUtils::ProcessConcatInputTensorInfo(), and StringifyLayerParameters< OriginsDescriptor >::Serialize().

-

Referenced by ConcatLayer::CreateWorkload(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), ViewsDescriptor::GetNumDimensions(), ConcatLayer::InferOutputShapes(), ClLayerSupport::IsConcatSupported(), NeonLayerSupport::IsConcatSupported(), OriginsDescriptor::operator==(), armnnUtils::ProcessConcatInputTensorInfo(), and StringifyLayerParameters< OriginsDescriptor >::Serialize().

-
193 {
194  return m_NumDimensions;
195 }
@@ -349,9 +393,12 @@ Friends

Get the number of views.

Definition at line 187 of file Descriptors.cpp.

+
188 {
+
189  return m_NumViews;
+
190 }
+
+

Referenced by ConcatLayer::CreateWorkload(), ViewsDescriptor::GetNumViews(), ConcatLayer::InferOutputShapes(), OriginsDescriptor::operator==(), StringifyLayerParameters< OriginsDescriptor >::Serialize(), and ConcatLayer::ValidateTensorShapesFromInputs().

-

Referenced by ConcatLayer::CreateWorkload(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), ViewsDescriptor::GetNumViews(), ConcatLayer::InferOutputShapes(), OriginsDescriptor::operator==(), StringifyLayerParameters< OriginsDescriptor >::Serialize(), and ConcatLayer::ValidateTensorShapesFromInputs().

-
188 {
189  return m_NumViews;
190 }
@@ -373,9 +420,12 @@ Friends

Return the view origin at the int value idx.

Definition at line 197 of file Descriptors.cpp.

+
198 {
+
199  return m_ViewOrigins ? m_ViewOrigins[idx] : nullptr;
+
200 }
+
+

Referenced by ConcatLayer::CreateWorkload(), ViewsDescriptor::GetViewOrigin(), ConcatLayer::InferOutputShapes(), OriginsDescriptor::operator==(), and StringifyLayerParameters< OriginsDescriptor >::Serialize().

-

Referenced by ConcatLayer::CreateWorkload(), armnnSerializer::GetFlatBufferArgMinMaxFunction(), ViewsDescriptor::GetViewOrigin(), ConcatLayer::InferOutputShapes(), OriginsDescriptor::operator==(), and StringifyLayerParameters< OriginsDescriptor >::Serialize().

-
198 {
199  return m_ViewOrigins ? m_ViewOrigins[idx] : nullptr;
200 }
@@ -395,10 +445,13 @@ Friends

Definition at line 129 of file Descriptors.cpp.

- -

References OriginsDescriptor::swap.

-
130 {
131  swap(*this, rhs);
132  return *this;
133 }
armnn::OriginsDescriptor::swap
friend void swap(OriginsDescriptor &first, OriginsDescriptor &second)
Swap the ViewsDescriptor values first and second.
Definition: Descriptors.cpp:350
+
130 {
+
131  swap(*this, rhs);
+
132  return *this;
+
133 }
+

References OriginsDescriptor::swap.

+
@@ -418,13 +471,30 @@ Friends

Definition at line 135 of file Descriptors.cpp.

- -

References OriginsDescriptor::GetConcatAxis(), OriginsDescriptor::GetNumDimensions(), OriginsDescriptor::GetNumViews(), and OriginsDescriptor::GetViewOrigin().

-
136 {
137  if (GetNumViews() != rhs.GetNumViews() ||
138  GetNumDimensions() != rhs.GetNumDimensions() ||
139  GetConcatAxis() != rhs.GetConcatAxis())
140  {
141  return false;
142  }
143 
144  for (unsigned int i = 0u; i < GetNumViews(); ++i)
145  {
146  for (unsigned int j = 0u; j < GetNumDimensions(); ++j)
147  {
148  if (GetViewOrigin(i)[j] != rhs.GetViewOrigin(i)[j])
149  {
150  return false;
151  }
152  }
153  }
154 
155  return true;
156 }
armnn::OriginsDescriptor::GetViewOrigin
const uint32_t * GetViewOrigin(uint32_t idx) const
Return the view origin at the int value idx.
Definition: Descriptors.cpp:197
-
armnn::OriginsDescriptor::GetNumDimensions
uint32_t GetNumDimensions() const
Get the number of dimensions.
Definition: Descriptors.cpp:192
-
armnn::OriginsDescriptor::GetNumViews
uint32_t GetNumViews() const
Get the number of views.
Definition: Descriptors.cpp:187
-
armnn::OriginsDescriptor::GetConcatAxis
unsigned int GetConcatAxis() const
Get the concatenation axis value.
Definition: Descriptors.cpp:162
+
136 {
+
137  if (GetNumViews() != rhs.GetNumViews() ||
+
138  GetNumDimensions() != rhs.GetNumDimensions() ||
+
139  GetConcatAxis() != rhs.GetConcatAxis())
+
140  {
+
141  return false;
+
142  }
+
143 
+
144  for (unsigned int i = 0u; i < GetNumViews(); ++i)
+
145  {
+
146  for (unsigned int j = 0u; j < GetNumDimensions(); ++j)
+
147  {
+
148  if (GetViewOrigin(i)[j] != rhs.GetViewOrigin(i)[j])
+
149  {
+
150  return false;
+
151  }
+
152  }
+
153  }
+
154 
+
155  return true;
+
156 }
+

References OriginsDescriptor::GetConcatAxis(), OriginsDescriptor::GetNumDimensions(), OriginsDescriptor::GetNumViews(), and OriginsDescriptor::GetViewOrigin().

+
@@ -457,10 +527,19 @@ Friends

The number of views must match number of elements in the new ordering array.

Definition at line 204 of file Descriptors.cpp.

- -

References ARMNN_ASSERT_MSG.

-
205 {
206  ARMNN_ASSERT_MSG(m_NumViews == numNewOrdering, "number of views must match number of "
207  "elements in the new ordering array");
208  std::vector<uint32_t*> viewOrigins(&m_ViewOrigins[0], &m_ViewOrigins[m_NumViews]);
209 
210  for (unsigned int i = 0; i < numNewOrdering; ++i)
211  {
212  m_ViewOrigins[i] = viewOrigins[newOrdering[i]];
213  }
214 }
ARMNN_ASSERT_MSG
#define ARMNN_ASSERT_MSG(COND, MSG)
Definition: Assert.hpp:15
+
205 {
+
206  ARMNN_ASSERT_MSG(m_NumViews == numNewOrdering, "number of views must match number of "
+
207  "elements in the new ordering array");
+
208  std::vector<uint32_t*> viewOrigins(&m_ViewOrigins[0], &m_ViewOrigins[m_NumViews]);
+
209 
+
210  for (unsigned int i = 0; i < numNewOrdering; ++i)
+
211  {
+
212  m_ViewOrigins[i] = viewOrigins[newOrdering[i]];
+
213  }
+
214 }
+

References ARMNN_ASSERT_MSG.

+
@@ -482,9 +561,12 @@ Friends

Set the concatenation axis value.

Definition at line 158 of file Descriptors.cpp.

+
159 {
+
160  m_ConcatAxis = concatAxis;
+
161 }
+
+

Referenced by armnn::CreateDescriptorForConcatenation().

-

Referenced by Converter::ConvertOperation(), armnn::CreateDescriptorForConcatenation(), OnnxParserImpl::CreateNetworkFromString(), and TfLiteParserImpl::OutputShapeOfReshape().

-
159 {
160  m_ConcatAxis = concatAxis;
161 }
@@ -519,19 +601,32 @@ Friends
-

Set the view origin coordinates.

-

The arguments are: view, dimension, value. If the view is greater than or equal to GetNumViews(), then the view argument is out of range. If the coord is greater than or equal to GetNumDimensions(), then the coord argument is out of range.

+

@Brief Set the view origin coordinates.

+

The arguments are: view, dimension, value. If the view is greater than or equal to GetNumViews(), then the view argument is out of range. If the coord is greater than or equal to GetNumDimensions(), then the coord argument is out of range.

Definition at line 167 of file Descriptors.cpp.

- +
168 {
+
169  if (view >= m_NumViews)
+
170  {
+
171  ARMNN_LOG(error) << "OriginsDescriptor::SetViewOriginCoord: view argument:" << view <<
+
172  " is out of range";
+
173  return Status::Failure;
+
174  }
+
175  if (coord >= m_NumDimensions)
+
176  {
+
177  ARMNN_LOG(error) << "OriginsDescriptor::SetViewOriginCoord: coord argument:" << coord <<
+
178  " is out of range";
+
179  return Status::Failure;
+
180  }
+
181 
+
182  m_ViewOrigins[view][coord] = value;
+
183  return Status::Success;
+
184 }
+

References ARMNN_LOG, armnn::error, armnn::Failure, and armnn::Success.

-

Referenced by Converter::ConvertOperation(), armnn::CreateDescriptorForConcatenation(), armnnUtils::ProcessConcatInputTensorInfo(), and ViewsDescriptor::SetViewOriginCoord().

-
168 {
169  if (view >= m_NumViews)
170  {
171  ARMNN_LOG(error) << "OriginsDescriptor::SetViewOriginCoord: view argument:" << view <<
172  " is out of range";
173  return Status::Failure;
174  }
175  if (coord >= m_NumDimensions)
176  {
177  ARMNN_LOG(error) << "OriginsDescriptor::SetViewOriginCoord: coord argument:" << coord <<
178  " is out of range";
179  return Status::Failure;
180  }
181 
182  m_ViewOrigins[view][coord] = value;
183  return Status::Success;
184 }
ARMNN_LOG
#define ARMNN_LOG(severity)
Definition: Logging.hpp:212
- - - -
+

Referenced by armnn::CreateDescriptorForConcatenation(), armnnUtils::ProcessConcatInputTensorInfo(), and ViewsDescriptor::SetViewOriginCoord().

+

Friends And Related Function Documentation

@@ -569,14 +664,19 @@ Friends
-

Swap the ViewsDescriptor values first and second.

+

Swap the ViewsDescriptor values first and second.

Definition at line 350 of file Descriptors.cpp.

- -

Referenced by OriginsDescriptor::operator=(), and OriginsDescriptor::OriginsDescriptor().

-
351 {
352  using std::swap;
353  swap(first.m_NumViews, second.m_NumViews);
354  swap(first.m_NumDimensions, second.m_NumDimensions);
355  swap(first.m_ViewOrigins, second.m_ViewOrigins);
356  swap(first.m_ConcatAxis, second.m_ConcatAxis);
357 }
armnn::OriginsDescriptor::swap
friend void swap(OriginsDescriptor &first, OriginsDescriptor &second)
Swap the ViewsDescriptor values first and second.
Definition: Descriptors.cpp:350
-
armnn::swap
void swap(ViewsDescriptor &first, ViewsDescriptor &second)
Definition: Descriptors.cpp:359
+
351 {
+
352  using std::swap;
+
353  swap(first.m_NumViews, second.m_NumViews);
+
354  swap(first.m_NumDimensions, second.m_NumDimensions);
+
355  swap(first.m_ViewOrigins, second.m_ViewOrigins);
+
356  swap(first.m_ConcatAxis, second.m_ConcatAxis);
+
357 }
+

Referenced by OriginsDescriptor::operator=(), and OriginsDescriptor::OriginsDescriptor().

+
The documentation for this struct was generated from the following files: +
armnn::OriginsDescriptor::GetNumViews
uint32_t GetNumViews() const
Get the number of views.
Definition: Descriptors.cpp:187
+
armnn::OriginsDescriptor::GetNumDimensions
uint32_t GetNumDimensions() const
Get the number of dimensions.
Definition: Descriptors.cpp:192
+
armnn::OriginsDescriptor::GetViewOrigin
const uint32_t * GetViewOrigin(uint32_t idx) const
Return the view origin at the int value idx.
Definition: Descriptors.cpp:197
+ +
armnn::OriginsDescriptor::swap
friend void swap(OriginsDescriptor &first, OriginsDescriptor &second)
Swap the ViewsDescriptor values first and second.
Definition: Descriptors.cpp:350
+
armnn::OriginsDescriptor::GetConcatAxis
unsigned int GetConcatAxis() const
Get the concatenation axis value.
Definition: Descriptors.cpp:162
+
ARMNN_LOG
#define ARMNN_LOG(severity)
Definition: Logging.hpp:212
+
armnn::swap
void swap(ViewsDescriptor &first, ViewsDescriptor &second)
Definition: Descriptors.cpp:359
+ + +
ARMNN_ASSERT_MSG
#define ARMNN_ASSERT_MSG(COND, MSG)
Definition: Assert.hpp:15
-- cgit v1.2.1