A span referencing a 2D matrix buffer. More...

#include <rtctk/componentFramework/matrixSpan.hpp>

Inheritance diagram for rtctk::componentFramework::MatrixSpan< T >:

Public Types
using	const_pointer = const T*

using	const_reference = const T&

Public Member Functions
constexpr	MatrixSpan () noexcept

constexpr	MatrixSpan (const MatrixSpan &other)

constexpr MatrixSpan &	operator= (const MatrixSpan &other)

constexpr	MatrixSpan (MatrixSpan &&other) noexcept

constexpr MatrixSpan &	operator= (MatrixSpan &&other) noexcept

constexpr	MatrixSpan (size_type n, size_type m, const gsl::span< T > &data)

template<class I>
constexpr	MatrixSpan (size_type n, size_type m, I first, size_type count)

template<class I>
constexpr	MatrixSpan (size_type n, size_type m, I first, I last)

template<std::size_t N>
constexpr	MatrixSpan (size_type n, size_type m, element_type(&array)[N]) noexcept

template<std::size_t N>
constexpr	MatrixSpan (size_type n, size_type m, std::array< T, N > &array) noexcept

template<std::size_t N>
constexpr	MatrixSpan (size_type n, size_type m, const std::array< T, N > &array) noexcept

template<typename R>
constexpr	MatrixSpan (size_type n, size_type m, R &&range) noexcept

template<typename A>
constexpr	MatrixSpan (MatrixBuffer< T, A > &buffer) noexcept

template<typename A> requires std::is_const_v<T> or std::is_volatile_v<T>
constexpr	MatrixSpan (MatrixBuffer< std::remove_cv_t< T >, A > &buffer) noexcept

template<typename U> requires std::is_same_v<std::remove_cv_t<T>, std::remove_cv_t<U>>
bool	operator== (const MatrixSpan< U > &rhs) const

constexpr reference	operator() (size_type n, size_type m)

constexpr const_reference	operator() (size_type n, size_type m) const

size_type	GetNrows () const

size_type	GetNcols () const

size_t	GetElementIndex (size_t row, size_t col)

Detailed Description

template<typename T>
class rtctk::componentFramework::MatrixSpan< T >

A span referencing a 2D matrix buffer.

A span class that simply extends gsl::span to record the number of rows and columns of a matrix and checks that this correctly corresponds to the underlying buffer size in debug builds.

Member Typedef Documentation

◆ const_pointer

template<typename T>

using rtctk::componentFramework::MatrixSpan< T >::const_pointer = const T*

◆ const_reference

template<typename T>

using rtctk::componentFramework::MatrixSpan< T >::const_reference = const T&

Constructor & Destructor Documentation

◆ MatrixSpan() [1/12]

template<typename T>

rtctk::componentFramework::MatrixSpan< T >::MatrixSpan ( )

inlineconstexprnoexcept

◆ MatrixSpan() [2/12]

template<typename T>

rtctk::componentFramework::MatrixSpan< T >::MatrixSpan ( const MatrixSpan< T > & other )

inlineconstexpr

◆ MatrixSpan() [3/12]

template<typename T>

rtctk::componentFramework::MatrixSpan< T >::MatrixSpan ( MatrixSpan< T > && other )

inlineconstexprnoexcept

◆ MatrixSpan() [4/12]

template<typename T>

rtctk::componentFramework::MatrixSpan< T >::MatrixSpan	(	size_type	n,
		size_type	m,
		const gsl::span< T > &	data )

inlineexplicitconstexpr

◆ MatrixSpan() [5/12]

template<typename T>

template<class I>

rtctk::componentFramework::MatrixSpan< T >::MatrixSpan	(	size_type	n,
		size_type	m,
		I	first,
		size_type	count )

inlineexplicitconstexpr

◆ MatrixSpan() [6/12]

template<typename T>

template<class I>

rtctk::componentFramework::MatrixSpan< T >::MatrixSpan	(	size_type	n,
		size_type	m,
		I	first,
		I	last )

inlineexplicitconstexpr