Skip to content

Class CircularBuffer

template <typename T>

ClassList > CircularBuffer

Public Types

Type Name
typedef BufferIterator< true > const_iterator
typedef BufferIterator< false > iterator
typedef T value_type

Public Functions

Type Name
CircularBuffer (size_t size)
CircularBuffer (const CircularBuffer & other)
CircularBuffer (CircularBuffer && other) noexcept
const_reference at (size_type index) const
reference at (size_type index)
reference back ()
const_reference back () const
iterator begin ()
const_iterator begin () const
size_type buffer_size () const
size_type capacity () const
const_iterator cbegin () noexcept const
const_iterator cend () noexcept const
void clear ()
const_pointer data () const
bool empty () const
iterator end ()
const_iterator end () const
reference front ()
const_reference front () const
bool full () const
CircularBuffer & operator= (const CircularBuffer & other)
CircularBuffer & operator= (CircularBuffer && other) noexcept
const_reference operator[] (size_type index) const
reference operator[] (size_type index)
void pop_front ()
void push_back (const value_type & data)
void push_back (value_type && data) noexcept
iterator rbegin () noexcept
const_iterator rbegin () noexcept const
iterator rend () noexcept
const_iterator rend () noexcept const
size_type size () const

Public Types Documentation

typedef const_iterator

typedef BufferIterator<true> CircularBuffer< T >::const_iterator;

typedef iterator

typedef BufferIterator<false> CircularBuffer< T >::iterator;

typedef value_type

typedef T CircularBuffer< T >::value_type;

Public Functions Documentation

function CircularBuffer [⅓]

inline explicit CircularBuffer::CircularBuffer (
    size_t size
)

function CircularBuffer [⅔]

inline CircularBuffer::CircularBuffer (
    const CircularBuffer & other
)

function CircularBuffer [3/3]

inline CircularBuffer::CircularBuffer (
    CircularBuffer && other
) noexcept

function at [½]

inline const_reference CircularBuffer::at (
    size_type index
) const

function at [2/2]

inline reference CircularBuffer::at (
    size_type index
)

function back [½]

inline reference CircularBuffer::back ()

function back [2/2]

inline const_reference CircularBuffer::back () const

function begin [½]

inline iterator CircularBuffer::begin ()

function begin [2/2]

inline const_iterator CircularBuffer::begin () const

function buffer_size

inline size_type CircularBuffer::buffer_size () const

function capacity

inline size_type CircularBuffer::capacity () const

function cbegin

inline const_iterator CircularBuffer::cbegin () noexcept const

function cend

inline const_iterator CircularBuffer::cend () noexcept const

function clear

inline void CircularBuffer::clear ()

function data

inline const_pointer CircularBuffer::data () const

function empty

inline bool CircularBuffer::empty () const

function end [½]

inline iterator CircularBuffer::end ()

function end [2/2]

inline const_iterator CircularBuffer::end () const

function front [½]

inline reference CircularBuffer::front ()

function front [2/2]

inline const_reference CircularBuffer::front () const

function full

inline bool CircularBuffer::full () const

function operator=

inline CircularBuffer & CircularBuffer::operator= (
    const CircularBuffer & other
)

function operator=

inline CircularBuffer & CircularBuffer::operator= (
    CircularBuffer && other
) noexcept

function operator[]

inline const_reference CircularBuffer::operator[] (
    size_type index
) const

function operator[]

inline reference CircularBuffer::operator[] (
    size_type index
)

function pop_front

inline void CircularBuffer::pop_front ()

function push_back [½]

inline void CircularBuffer::push_back (
    const value_type & data
)

function push_back [2/2]

inline void CircularBuffer::push_back (
    value_type && data
) noexcept

function rbegin [½]

inline iterator CircularBuffer::rbegin () noexcept

function rbegin [2/2]

inline const_iterator CircularBuffer::rbegin () noexcept const

function rend [½]

inline iterator CircularBuffer::rend () noexcept

function rend [2/2]

inline const_iterator CircularBuffer::rend () noexcept const

function size

inline size_type CircularBuffer::size () const

The documentation for this class was generated from the following file src/utils/CircularBuffer.h