osc::CircularBuffer< T, N > Class Template Reference

#include <circular_buffer.h>

Public Types
using	value_type = T
using	size_type = size_t
using	reference = T &
using	const_reference = const T &
using	iterator = Iterator< false >
using	const_iterator = Iterator< true >
using	reverse_iterator = std::reverse_iterator< iterator >
using	const_reverse_iterator = std::reverse_iterator< const_iterator >

Public Member Functions
	CircularBuffer ()=default
	CircularBuffer (const CircularBuffer &)=delete
	CircularBuffer (CircularBuffer &&) noexcept=delete
CircularBuffer &	operator= (const CircularBuffer &)=delete
CircularBuffer &	operator= (CircularBuffer &&) noexcept=delete
	~CircularBuffer () noexcept
constexpr reference	at (size_type pos)
constexpr const_reference	at (size_type pos) const
constexpr reference	operator[] (size_type pos)
constexpr const_reference	operator[] (size_type pos) const
constexpr reference	front ()
constexpr const_reference	front () const
constexpr reference	back ()
constexpr const_reference	back () const
constexpr const_iterator	begin () const
constexpr iterator	begin ()
constexpr const_iterator	cbegin () const
constexpr const_iterator	end () const
constexpr iterator	end ()
constexpr const_iterator	cend () const
constexpr const_reverse_iterator	rbegin () const
constexpr reverse_iterator	rbegin ()
constexpr const_reverse_iterator	crbegin () const
constexpr const_reverse_iterator	rend () const
constexpr reverse_iterator	rend ()
constexpr const_reverse_iterator	crend () const
constexpr bool	empty () const
constexpr size_type	size () const
constexpr size_type	max_size () const
constexpr void	clear ()
template<typename... Args> requires std::constructible_from<T, Args&&...>
constexpr T &	emplace_back (Args &&... args)
constexpr void	push_back (const T &value)
constexpr void	push_back (T &&value)
constexpr iterator	erase (iterator first, iterator last)
constexpr std::optional< T >	try_pop_back ()
constexpr T	pop_back ()

Member Typedef Documentation

const_iterator

template<typename T , size_t N>

using osc::CircularBuffer< T, N >::const_iterator = Iterator<true>

const_reference

template<typename T , size_t N>

using osc::CircularBuffer< T, N >::const_reference = const T&

const_reverse_iterator

template<typename T , size_t N>

using osc::CircularBuffer< T, N >::const_reverse_iterator = std::reverse_iterator<const_iterator>

iterator

template<typename T , size_t N>

using osc::CircularBuffer< T, N >::iterator = Iterator<false>

reference

template<typename T , size_t N>

using osc::CircularBuffer< T, N >::reference = T&

reverse_iterator

template<typename T , size_t N>

using osc::CircularBuffer< T, N >::reverse_iterator = std::reverse_iterator<iterator>

size_type

template<typename T , size_t N>

using osc::CircularBuffer< T, N >::size_type = size_t

value_type

template<typename T , size_t N>

using osc::CircularBuffer< T, N >::value_type = T

Constructor & Destructor Documentation

CircularBuffer() [1/3]

template<typename T , size_t N>

osc::CircularBuffer< T, N >::CircularBuffer ( )

default

CircularBuffer() [2/3]

template<typename T , size_t N>

osc::CircularBuffer< T, N >::CircularBuffer ( const CircularBuffer< T, N > &  )

delete

CircularBuffer() [3/3]

template<typename T , size_t N>

osc::CircularBuffer< T, N >::CircularBuffer ( CircularBuffer< T, N > &&  )

deletenoexcept

~CircularBuffer()

template<typename T , size_t N>

osc::CircularBuffer< T, N >::~CircularBuffer ( )

inlinenoexcept

Member Function Documentation

at() [1/2]

template<typename T , size_t N>

constexpr reference osc::CircularBuffer< T, N >::at ( size_type  pos )

inlineconstexpr

at() [2/2]

template<typename T , size_t N>

constexpr const_reference osc::CircularBuffer< T, N >::at ( size_type  pos ) const

inlineconstexpr

back() [1/2]

template<typename T , size_t N>

constexpr reference osc::CircularBuffer< T, N >::back ( )

inlineconstexpr

back() [2/2]

template<typename T , size_t N>

constexpr const_reference osc::CircularBuffer< T, N >::back ( ) const

inlineconstexpr

begin() [1/2]

template<typename T , size_t N>

constexpr iterator osc::CircularBuffer< T, N >::begin ( )

