Kev Mann / mbed-dev-OS5_10_4

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

Span class
Data Structures | Functions | Variables

Span class
[Platform]

Data Structures

struct  Span< ElementType, Extent >
 Nonowning view to a sequence of contiguous elements. More...
struct  Span< ElementType, SPAN_DYNAMIC_EXTENT >
 Span specialization that handle dynamic size. More...

Functions

template<typename T , ptrdiff_t LhsExtent, ptrdiff_t RhsExtent>
bool operator== (const Span< T, LhsExtent > &lhs, T(&rhs)[RhsExtent])
 Equality operation between a Span and a reference to a C++ array.
template<typename T , ptrdiff_t LhsExtent, ptrdiff_t RhsExtent>
bool operator== (T(&lhs)[LhsExtent], const Span< T, RhsExtent > &rhs)
 Equality operation between a Span and a reference to a C++ array.
template<typename T , ptrdiff_t LhsExtent, ptrdiff_t RhsExtent>
bool operator!= (const Span< T, LhsExtent > &lhs, T(&rhs)[RhsExtent])
 Not Equal operation between a Span and a reference to a C++ array.
template<typename T , ptrdiff_t LhsExtent, ptrdiff_t RhsExtent>
bool operator!= (T(&lhs)[LhsExtent], const Span< T, RhsExtent > &rhs)
 Not Equal operation between a Span and a reference to a C++ array.
template<ptrdiff_t Extent, typename T >
Span< T, Extent > make_Span (T *elements)
 Generate a Span from a pointer to a C/C++ array.
template<typename T , size_t Extent>
Span< const T, Extent > make_const_Span (const T(&elements)[Extent])
 Generate a Span to a const content from a reference to a C/C++ array.
template<typename T , typename U , ptrdiff_t LhsExtent, ptrdiff_t RhsExtent>
bool operator== (const Span< T, LhsExtent > &lhs, const Span< U, RhsExtent > &rhs)
 Equality operator between two Span objects.
template<typename T , typename U , ptrdiff_t LhsExtent, ptrdiff_t RhsExtent>
bool operator!= (const Span< T, LhsExtent > &lhs, const Span< U, RhsExtent > &rhs)
 Not equal operator.
template<typename T , size_t Size>
Span< T, Size > make_Span (T(&elements)[Size])
 Generate a Span from a reference to a C/C++ array.
template<typename T >
Span< T > make_Span (T *array_ptr, ptrdiff_t array_size)
 Generate a Span from a C/C++ pointer and the size of the array.
template<size_t Extent, typename T >
Span< const T, Extent > make_const_Span (const T *elements)
 Generate a Span to a const content from a pointer to a C/C++ array.
template<typename T >
Span< const T > make_const_Span (T *array_ptr, size_t array_size)
 Generate a Span to a const content from a C/C++ pointer and the size of the array.

Variables

const ptrdiff_t SPAN_DYNAMIC_EXTENT = -1
 Special value for the Extent parameter of Span.

Function Documentation

Span<const T, Extent> mbed::make_const_Span ( const T(&)  elements[Extent] )

Generate a Span to a const content from a reference to a C/C++ array.

Template Parameters:
TType of elements held in elements.
ExtentNumber of items held in elements.
Parameters:
elementsThe array viewed.
Returns:
The Span to elements.
Note:
This helper avoids the typing of template parameter when Span is created 'inline'.

Definition at line 958 of file Span.h.

Span< const T, Extent > make_const_Span ( const T *  elements ) [related, inherited]

Generate a Span to a const content from a pointer to a C/C++ array.

Template Parameters:
ExtentNumber of items held in elements.
TType of elements held in elements.
Parameters:
elementsThe reference to the array viewed.
Returns:
The Span to elements.
Note:
This helper avoids the typing of template parameter when Span is created 'inline'.

Definition at line 979 of file Span.h.

Span< const T > make_const_Span ( T *  array_ptr,
size_t  array_size 
) [related, inherited]

Generate a Span to a const content from a C/C++ pointer and the size of the array.

