FastLED 3.9.3
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CircularBuffer< T > Class Template Reference

Detailed Description

template<typename T>
class CircularBuffer< T >

Definition at line 12 of file circular_buffer.h.

Public Member Functions

 CircularBuffer (size_t capacity)
 
 CircularBuffer (const CircularBuffer &)=delete
 
CircularBuffer & operator= (const CircularBuffer &)=delete
 
bool push_back (const T &value)
 
bool pop_front (T *dst=nullptr)
 
bool pop_back (T *dst=nullptr)
 
bool push_front (const T &value)
 
T & front ()
 
const T & front () const
 
T & back ()
 
const T & back () const
 
T & operator[] (size_t index)
 
const T & operator[] (size_t index) const
 
size_t size () const
 
size_t capacity () const
 
bool empty () const
 
bool full () const
 
void clear ()
 

Constructor & Destructor Documentation

◆ CircularBuffer()

template<typename T >
CircularBuffer< T >::CircularBuffer ( size_t capacity)
inline

Definition at line 15 of file circular_buffer.h.

Member Function Documentation

◆ back() [1/2]

template<typename T >
T & CircularBuffer< T >::back ( )
inline

Definition at line 101 of file circular_buffer.h.

◆ back() [2/2]

template<typename T >
const T & CircularBuffer< T >::back ( ) const
inline

Definition at line 105 of file circular_buffer.h.

◆ capacity()

template<typename T >
size_t CircularBuffer< T >::capacity ( ) const
inline

Definition at line 125 of file circular_buffer.h.

◆ clear()

template<typename T >
void CircularBuffer< T >::clear ( )
inline

Definition at line 140 of file circular_buffer.h.

◆ empty()

template<typename T >
bool CircularBuffer< T >::empty ( ) const
inline

Definition at line 130 of file circular_buffer.h.

◆ front() [1/2]

template<typename T >
T & CircularBuffer< T >::front ( )
inline

Definition at line 92 of file circular_buffer.h.

◆ front() [2/2]

template<typename T >
const T & CircularBuffer< T >::front ( ) const
inline

Definition at line 96 of file circular_buffer.h.

◆ full()

template<typename T >
bool CircularBuffer< T >::full ( ) const
inline

Definition at line 135 of file circular_buffer.h.

◆ operator[]() [1/2]

template<typename T >
T & CircularBuffer< T >::operator[] ( size_t index)
inline

Definition at line 110 of file circular_buffer.h.

◆ operator[]() [2/2]

template<typename T >
const T & CircularBuffer< T >::operator[] ( size_t index) const
inline

Definition at line 115 of file circular_buffer.h.

◆ pop_back()

template<typename T >
bool CircularBuffer< T >::pop_back ( T * dst = nullptr)
inline

Definition at line 60 of file circular_buffer.h.

◆ pop_front()

template<typename T >
bool CircularBuffer< T >::pop_front ( T * dst = nullptr)
inline

Definition at line 42 of file circular_buffer.h.

◆ push_back()

template<typename T >
bool CircularBuffer< T >::push_back ( const T & value)
inline

Definition at line 26 of file circular_buffer.h.

◆ push_front()

template<typename T >
bool CircularBuffer< T >::push_front ( const T & value)
inline

Definition at line 77 of file circular_buffer.h.

◆ size()

template<typename T >
size_t CircularBuffer< T >::size ( ) const
inline

Definition at line 120 of file circular_buffer.h.

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