View over a contiguous sequence of items (pointer + size in elements). More...

#include <Span.h>

Public Member Functions
template<size_t N, typename U = Type, EnableNotVoid< U > = true>
constexpr	Span (U(&itemsArray)[N])

constexpr	Span ()
	Builds an empty Span. More...

constexpr	Span (Type *items, SizeType sizeInElements)
	Builds a Span from an array. More...

template<typename U = Type>
constexpr	Span (TypeIfNotVoid< U > &type)
	Builds a Span from a single object. More...

template<typename U = Type>
constexpr	Span (std::initializer_list< TypeIfNotVoid< U > > list)
	Span specialized constructor (mainly used for converting const char* to StringView) More...

template<typename U = Type>
	operator Span< const TypeIfNotVoid< U > > () const

template<typename U = Type>
	operator Span< TypeIfNotVoid< U > > ()

	operator Span< const void > () const

	operator Span< void > ()

template<typename T >
Span< const T >	reinterpret_as_array_of () const
	Reinterprets the current span as an array of the specified type. More...

template<typename T >
Span< T >	reinterpret_as_array_of ()
	Reinterprets the current span as an array of the specified type. More...

constexpr const Type *	begin () const
	Returns pointer to first element of the span. More...

constexpr const Type *	end () const
	Returns pointer to one after the last element of the span. More...

constexpr const Type *	data () const
	Returns pointer to first element of the span. More...

constexpr Type *	begin ()
	Returns pointer to first element of the span. More...

constexpr Type *	end ()
	Returns pointer to one after the last element of the span. More...

constexpr Type *	data ()
	Returns pointer to first element of the span. More...

constexpr SizeType	sizeInElements () const
	Size of Span in elements. More...

constexpr SizeType	sizeInBytes () const
	Size of Span in bytes. More...

constexpr bool	sliceStart (SizeType offsetInElements, Span &destination) const
	Creates another Span, starting at an offset in elements from current Span, until end. More...

constexpr bool	sliceStartLength (SizeType offsetInElements, SizeType lengthInElements, Span &destination) const
	Creates another Span, starting at an offset in elements from current Span of specified length. More...

bool	sliceFromStartUntil (Span other, Span &output) const
	Creates another Span shorter or equal than the current one such that its end equals other.data(). More...

constexpr bool	empty () const
	Check if Span is empty. More...

template<typename U >
constexpr bool	contains (const U &value, SizeType *index=nullptr) const
	Check if the current span contains a given value. More...

template<typename Lambda >
constexpr bool	find (Lambda &&lambda, SizeType *index=nullptr) const
	Finds the first item in span matching criteria given by the lambda. More...

template<typename U = Type>
TypeIfNotVoid< U > &	operator[] (SizeType idx)

template<typename U = Type>
const TypeIfNotVoid< U > &	operator[] (SizeType idx) const

template<typename IntType >
Type *	get (IntType idx)
	Gets the item at given index or nullptr if index is negative or bigger than size. More...

template<typename IntType >
const Type *	get (IntType idx) const
	Gets the item at given index or nullptr if index is negative or bigger than size. More...

template<typename U >
bool	memcmpWith (const Span< U > other) const
	Compares this span with another one byte by byte. More...

template<typename U >
bool	memcpyTo (Span< U > &other) const
	Bitwise copies contents of this Span over another (non-overlapping) More...

Static Public Member Functions
template<typename T >
static Span< Type >	reinterpret_object (T &value)
	Constructs a Span reinterpreting memory pointed by object of type `T` as a type `Type` More...

static Span< Type >	reinterpret_bytes (VoidType *rawMemory, SizeType sizeInBytes)
	Construct a span reinterpreting raw memory (`void` or `const void`) to `Type` or `const Type` More...

Detailed Description

template<typename Type>
struct SC::Span< Type >

View over a contiguous sequence of items (pointer + size in elements).

Template Parameters

Type Any type

Constructor & Destructor Documentation

◆ Span() [1/4]

template<typename Type >

