A BatchMatMulDescriptor for the BatchMatMul operator. More...

#include <Descriptors.hpp>

Inheritance diagram for BatchMatMulDescriptor:

Collaboration diagram for BatchMatMulDescriptor:

Public Member Functions
	BatchMatMulDescriptor (bool transposeX=false, bool transposeY=false, bool adjointX=false, bool adjointY=false, DataLayout dataLayoutX=DataLayout::NCHW, DataLayout dataLayoutY=DataLayout::NCHW)
bool	operator== (const BatchMatMulDescriptor &rhs) const
Public Member Functions inherited from BaseDescriptor
virtual bool	IsNull () const
virtual	~BaseDescriptor ()=default

Static Public Member Functions
static std::pair< unsigned int, unsigned int >	GetAxesToMul (DataLayout dataLayout, const TensorShape &tensorShape)
	Static helper to get the two axes (for each input) for multiplication.
static std::vector< unsigned int >	GetAxesNotMul (DataLayout dataLayout, const TensorShape &tensorShape)
	Static helper to get the axes (for each input) that will not be multiplied together.
static PermutationVector	GetPermuteVec (DataLayout dataLayout, const TensorShape &tensorShape)
	Static helper to get the axes which will be transposed.

Public Attributes
bool	m_TransposeX
	Transpose the slices of each input tensor Transpose and Adjoint can not both be set to true for the same tensor at the same time.
bool	m_TransposeY
bool	m_AdjointX
	Adjoint the slices of each input tensor Transpose and Adjoint can not both be set to true for the same tensor at the same time.
bool	m_AdjointY
DataLayout	m_DataLayoutX
	Data layout of each input tensor, such as NHWC/NDHWC (leave as default for arbitrary layout)
DataLayout	m_DataLayoutY

Detailed Description

A BatchMatMulDescriptor for the BatchMatMul operator.

Definition at line 1584 of file Descriptors.hpp.

Constructor & Destructor Documentation

◆ BatchMatMulDescriptor()

BatchMatMulDescriptor	(	bool	transposeX = false,
		bool	transposeY = false,
		bool	adjointX = false,
		bool	adjointY = false,
		DataLayout	dataLayoutX = DataLayout::NCHW,
		DataLayout	dataLayoutY = DataLayout::NCHW )

inline

Definition at line 1586 of file Descriptors.hpp.

        : m_TransposeX(transposeX)
        , m_TransposeY(transposeY)
        , m_AdjointX(adjointX)
        , m_AdjointY(adjointY)
        , m_DataLayoutX(dataLayoutX)
        , m_DataLayoutY(dataLayoutY)
    {}

References m_AdjointX, m_AdjointY, m_DataLayoutX, m_DataLayoutY, m_TransposeX, m_TransposeY, and armnn::NCHW.

Referenced by operator==().

Member Function Documentation

◆ GetAxesNotMul()

std::vector< unsigned int > GetAxesNotMul	(	DataLayout	dataLayout,
		const TensorShape &	tensorShape )

static

Static helper to get the axes (for each input) that will not be multiplied together.

Definition at line 506 of file Descriptors.cpp.

{
    auto axesToMul = BatchMatMulDescriptor::GetAxesToMul(dataLayout, tensorShape);
    std::vector<unsigned int> axesNotMul;
    for(unsigned int i = 0; i < tensorShape.GetNumDimensions(); i++)
    {
        if(i == axesToMul.first || i == axesToMul.second)
        {
            continue;
        }
        axesNotMul.push_back(i);
    }
    return axesNotMul;
}

References GetAxesToMul(), and TensorShape::GetNumDimensions().

Referenced by BatchMatMulQueueDescriptor::Validate().

◆ GetAxesToMul()

std::pair< unsigned int, unsigned int > GetAxesToMul	(	DataLayout	dataLayout,
		const TensorShape &	tensorShape )

static

Static helper to get the two axes (for each input) for multiplication.

Definition at line 485 of file Descriptors.cpp.

{
    auto numDims = tensorShape.GetNumDimensions();
    std::pair<unsigned int, unsigned int> axes = { numDims-2, numDims-1 };
    switch(dataLayout)
    {
        case DataLayout::NDHWC:
        case DataLayout::NHWC:
            axes.first -= 1;
            axes.second -= 1;
            break;
        case DataLayout::NCDHW:
        case DataLayout::NCHW:
        default:
            break;
    }
    return axes;
}

References TensorShape::GetNumDimensions(), armnn::NCDHW, armnn::NCHW, armnn::NDHWC, and armnn::NHWC.

Referenced by GetAxesNotMul(), GetPermuteVec(), BatchMatMulLayer::InferOutputShapes(), and BatchMatMulQueueDescriptor::Validate().

◆ GetPermuteVec()

PermutationVector GetPermuteVec	(	DataLayout	dataLayout,
		const TensorShape &	tensorShape )

static

Static helper to get the axes which will be transposed.

Definition at line 523 of file Descriptors.cpp.

{
    std::vector<unsigned int> vec;
    auto axesToMul = BatchMatMulDescriptor::GetAxesToMul(dataLayout, tensorShape);
    for(unsigned int i = 0; i < tensorShape.GetNumDimensions(); i++)
    {
        if(i == axesToMul.first)
        {
            vec.push_back(i+1);
        }
        else if(i == axesToMul.second)
        {
            vec.push_back(i-1);
        }
        else
        {
            vec.push_back(i);
        }
    }
    return PermutationVector(vec.data(),
                             static_cast<unsigned int>(vec.size()));
}

References GetAxesToMul(), and TensorShape::GetNumDimensions().

Referenced by ConvertBatchMatMulToTosaOperator(), BatchMatMulLayer::InferOutputShapes(), and BatchMatMulQueueDescriptor::Validate().

◆ operator==()

bool operator== ( const BatchMatMulDescriptor & rhs ) const

inline

Definition at line 1600 of file Descriptors.hpp.

    {
        return m_TransposeX == rhs.m_TransposeX &&
               m_TransposeY == rhs.m_TransposeY &&
               m_AdjointX == rhs.m_AdjointX &&
               m_AdjointY == rhs.m_AdjointY &&
               m_DataLayoutX == rhs.m_DataLayoutX &&
               m_DataLayoutY == rhs.m_DataLayoutY;
    }