inlineconstexpr

begin() [2/2]

template<typename T , size_t N>

constexpr const_iterator osc::CircularBuffer< T, N >::begin ( ) const

inlineconstexpr

cbegin()

template<typename T , size_t N>

constexpr const_iterator osc::CircularBuffer< T, N >::cbegin ( ) const

inlineconstexpr

cend()

template<typename T , size_t N>

constexpr const_iterator osc::CircularBuffer< T, N >::cend ( ) const

inlineconstexpr

clear()

template<typename T , size_t N>

constexpr void osc::CircularBuffer< T, N >::clear ( )

inlineconstexpr

crbegin()

template<typename T , size_t N>

constexpr const_reverse_iterator osc::CircularBuffer< T, N >::crbegin ( ) const

inlineconstexpr

crend()

template<typename T , size_t N>

constexpr const_reverse_iterator osc::CircularBuffer< T, N >::crend ( ) const

inlineconstexpr

emplace_back()

template<typename T , size_t N>

template<typename... Args>
requires std::constructible_from<T, Args&&...>

constexpr T & osc::CircularBuffer< T, N >::emplace_back ( Args &&...  args )

inlineconstexpr

empty()

template<typename T , size_t N>

constexpr bool osc::CircularBuffer< T, N >::empty ( ) const

inlineconstexpr

end() [1/2]

template<typename T , size_t N>

constexpr iterator osc::CircularBuffer< T, N >::end ( )

inlineconstexpr

end() [2/2]

template<typename T , size_t N>

constexpr const_iterator osc::CircularBuffer< T, N >::end ( ) const

inlineconstexpr

erase()

template<typename T , size_t N>

constexpr iterator osc::CircularBuffer< T, N >::erase ( iterator  first, iterator  last  )

inlineconstexpr

front() [1/2]

template<typename T , size_t N>

constexpr reference osc::CircularBuffer< T, N >::front ( )

inlineconstexpr

front() [2/2]

template<typename T , size_t N>

constexpr const_reference osc::CircularBuffer< T, N >::front ( ) const

inlineconstexpr

max_size()

template<typename T , size_t N>

constexpr size_type osc::CircularBuffer< T, N >::max_size ( ) const

inlineconstexpr

operator=() [1/2]

template<typename T , size_t N>

CircularBuffer & osc::CircularBuffer< T, N >::operator= ( CircularBuffer< T, N > &&  )

deletenoexcept

operator=() [2/2]

template<typename T , size_t N>

CircularBuffer & osc::CircularBuffer< T, N >::operator= ( const CircularBuffer< T, N > &  )

delete

operator[]() [1/2]

template<typename T , size_t N>

constexpr reference osc::CircularBuffer< T, N >::operator[] ( size_type  pos )

inlineconstexpr

operator[]() [2/2]

template<typename T , size_t N>

constexpr const_reference osc::CircularBuffer< T, N >::operator[] ( size_type  pos ) const

inlineconstexpr

pop_back()

template<typename T , size_t N>

constexpr T osc::CircularBuffer< T, N >::pop_back ( )

inlineconstexpr

push_back() [1/2]

template<typename T , size_t N>

constexpr void osc::CircularBuffer< T, N >::push_back ( const T &  value )

inlineconstexpr

push_back() [2/2]

template<typename T , size_t N>

constexpr void osc::CircularBuffer< T, N >::push_back ( T &&  value )

inlineconstexpr

rbegin() [1/2]

template<typename T , size_t N>

constexpr reverse_iterator osc::CircularBuffer< T, N >::rbegin ( )

inlineconstexpr

rbegin() [2/2]

template<typename T , size_t N>

constexpr const_reverse_iterator osc::CircularBuffer< T, N >::rbegin ( ) const

inlineconstexpr

rend() [1/2]

template<typename T , size_t N>

constexpr reverse_iterator osc::CircularBuffer< T, N >::rend ( )

inlineconstexpr

rend() [2/2]

template<typename T , size_t N>

constexpr const_reverse_iterator osc::CircularBuffer< T, N >::rend ( ) const

inlineconstexpr

size()

template<typename T , size_t N>

constexpr size_type osc::CircularBuffer< T, N >::size ( ) const

inlineconstexpr

try_pop_back()

template<typename T , size_t N>

constexpr std::optional< T > osc::CircularBuffer< T, N >::try_pop_back ( )

inlineconstexpr

---

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

• /home/adam/Desktop/opensim-creator/third_party/opynsim/liboscar/utilities/circular_buffer.h