Template Parameters:
TType of elements held in array_ptr.
Parameters:
array_ptrThe pointer to the array to viewed.
array_sizeThe number of T elements in the array.
Returns:
The Span to array_ptr with a size of array_size.
Note:
This helper avoids the typing of template parameter when Span is created 'inline'.

Definition at line 1001 of file Span.h.

Span< T, Size > make_Span ( T(&)  elements[Size] ) [related, inherited]

Generate a Span from a reference to a C/C++ array.

Template Parameters:
TType of elements held in elements.
ExtentNumber of items held in elements.
Parameters:
elementsThe reference to the array viewed.
Returns:
The Span to elements.
Note:
This helper avoids the typing of template parameter when Span is created 'inline'.

Definition at line 900 of file Span.h.

Span< T > make_Span ( T *  array_ptr,
ptrdiff_t  array_size 
) [related, inherited]

Generate a Span from a C/C++ pointer and the size of the array.

Template Parameters:
TType of elements held in array_ptr.
Parameters:
array_ptrThe pointer to the array viewed.
array_sizeThe number of T elements in the array.
Returns:
The Span to array_ptr with a size of array_size.
Note:
This helper avoids the typing of template parameter when Span is created 'inline'.

Definition at line 940 of file Span.h.

Span<T, Extent> mbed::make_Span ( T *  elements )

Generate a Span from a pointer to a C/C++ array.

Template Parameters:
ExtentNumber of items held in elements.
TType of elements held in elements.
Parameters:
elementsThe reference to the array viewed.
Returns:
The Span to elements.
Note:
This helper avoids the typing of template parameter when Span is created 'inline'.

Definition at line 919 of file Span.h.

bool operator!= ( const Span< T, LhsExtent > &  lhs,
const Span< U, RhsExtent > &  rhs 
) [related, inherited]

Not equal operator.

Parameters:
lhsLeft side of the binary operation.
rhsRight side of the binary operation.
Returns:
True if arrays in input do not have the same size or the same content and false otherwise.

Definition at line 849 of file Span.h.

bool mbed::operator!= ( const Span< T, LhsExtent > &  lhs,
T(&)  rhs[RhsExtent] 
)

Not Equal operation between a Span and a reference to a C++ array.

Parameters:
lhsLeft side of the binary operation.
rhsRight side of the binary operation.
Returns:
True if elements in input have the same size and the same content and false otherwise.

Definition at line 864 of file Span.h.

bool mbed::operator!= ( T(&)  lhs[LhsExtent],
const Span< T, RhsExtent > &  rhs 
)

Not Equal operation between a Span and a reference to a C++ array.

Parameters:
lhsLeft side of the binary operation.
rhsRight side of the binary operation.
Returns:
True if elements in input have the same size and the same content and false otherwise.

Definition at line 879 of file Span.h.

bool operator== ( const Span< T, LhsExtent > &  lhs,
const Span< U, RhsExtent > &  rhs 
) [related, inherited]

Equality operator between two Span objects.

Parameters:
lhsLeft side of the binary operation.
rhsRight side of the binary operation.
Returns:
True if Spans in input have the same size and the same content and false otherwise.

Definition at line 794 of file Span.h.

bool mbed::operator== ( T(&)  lhs[LhsExtent],
const Span< T, RhsExtent > &  rhs 
)

Equality operation between a Span and a reference to a C++ array.

Parameters:
lhsLeft side of the binary operation.
rhsRight side of the binary operation.
Returns:
True if elements in input have the same size and the same content and false otherwise.

Definition at line 832 of file Span.h.

bool mbed::operator== ( const Span< T, LhsExtent > &  lhs,
T(&)  rhs[RhsExtent] 
)

Equality operation between a Span and a reference to a C++ array.

Parameters:
lhsLeft side of the binary operation.
rhsRight side of the binary operation.
Returns:
True if elements in input have the same size and the same content and false otherwise.

Definition at line 817 of file Span.h.

Variable Documentation

const ptrdiff_t SPAN_DYNAMIC_EXTENT = -1 [related, inherited]

Special value for the Extent parameter of Span.

If the type uses this value, then the size of the array is stored in the object at runtime.

Definition at line 65 of file Span.h.

Generated on Tue Jul 12 2022 20:53:08 by  doxygen 1.7.2