stk::ArrayView< T > Class Template Reference

Lightweight, non-owning view over a contiguous sequence of elements. More...

#include <stk_common.h>

Public Member Functions
	ArrayView (T *ptr, size_t size)
	Construct an ArrayView from a raw pointer and size.
T &	operator[] (size_t index) const
	Subscript operator for element access.
size_t	GetSize () const
	Get number of elements in the view.

Private Attributes
T *	m_ptr
	Pointer to the underlying memory block.
size_t	m_size
	Total number of elements in the view.

Detailed Description

template<typename T>
class stk::ArrayView< T >

Lightweight, non-owning view over a contiguous sequence of elements.

Note

This descriptor provides a safe encapsulation over raw pointers without copying the underlying data.

Usage example:

stk::ITask *tasks[TASKS_MAX];
ArrayView<stk::ITask *> view(tasks, TASKS_MAX);

Definition at line 246 of file stk_common.h.

Constructor & Destructor Documentation

ArrayView()

template<typename T>

stk::ArrayView< T >::ArrayView ( T * ptr, size_t size )

inline

Construct an ArrayView from a raw pointer and size.

Parameters

[in]	ptr	Pointer to the first element of the contiguous memory block.
[in]	size	Number of elements available in the memory block.

Definition at line 253 of file stk_common.h.

                                   : m_ptr(ptr), m_size(size)
    {}

References m_ptr, and m_size.

Member Function Documentation

GetSize()

template<typename T>

size_t stk::ArrayView< T >::GetSize ( ) const

inline

Get number of elements in the view.

Returns

The size of the array view.

Definition at line 271 of file stk_common.h.

{ return m_size; }

References m_size.

Referenced by stk::Kernel< stk::KERNEL_DYNAMIC|stk::KERNEL_SYNC|stk::KERNEL_TICKLESS,(16U), stk::SwitchStrategyFP32, stk::PlatformDefault >::EnumerateKernelTasks(), stk::Kernel< stk::KERNEL_DYNAMIC|stk::KERNEL_SYNC|stk::KERNEL_TICKLESS,(16U), stk::SwitchStrategyFP32, stk::PlatformDefault >::EnumerateTasks(), stk::IStackMemory::GetStackSpace(), and stk::PlatformContext::InitStackMemory().

Here is the caller graph for this function:

operator[]()

template<typename T>

T & stk::ArrayView< T >::operator[] ( size_t index ) const

inline

Subscript operator for element access.

Parameters

index

Element index to access.

Returns

Reference to the element at the specified index.

Warning

Triggers STK_ASSERT if index is out of bounds in a Debug build.

Definition at line 261 of file stk_common.h.

    {
        STK_ASSERT(index < m_size);
        //MISRA 5-0-15 deviation: bounds are checked via STK_ASSERT
        return m_ptr[index];
    }

References m_ptr, m_size, and STK_ASSERT.

Member Data Documentation

m_ptr

template<typename T>

T* stk::ArrayView< T >::m_ptr

private

Pointer to the underlying memory block.

Definition at line 274 of file stk_common.h.

Referenced by ArrayView(), and operator[]().

m_size

template<typename T>

size_t stk::ArrayView< T >::m_size

private

Total number of elements in the view.

Definition at line 275 of file stk_common.h.

Referenced by ArrayView(), GetSize(), and operator[]().

---

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

• stk_common.h