ViewsDescriptor Struct Reference

A ViewsDescriptor for the SplitterLayer. More...

#include <Descriptors.hpp>

Inheritance diagram for ViewsDescriptor:

Public Member Functions
	ViewsDescriptor (uint32_t numViews, uint32_t numDimensions=4)
	ViewsDescriptor (const ViewsDescriptor &other)
	ViewsDescriptor ()
	ViewsDescriptor (ViewsDescriptor &&other)
	~ViewsDescriptor ()
ViewsDescriptor &	operator= (ViewsDescriptor rhs)
bool	operator== (const ViewsDescriptor &rhs) const
Status	SetViewOriginCoord (uint32_t view, uint32_t coord, uint32_t value)
	@Brief Set the view origin coordinates. More...
Status	SetViewSize (uint32_t view, uint32_t coord, uint32_t value)
	Set the size of the views. More...
uint32_t	GetNumViews () const
	Get the number of views. More...
uint32_t	GetNumDimensions () const
	Get the number of dimensions. More...
const uint32_t *	GetViewOrigin (uint32_t idx) const
	Get the view origin at the int value idx. More...
const uint32_t *	GetViewSizes (uint32_t idx) const
	Get the view sizes at the int value idx. More...
const OriginsDescriptor &	GetOrigins () const
	Get the View Origins. More...
Public Member Functions inherited from BaseDescriptor
virtual bool	IsNull () const
virtual	~BaseDescriptor ()=default

Friends
void	swap (ViewsDescriptor &first, ViewsDescriptor &second)
	Swap the ViewsDescriptor value first and second. More...

Detailed Description

A ViewsDescriptor for the SplitterLayer.

Descriptor to configure the splitting process. Number of Views must be equal to the number of outputs, and their order must match - e.g. first view corresponds to the first output, second view to the second output, etc.

Definition at line 244 of file Descriptors.hpp.

Constructor & Destructor Documentation

ViewsDescriptor() [1/4]

ViewsDescriptor	(	uint32_t	numViews,
		uint32_t	numDimensions = 4
	)

Definition at line 221 of file Descriptors.cpp.

    : m_Origins(numViews, numDimensions)
    , m_ViewSizes(numViews > 0 && numDimensions > 0 ?
                      new uint32_t *[numViews]() : nullptr)
{
    if (m_ViewSizes)
    {
        for (uint32_t i = 0; GetNumDimensions() > 0 && i < GetNumViews(); ++i)
        {
            m_ViewSizes[i] = new uint32_t[GetNumDimensions()]();
        }
    }
}

References ViewsDescriptor::GetNumDimensions(), and ViewsDescriptor::GetNumViews().

ViewsDescriptor() [2/4]

ViewsDescriptor

(

const ViewsDescriptor &

other

)

Definition at line 235 of file Descriptors.cpp.

    : m_Origins(other.m_Origins)
    , m_ViewSizes(other.GetNumViews() > 0 && other.GetNumDimensions() > 0 ?
                      new uint32_t *[other.GetNumViews()]() : nullptr)
{
    if (m_ViewSizes)
    {
        for (uint32_t i = 0; GetNumDimensions() > 0 && i < GetNumViews(); ++i)
        {
            m_ViewSizes[i] = new uint32_t[GetNumDimensions()]();
            memcpy(m_ViewSizes[i], other.m_ViewSizes[i], GetNumDimensions() * sizeof(uint32_t));
        }
    }
}

References ViewsDescriptor::GetNumDimensions(), and ViewsDescriptor::GetNumViews().

ViewsDescriptor() [3/4]

ViewsDescriptor

(

)

Definition at line 216 of file Descriptors.cpp.

: m_Origins()
, m_ViewSizes(nullptr)
{}

ViewsDescriptor() [4/4]

ViewsDescriptor

(

ViewsDescriptor &&

other

)

Definition at line 250 of file Descriptors.cpp.

    : ViewsDescriptor()
{
    swap(*this, other);
}

References ViewsDescriptor::swap.

~ViewsDescriptor()

~ViewsDescriptor

(

)

Definition at line 256 of file Descriptors.cpp.

{
    if (m_ViewSizes)
    {
        for (uint32_t i = 0; GetNumDimensions() > 0 && i < GetNumViews(); ++i)
        {
            delete[] m_ViewSizes[i];
        }
        delete[] m_ViewSizes;
    }
}

References ViewsDescriptor::GetNumDimensions(), and ViewsDescriptor::GetNumViews().

Member Function Documentation

GetNumDimensions()

uint32_t GetNumDimensions

(

)

const

Get the number of dimensions.

Definition at line 300 of file Descriptors.cpp.

{
    return m_Origins.GetNumDimensions();
}

References OriginsDescriptor::GetNumDimensions().

Referenced by ClSplitterWorkload::ClSplitterWorkload(), armnn::ComputeSplitAxis(), SplitterLayer::CreateWorkload(), SplitterLayer::InferOutputShapes(), NeonSplitterWorkload::NeonSplitterWorkload(), ViewsDescriptor::operator==(), StringifyLayerParameters< ViewsDescriptor >::Serialize(), ViewsDescriptor::SetViewSize(), SplitterLayer::ValidateTensorShapesFromInputs(), ViewsDescriptor::ViewsDescriptor(), and ViewsDescriptor::~ViewsDescriptor().

