DataLayoutIndexed Class Reference

Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout. More...

#include <DataLayoutIndexed.hpp>

Public Member Functions
	DataLayoutIndexed (armnn::DataLayout dataLayout)
armnn::DataLayout	GetDataLayout () const
unsigned int	GetChannelsIndex () const
unsigned int	GetHeightIndex () const
unsigned int	GetWidthIndex () const
unsigned int	GetIndex (const armnn::TensorShape &shape, unsigned int batchIndex, unsigned int channelIndex, unsigned int heightIndex, unsigned int widthIndex) const

Detailed Description

Provides access to the appropriate indexes for Channels, Height and Width based on DataLayout.

Definition at line 17 of file DataLayoutIndexed.hpp.

Constructor & Destructor Documentation

DataLayoutIndexed()

DataLayoutIndexed

(

armnn::DataLayout

dataLayout

)

Definition at line 13 of file DataLayoutIndexed.cpp.

References armnn::NCHW, and armnn::NHWC.

    : m_DataLayout(dataLayout)
{
    switch (dataLayout)
    {
        case armnn::DataLayout::NHWC:
            m_ChannelsIndex = 3;
            m_HeightIndex   = 1;
            m_WidthIndex    = 2;
            break;
        case armnn::DataLayout::NCHW:
            m_ChannelsIndex = 1;
            m_HeightIndex   = 2;
            m_WidthIndex    = 3;
            break;
        default:
            throw armnn::InvalidArgumentException("Unknown DataLayout value: " +
                                                  std::to_string(static_cast<int>(dataLayout)));
    }
}

Member Function Documentation

GetChannelsIndex()

unsigned int GetChannelsIndex ( ) const

inline

Definition at line 23 of file DataLayoutIndexed.hpp.

Referenced by armnn::BatchNormImpl(), armnn::BatchToSpaceNd(), armnn::Convolve(), armnn::DepthToSpace(), GetBias(), armnn::GetOffset(), DepthToSpaceLayer::InferOutputShapes(), ResizeLayer::InferOutputShapes(), Pooling2dLayer::InferOutputShapes(), DepthwiseConvolution2dLayer::InferOutputShapes(), armnn::InstanceNorm(), armnn::Offset(), armnn::Pooling2d(), armnn::Resize(), armnn::SpaceToBatchNd(), armnn::SpaceToDepth(), armnn::TransposeConvolution2dImpl(), armnn::optimizations::pad_fold::TryFoldPadIntoLayer2d(), ResizeBilinearQueueDescriptor::Validate(), ResizeQueueDescriptor::Validate(), SpaceToBatchNdQueueDescriptor::Validate(), SpaceToDepthQueueDescriptor::Validate(), and DepthToSpaceQueueDescriptor::Validate().

{ return m_ChannelsIndex; }

GetDataLayout()

armnn::DataLayout GetDataLayout ( ) const

inline

Definition at line 22 of file DataLayoutIndexed.hpp.

Referenced by CompareDepthwiseConvolution2dTestImpl(), armnn::Convolve(), armnn::GetOffset(), armnn::Offset(), armnnUtils::operator==(), and armnn::Pooling2d().

{ return m_DataLayout; }

GetHeightIndex()

unsigned int GetHeightIndex ( ) const

inline

Definition at line 24 of file DataLayoutIndexed.hpp.

Referenced by armnn::BatchNormImpl(), armnn::BatchToSpaceNd(), armnn::Convolve(), armnn::DepthToSpace(), armnn::GetOffset(), DepthToSpaceLayer::InferOutputShapes(), SpaceToBatchNdLayer::InferOutputShapes(), BatchToSpaceNdLayer::InferOutputShapes(), Pooling2dLayer::InferOutputShapes(), DepthwiseConvolution2dLayer::InferOutputShapes(), Convolution2dLayer::InferOutputShapes(), armnn::InstanceNorm(), armnn::Offset(), armnn::Pooling2d(), armnn::Resize(), Convolution2dLayer::SerializeLayerParameters(), armnn::SpaceToBatchNd(), armnn::SpaceToDepth(), armnn::TransposeConvolution2dImpl(), armnn::optimizations::pad_fold::TryFoldPadIntoLayer2d(), SpaceToBatchNdQueueDescriptor::Validate(), SpaceToDepthQueueDescriptor::Validate(), and DepthToSpaceQueueDescriptor::Validate().

{ return m_HeightIndex; }

GetIndex()

unsigned int GetIndex ( const armnn::TensorShape &  shape, unsigned int  batchIndex, unsigned int  channelIndex, unsigned int  heightIndex, unsigned int  widthIndex  ) const

inline

Offset the given indices appropriately depending on the data layout

channelIndex stays unchanged

widthIndex stays unchanged

Get the value using the correct offset

Definition at line 27 of file DataLayoutIndexed.hpp.

References ARMNN_ASSERT, armnn::NCHW, armnn::NHWC, and armnnUtils::operator==().

Referenced by armnn::BatchNormImpl(), TensorBufferArrayView< DataType >::Get(), armnn::InstanceNorm(), armnn::Resize(), and armnn::TransposeConvolution2dImpl().

    {
        ARMNN_ASSERT( batchIndex < shape[0] || ( shape[0] == 0 && batchIndex == 0 ) );
        ARMNN_ASSERT( channelIndex < shape[m_ChannelsIndex] ||
                    ( shape[m_ChannelsIndex] == 0 && channelIndex == 0) );
        ARMNN_ASSERT( heightIndex < shape[m_HeightIndex] ||
                    ( shape[m_HeightIndex] == 0 && heightIndex == 0) );
        ARMNN_ASSERT( widthIndex < shape[m_WidthIndex] ||
                    ( shape[m_WidthIndex] == 0 && widthIndex == 0) );

        /// 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
            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
            break;
        }

        /// Get the value using the correct offset
        return batchIndex + channelIndex + heightIndex + widthIndex;
    }

GetWidthIndex()

unsigned int GetWidthIndex ( ) const

inline

Definition at line 25 of file DataLayoutIndexed.hpp.

Referenced by armnn::BatchNormImpl(), armnn::BatchToSpaceNd(), armnn::Convolve(), armnn::DepthToSpace(), armnn::GetOffset(), DepthToSpaceLayer::InferOutputShapes(), SpaceToBatchNdLayer::InferOutputShapes(), BatchToSpaceNdLayer::InferOutputShapes(), Pooling2dLayer::InferOutputShapes(), DepthwiseConvolution2dLayer::InferOutputShapes(), Convolution2dLayer::InferOutputShapes(), armnn::InstanceNorm(), armnn::Offset(), armnn::Pooling2d(), armnn::Resize(), Convolution2dLayer::SerializeLayerParameters(), armnn::SpaceToBatchNd(), armnn::SpaceToDepth(), armnn::TransposeConvolution2dImpl(), armnn::optimizations::pad_fold::TryFoldPadIntoLayer2d(), SpaceToBatchNdQueueDescriptor::Validate(), SpaceToDepthQueueDescriptor::Validate(), and DepthToSpaceQueueDescriptor::Validate().

{ return m_WidthIndex; }

---

The documentation for this class was generated from the following files:

• include/armnnUtils/DataLayoutIndexed.hpp
• src/armnnUtils/DataLayoutIndexed.cpp