aboutsummaryrefslogtreecommitdiff
path: root/include/armnnUtils
diff options
context:
space:
mode:
authorRyan OShea <Ryan.OShea2@arm.com>2020-02-12 16:15:27 +0000
committerJim Flynn <jim.flynn@arm.com>2020-03-11 21:25:07 +0000
commit2bbfaa784c0ea2e2b239470cfbe633026d53c9cb (patch)
tree0de6e92da7a3b6f2bff919cefe7a54a7aa679a80 /include/armnnUtils
parent5238aff21baf0b35c36ab0cc72c7a46888e3bd08 (diff)
downloadarmnn-2bbfaa784c0ea2e2b239470cfbe633026d53c9cb.tar.gz
IVGCVSW-3726 Doxygen touch-up
* Doxygen comment touch-ups * Fixed markup in .dox files * Fixed stylesheet * Doxyfile changes * Added logo file * Added header file Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com> Change-Id: I94c7f5a6923a0bbb5c6ed610f1f55d57e2bb8a49
Diffstat (limited to 'include/armnnUtils')
-rw-r--r--include/armnnUtils/DataLayoutIndexed.hpp12
-rw-r--r--include/armnnUtils/FloatingPointConverter.hpp4
2 files changed, 8 insertions, 8 deletions
diff --git a/include/armnnUtils/DataLayoutIndexed.hpp b/include/armnnUtils/DataLayoutIndexed.hpp
index 03404bda5d..c6701f7d5c 100644
--- a/include/armnnUtils/DataLayoutIndexed.hpp
+++ b/include/armnnUtils/DataLayoutIndexed.hpp
@@ -13,7 +13,7 @@
namespace armnnUtils
{
-// Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout
+/// Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout
class DataLayoutIndexed
{
public:
@@ -36,25 +36,25 @@ public:
BOOST_ASSERT( widthIndex < shape[m_WidthIndex] ||
( shape[m_WidthIndex] == 0 && widthIndex == 0) );
- // Offset the given indices appropriately depending on the data layout
+ /// Offset the given indices appropriately depending on the data layout
switch (m_DataLayout)
{
case armnn::DataLayout::NHWC:
batchIndex *= shape[1] * shape[2] * shape[3]; // batchIndex *= heightIndex * widthIndex * channelIndex
heightIndex *= shape[m_WidthIndex] * shape[m_ChannelsIndex];
widthIndex *= shape[m_ChannelsIndex];
- // channelIndex stays unchanged
+ /// channelIndex stays unchanged
break;
case armnn::DataLayout::NCHW:
default:
batchIndex *= shape[1] * shape[2] * shape[3]; // batchIndex *= heightIndex * widthIndex * channelIndex
channelIndex *= shape[m_HeightIndex] * shape[m_WidthIndex];
heightIndex *= shape[m_WidthIndex];
- // widthIndex stays unchanged
+ /// widthIndex stays unchanged
break;
}
- // Get the value using the correct offset
+ /// Get the value using the correct offset
return batchIndex + channelIndex + heightIndex + widthIndex;
}
@@ -65,7 +65,7 @@ private:
unsigned int m_WidthIndex;
};
-// Equality methods
+/// Equality methods
bool operator==(const armnn::DataLayout& dataLayout, const DataLayoutIndexed& indexed);
bool operator==(const DataLayoutIndexed& indexed, const armnn::DataLayout& dataLayout);
diff --git a/include/armnnUtils/FloatingPointConverter.hpp b/include/armnnUtils/FloatingPointConverter.hpp
index a2244735dc..68c24cdc6e 100644
--- a/include/armnnUtils/FloatingPointConverter.hpp
+++ b/include/armnnUtils/FloatingPointConverter.hpp
@@ -13,8 +13,8 @@ namespace armnnUtils
class FloatingPointConverter
{
public:
- // Converts a buffer of FP32 values to FP16, and stores in the given dstFloat16Buffer.
- // dstFloat16Buffer should be (numElements * 2) in size
+ /// Converts a buffer of FP32 values to FP16, and stores in the given dstFloat16Buffer.
+ /// dstFloat16Buffer should be (numElements * 2) in size
static void ConvertFloat32To16(const float *srcFloat32Buffer, size_t numElements, void *dstFloat16Buffer);
static void ConvertFloat16To32(const void *srcFloat16Buffer, size_t numElements, float *dstFloat32Buffer);