GetNumViews()

uint32_t GetNumViews

(

)

const

Get the number of views.

Definition at line 295 of file Descriptors.cpp.

{
    return m_Origins.GetNumViews();
}

References OriginsDescriptor::GetNumViews().

Referenced by armnn::ComputeSplitAxis(), SplitterLayer::CreateWorkload(), SplitterLayer::InferOutputShapes(), ViewsDescriptor::operator==(), StringifyLayerParameters< ViewsDescriptor >::Serialize(), ViewsDescriptor::SetViewSize(), SplitterLayer::ValidateTensorShapesFromInputs(), ViewsDescriptor::ViewsDescriptor(), and ViewsDescriptor::~ViewsDescriptor().

GetOrigins()

const OriginsDescriptor & GetOrigins

(

)

const

Get the View Origins.

Definition at line 345 of file Descriptors.cpp.

{
    return m_Origins;
}

Referenced by StringifyLayerParameters< ViewsDescriptor >::Serialize().

GetViewOrigin()

const uint32_t * GetViewOrigin

(

uint32_t

idx

)

const

Get the view origin at the int value idx.

Definition at line 305 of file Descriptors.cpp.

{
    return m_Origins.GetViewOrigin(idx);
}

References OriginsDescriptor::GetViewOrigin().

Referenced by SplitterLayer::CreateWorkload(), and ViewsDescriptor::operator==().

GetViewSizes()

const uint32_t * GetViewSizes

(

uint32_t

idx

)

const

Get the view sizes at the int value idx.

Definition at line 340 of file Descriptors.cpp.

{
    return m_ViewSizes ? m_ViewSizes[idx] : nullptr;
}

Referenced by armnn::ComputeSplitAxis(), SplitterLayer::InferOutputShapes(), ViewsDescriptor::operator==(), StringifyLayerParameters< ViewsDescriptor >::Serialize(), and SplitterLayer::ValidateTensorShapesFromInputs().

operator=()

ViewsDescriptor & operator=

(

ViewsDescriptor

rhs

)

Definition at line 268 of file Descriptors.cpp.

{
    swap(*this, rhs);
    return *this;
}

References ViewsDescriptor::swap.

operator==()

bool operator==

(

const ViewsDescriptor &

rhs

)

const

Definition at line 274 of file Descriptors.cpp.

{
    if (GetNumViews() != rhs.GetNumViews() || GetNumDimensions() != rhs.GetNumDimensions())
    {
        return false;
    }
 
    for (unsigned int i = 0u; i < GetNumViews(); ++i)
    {
        for (unsigned int j = 0u; j < GetNumDimensions(); ++j)
        {
            if (GetViewOrigin(i)[j] != rhs.GetViewOrigin(i)[j] || GetViewSizes(i)[j] != rhs.GetViewSizes(i)[j])
            {
                return false;
            }
        }
    }
 
    return true;
}

References ViewsDescriptor::GetNumDimensions(), ViewsDescriptor::GetNumViews(), ViewsDescriptor::GetViewOrigin(), and ViewsDescriptor::GetViewSizes().

SetViewOriginCoord()

Status SetViewOriginCoord	(	uint32_t	view,
		uint32_t	coord,
		uint32_t	value
	)

@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 310 of file Descriptors.cpp.

{
    return m_Origins.SetViewOriginCoord(view, coord, value);
}

References OriginsDescriptor::SetViewOriginCoord().

SetViewSize()

Status SetViewSize	(	uint32_t	view,
		uint32_t	coord,
		uint32_t	value
	)

Set the size of the views.

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 315 of file Descriptors.cpp.

{
    if (!m_ViewSizes)
    {
        ARMNN_LOG(error) << "ViewsDescriptor::SetViewSize: invalid view sizes";
        return Status::Failure;
    }
 
    if (view >= GetNumViews())
    {
        ARMNN_LOG(error) << "ViewsDescriptor::SetViewSize: view argument:" << view <<
                                 " is out of range";
        return Status::Failure;
    }
    if (coord >= GetNumDimensions())
    {
        ARMNN_LOG(error) << "ViewsDescriptor::SetViewSize: coord argument:" << coord <<
                                 " is out of range";
        return Status::Failure;
    }
 
    m_ViewSizes[view][coord] = value;
    return Status::Success;
}

References ARMNN_LOG, armnn::error, armnn::Failure, ViewsDescriptor::GetNumDimensions(), ViewsDescriptor::GetNumViews(), and armnn::Success.

Friends And Related Function Documentation

swap

void swap ( ViewsDescriptor &  first, ViewsDescriptor &  second  )

friend

Swap the ViewsDescriptor value first and second.

Definition at line 359 of file Descriptors.cpp.

{
    using std::swap;
    swap(first.m_Origins, second.m_Origins);
    swap(first.m_ViewSizes, second.m_ViewSizes);
}

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

---

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

• include/armnn/Descriptors.hpp
• src/armnn/Descriptors.cpp