constexpr SC::Span< Type >::Span ( )

inlineconstexpr

Builds an empty Span.

◆ Span() [2/4]

template<typename Type >

constexpr SC::Span< Type >::Span	(	Type *	items,
		SizeType	sizeInElements
	)

inlineconstexpr

Builds a Span from an array.

Parameters

items	pointer to the first member of the array
sizeInElements	number of elements in in the array

◆ Span() [3/4]

template<typename Type >

template<typename U = Type>

constexpr SC::Span< Type >::Span ( TypeIfNotVoid< U > & type )

inlineconstexpr

Builds a Span from a single object.

Parameters

type	A reference to a single object of type Type

◆ Span() [4/4]

template<typename Type >

template<typename U = Type>

constexpr SC::Span< Type >::Span ( std::initializer_list< TypeIfNotVoid< U > > list )

inlineconstexpr

Span specialized constructor (mainly used for converting const char* to StringView)

Parameters

list	an initializer list of elements

Member Function Documentation

◆ begin() [1/2]

template<typename Type >

constexpr Type * SC::Span< Type >::begin ( )

inlineconstexpr

Returns pointer to first element of the span.

Returns: pointer to first element of the span

◆ begin() [2/2]

template<typename Type >

constexpr const Type * SC::Span< Type >::begin ( ) const

inlineconstexpr

Returns pointer to first element of the span.

Returns: pointer to first element of the span

◆ contains()

template<typename Type >

template<typename U >

constexpr bool SC::Span< Type >::contains	(	const U &	value,
		SizeType *	index = `nullptr`
	)		const

inlineconstexpr

Check if the current span contains a given value.

Template Parameters

U	Type of the object being searched

Parameters

value	Value being searched
index	if passed in != `nullptr`, receives index where item was found. Only written if function returns `true`

Returns: true if the vector contains the given value.

◆ data() [1/2]

template<typename Type >

constexpr Type * SC::Span< Type >::data ( )

inlineconstexpr

Returns pointer to first element of the span.

Returns: pointer to first element of the span

◆ data() [2/2]

template<typename Type >

constexpr const Type * SC::Span< Type >::data ( ) const

inlineconstexpr

Returns pointer to first element of the span.

Returns: pointer to first element of the span

◆ empty()

template<typename Type >

constexpr bool SC::Span< Type >::empty ( ) const

inlineconstexpr

Check if Span is empty.

Returns: true if Span is empty

◆ end() [1/2]

template<typename Type >

constexpr Type * SC::Span< Type >::end ( )

inlineconstexpr

Returns pointer to one after the last element of the span.

Returns: Pointer to one after the last element of the span

◆ end() [2/2]

template<typename Type >

constexpr const Type * SC::Span< Type >::end ( ) const

inlineconstexpr

Returns pointer to one after the last element of the span.

Returns: Pointer to one after the last element of the span

◆ find()

template<typename Type >

template<typename Lambda >

constexpr bool SC::Span< Type >::find	(	Lambda &&	lambda,
		SizeType *	index = `nullptr`
	)		const

inlineconstexpr

Finds the first item in span matching criteria given by the lambda.

Template Parameters

Lambda Type of the Lambda passed that declares a bool operator()(const T&) operator

Parameters

lambda	The functor or lambda called that evaluates to `true` when item is found
index	if passed in != `nullptr`, receives index where item was found.

Returns: true if the wanted value with given criteria is found.

◆ get() [1/2]

template<typename Type >

template<typename IntType >

Type * SC::Span< Type >::get ( IntType idx )

inline

Gets the item at given index or nullptr if index is negative or bigger than size.

◆ get() [2/2]

template<typename Type >

template<typename IntType >

const Type * SC::Span< Type >::get ( IntType idx ) const

inline

Gets the item at given index or nullptr if index is negative or bigger than size.

◆ memcmpWith()

template<typename Type >

template<typename U >

bool SC::Span< Type >::memcmpWith ( const Span< U > other ) const

inline

Compares this span with another one byte by byte.

