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/structarmnn_1_1_stack_queue_descriptor.xhtml | 218 +++++++++++++++++++++ 1 file changed, 218 insertions(+) create mode 100644 21.02/structarmnn_1_1_stack_queue_descriptor.xhtml (limited to '21.02/structarmnn_1_1_stack_queue_descriptor.xhtml') diff --git a/21.02/structarmnn_1_1_stack_queue_descriptor.xhtml b/21.02/structarmnn_1_1_stack_queue_descriptor.xhtml new file mode 100644 index 0000000000..76a1e5d452 --- /dev/null +++ b/21.02/structarmnn_1_1_stack_queue_descriptor.xhtml @@ -0,0 +1,218 @@ + + + + + + + + + + + + + +ArmNN: StackQueueDescriptor Struct Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
StackQueueDescriptor Struct Reference
+
+
+ +

#include <WorkloadData.hpp>

+
+Inheritance diagram for StackQueueDescriptor:
+
+
+ + +QueueDescriptorWithParameters< StackDescriptor > +QueueDescriptor + +
+ + + + + + + + + + +

+Public Member Functions

void Validate (const WorkloadInfo &workloadInfo) const
 
- Public Member Functions inherited from QueueDescriptor
void ValidateInputsOutputs (const std::string &descName, unsigned int numExpectedIn, unsigned int numExpectedOut) const
 
template<typename T >
const T * GetAdditionalInformation () const
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Attributes inherited from QueueDescriptorWithParameters< StackDescriptor >
StackDescriptor m_Parameters
 
- Public Attributes inherited from QueueDescriptor
std::vector< ITensorHandle * > m_Inputs
 
std::vector< ITensorHandle * > m_Outputs
 
void * m_AdditionalInfoObject
 
- Protected Member Functions inherited from QueueDescriptorWithParameters< StackDescriptor >
 ~QueueDescriptorWithParameters ()=default
 
 QueueDescriptorWithParameters ()=default
 
 QueueDescriptorWithParameters (QueueDescriptorWithParameters const &)=default
 
QueueDescriptorWithParameters & operator= (QueueDescriptorWithParameters const &)=default
 
- Protected Member Functions inherited from QueueDescriptor
 ~QueueDescriptor ()=default
 
 QueueDescriptor ()
 
 QueueDescriptor (QueueDescriptor const &)=default
 
QueueDescriptor & operator= (QueueDescriptor const &)=default
 
+

Detailed Description

+
+

Definition at line 142 of file WorkloadData.hpp.

+

Member Function Documentation

+ +

◆ Validate()

+ +
+
+ + + + + + + + +
void Validate (const WorkloadInfo & workloadInfo) const
+
+ +

Definition at line 902 of file WorkloadData.cpp.

+ +

References armnn::BFloat16, armnn::Boolean, armnn::Float16, armnn::Float32, TensorShape::GetNumDimensions(), WorkloadInfo::m_InputTensorInfos, WorkloadInfo::m_OutputTensorInfos, armnn::QAsymmS8, armnn::QAsymmU8, armnn::QSymmS16, and armnn::Signed32.

