stk::ArrayView< T > Class Template Reference

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

#include <stk_common.h>

Public Types
typedef T	value_type

Public Member Functions
	ArrayView ()
	Construct an empty ArrayView with a null pointer and zero size.
	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.
T *	GetPtr ()
	Get pointer to the beginning of elements in the view.
const T *	GetPtr () const
	Get constant pointer to the beginning of elements in the view.
size_t	GetSize () const
	Get number of elements in the view.

Private Member Functions
T &	UncheckedAt (size_t index) const
	Deviation MISRA-CPP-2008-5-0-15 \reason Array indexing on a base pointer is required for a dynamic-size non-owning view. The pointer and size are externally supplied. Bounds are enforced by the public API (STK_ASSERT / operator[]).

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

Provides a safe encapsulation over raw pointers without copying the underlying data. Includes binary serialization methods for compact state transfer on 32-bit platforms.

Usage example:

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

Definition at line 253 of file stk_common.h.

Member Typedef Documentation

value_type

template<typename T>

typedef T stk::ArrayView< T >::value_type

Definition at line 256 of file stk_common.h.

Constructor & Destructor Documentation

ArrayView() [1/2]

template<typename T>

stk::ArrayView< T >::ArrayView ( )

inline

Construct an empty ArrayView with a null pointer and zero size.

Definition at line 260 of file stk_common.h.

                : m_ptr(nullptr), m_size(0U)
    {}

References m_ptr, and m_size.

ArrayView() [2/2]

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 267 of file stk_common.h.

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

References m_ptr, and m_size.

Member Function Documentation

GetPtr() [1/2]

template<typename T>

T * stk::ArrayView< T >::GetPtr ( )

inline

Get pointer to the beginning of elements in the view.

Returns

Pointer to the elements of array.

Definition at line 284 of file stk_common.h.

{ return m_ptr; }

References m_ptr.

GetPtr() [2/2]

template<typename T>

const T * stk::ArrayView< T >::GetPtr ( ) const

inline

Get constant pointer to the beginning of elements in the view.

Returns

Constant pointer to the elements of array.

Definition at line 289 of file stk_common.h.

{ return m_ptr; }

References m_ptr.

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 294 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

[in]

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 275 of file stk_common.h.

    {
        STK_ASSERT(index < m_size); // enforces MISRA Rule 5-0-16
        return UncheckedAt(index);  // MISRA Rule 5-0-15 deviation centralized
    }

References m_size, STK_ASSERT, and UncheckedAt().

Here is the call graph for this function:

UncheckedAt()

template<typename T>

T & stk::ArrayView< T >::UncheckedAt ( size_t index ) const

inlineprivate

Deviation MISRA-CPP-2008-5-0-15 \reason Array indexing on a base pointer is required for a dynamic-size non-owning view. The pointer and size are externally supplied. Bounds are enforced by the public API (STK_ASSERT / operator[]).

Definition at line 302 of file stk_common.h.

    {
        return m_ptr[index]; // deviation: indexing non-array pointer
    }

References __stk_forceinline, and m_ptr.

Referenced by operator[]().

Here is the caller graph for this function:

Member Data Documentation

m_ptr

template<typename T>

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

private

Pointer to the underlying memory block.

Definition at line 307 of file stk_common.h.

Referenced by ArrayView(), ArrayView(), GetPtr(), GetPtr(), and UncheckedAt().

m_size

template<typename T>

size_t stk::ArrayView< T >::m_size

private

Total number of elements in the view.

Definition at line 308 of file stk_common.h.

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

---

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

• stk_common.h