◆ memcpyTo()

template<typename Type >

template<typename U >

bool SC::Span< Type >::memcpyTo ( Span< U > & other ) const

inline

Bitwise copies contents of this Span over another (non-overlapping)

◆ reinterpret_as_array_of() [1/2]

template<typename Type >

template<typename T >

Span< T > SC::Span< Type >::reinterpret_as_array_of ( )

inline

Reinterprets the current span as an array of the specified type.

◆ reinterpret_as_array_of() [2/2]

template<typename Type >

template<typename T >

Span< const T > SC::Span< Type >::reinterpret_as_array_of ( ) const

inline

Reinterprets the current span as an array of the specified type.

◆ reinterpret_bytes()

template<typename Type >

static Span< Type > SC::Span< Type >::reinterpret_bytes	(	VoidType *	rawMemory,
		SizeType	sizeInBytes
	)

inlinestatic

Construct a span reinterpreting raw memory (void* or const void*) to Type or const Type

Parameters

rawMemory	Pointer to raw buffer of memory
sizeInBytes	Size of the raw buffer in Bytes

Returns: The reinterpreted Span object

◆ reinterpret_object()

template<typename Type >

template<typename T >

static Span< Type > SC::Span< Type >::reinterpret_object ( T & value )

inlinestatic

Constructs a Span reinterpreting memory pointed by object of type T as a type Type

Template Parameters

T	Type of object to be reinterpreted

Parameters

value The source object to be reinterpreted

Returns: The output converted Span object

◆ sizeInBytes()

template<typename Type >

constexpr SizeType SC::Span< Type >::sizeInBytes ( ) const

inlineconstexpr

Size of Span in bytes.

Returns: The number of bytes covering the entire Span

◆ sizeInElements()

template<typename Type >

constexpr SizeType SC::Span< Type >::sizeInElements ( ) const

inlineconstexpr

Size of Span in elements.

Returns: The number of elements of the Span

◆ sliceFromStartUntil()

template<typename Type >

bool SC::Span< Type >::sliceFromStartUntil	(	Span< Type >	other,
		Span< Type > &	output
	)		const

inline

Creates another Span shorter or equal than the current one such that its end equals other.data().

Parameters

other	The other Span that defines length of output slice
output	The slice extracted from current span

◆ sliceStart()

template<typename Type >

constexpr bool SC::Span< Type >::sliceStart	(	SizeType	offsetInElements,
		Span< Type > &	destination
	)		const

inlineconstexpr

Creates another Span, starting at an offset in elements from current Span, until end.

Parameters

offsetInElements	Offset in current Span where destination Span will be starting
destination	Reference to a Span that will hold the resulting computed span

Returns

true if destination has been written.
false if offsetInElements is bigger to than Span::size().

◆ sliceStartLength()

template<typename Type >

constexpr bool SC::Span< Type >::sliceStartLength	(	SizeType	offsetInElements,
		SizeType	lengthInElements,
		Span< Type > &	destination
	)		const

inlineconstexpr

Creates another Span, starting at an offset in elements from current Span of specified length.

Parameters

offsetInElements	Offset in current Span where destination Span will be starting
lengthInElements	Number of elements wanted for destination Span
destination	Reference to a Span that will hold the resulting computed span

Returns

true if destination has been written.
false if (offsetInElements + lengthInElements) is bigger to than Span::size().

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

Span.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Span() [1/4]

◆ Span() [2/4]

◆ Span() [3/4]

◆ Span() [4/4]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ contains()

◆ data() [1/2]

◆ data() [2/2]

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ find()

◆ get() [1/2]

◆ get() [2/2]

◆ memcmpWith()

◆ memcpyTo()

◆ reinterpret_as_array_of() [1/2]

◆ reinterpret_as_array_of() [2/2]

◆ reinterpret_bytes()

◆ reinterpret_object()

◆ sizeInBytes()

◆ sizeInElements()

◆ sliceFromStartUntil()

◆ sliceStart()

◆ sliceStartLength()