+
903 {
904  const std::string descriptorName{"StackQueueDescriptor"};
905 
906  ValidateNumOutputs(workloadInfo, descriptorName, 1);
907 
908  if (m_Parameters.m_NumInputs != workloadInfo.m_InputTensorInfos.size())
909  {
910  throw InvalidArgumentException(descriptorName + ": Must have the defined number of input tensors.");
911  }
912 
913  // All inputs must have the same shape, which is defined in parameters
914  const TensorShape& inputShape = m_Parameters.m_InputShape;
915  for (unsigned int i = 0; i < workloadInfo.m_InputTensorInfos.size(); ++i)
916  {
917  if (workloadInfo.m_InputTensorInfos[i].GetShape() != inputShape)
918  {
919  throw InvalidArgumentException(descriptorName + ": All input tensor shapes must match the defined shape.");
920  }
921  }
922 
923  if (inputShape.GetNumDimensions() > 4)
924  {
925  throw InvalidArgumentException(descriptorName + ": Input tensor may have up to 4 dimensions.");
926  }
927 
928  // m_Axis is 0-based and may take values from 0 to the number of input dimensions (inclusive),
929  // since the output tensor has an additional dimension.
930  if (m_Parameters.m_Axis > inputShape.GetNumDimensions())
931  {
932  throw InvalidArgumentException(descriptorName + ": Axis may not be greater "
933  "than the number of input dimensions.");
934  }
935 
936  // Output shape must be as inferred from the input shape
937  const TensorShape& outputShape = workloadInfo.m_OutputTensorInfos[0].GetShape();
938  for (unsigned int i = 0; i < m_Parameters.m_Axis; ++i)
939  {
940  if (outputShape[i] != inputShape[i])
941  {
942  throw InvalidArgumentException(descriptorName + ": Output tensor must "
943  "match shape inferred from input tensor.");
944  }
945  }
946 
947  if (outputShape[m_Parameters.m_Axis] != m_Parameters.m_NumInputs)
948  {
949  throw InvalidArgumentException(descriptorName + ": Output tensor must "
950  "match shape inferred from input tensor.");
951  }
952 
953  for (unsigned int i = m_Parameters.m_Axis + 1; i < inputShape.GetNumDimensions() + 1; ++i)
954  {
955  if (outputShape[i] != inputShape[i-1])
956  {
957  throw InvalidArgumentException(descriptorName + ": Output tensor must "
958  "match shape inferred from input tensor.");
959  }
960  }
961 
962  if (outputShape.GetNumDimensions() > 5)
963  {
964  throw InvalidArgumentException(descriptorName + ": Output tensor may have up to 5 dimensions.");
965  }
966 
967  // Check the supported data types
968  std::vector<DataType> supportedTypes =
969  {
970  DataType::BFloat16,
971  DataType::Float32,
972  DataType::Float16,
973  DataType::Boolean,
974  DataType::Signed32,
975  DataType::QAsymmS8,
976  DataType::QAsymmU8,
977  DataType::QSymmS16
978  };
979 
980  ValidateDataTypes(workloadInfo.m_InputTensorInfos[0], supportedTypes, descriptorName);
981 
982  for (unsigned int i = 1ul; i < workloadInfo.m_InputTensorInfos.size(); ++i)
983  {
984  ValidateTensorDataTypesMatch(workloadInfo.m_InputTensorInfos[0],
985  workloadInfo.m_InputTensorInfos[i],
986  descriptorName,
987  "input_0",
988  "input_" + std::to_string(i));
989  }
990 
991  ValidateTensorDataTypesMatch(workloadInfo.m_InputTensorInfos[0],
992  workloadInfo.m_OutputTensorInfos[0],
993  descriptorName,
994  "input_0",
995  "output");
996 }
armnn::StackDescriptor::m_Axis
uint32_t m_Axis
0-based axis along which to stack the input tensors.
Definition: Descriptors.hpp:1046
+ +
armnn::StackDescriptor::m_InputShape
TensorShape m_InputShape
Required shape of all input tensors.
Definition: Descriptors.hpp:1050
+ + + + + +
armnn::WorkloadInfo::m_InputTensorInfos
std::vector< TensorInfo > m_InputTensorInfos
Definition: WorkloadInfo.hpp:18
+ + +
armnn::WorkloadInfo::m_OutputTensorInfos
std::vector< TensorInfo > m_OutputTensorInfos
Definition: WorkloadInfo.hpp:19
+ + +
armnn::StackDescriptor::m_NumInputs
uint32_t m_NumInputs
Number of input tensors.
Definition: Descriptors.hpp:1048
+
armnn::TensorShape::GetNumDimensions
unsigned int GetNumDimensions() const
Function that returns the tensor rank.
Definition: Tensor.cpp:174
+ +
+
+
+
The documentation for this struct was generated from the following files: +
+
+ + + + -- cgit v1.2.1