CircularBuffer< T > Class Template Reference

#include <data_structures.hpp>

Public Member Functions
	CircularBuffer (size_t capacity)
size_t	capacity () const
bool	empty () const
bool	full () const
T	pop ()
void	push (const T &item)
size_t	size () const
std::vector< T >	to_vector () const

Private Attributes
std::vector< T >	buffer_
size_t	capacity_
size_t	head_ = 0
size_t	size_ = 0
size_t	tail_ = 0

Detailed Description

template<typename T>
class CircularBuffer< T >

Definition at line 11 of file data_structures.hpp.

Constructor & Destructor Documentation

CircularBuffer()

template<typename T >

CircularBuffer< T >::CircularBuffer ( size_t  capacity )

inlineexplicit

Definition at line 20 of file data_structures.hpp.

                                             : buffer_(capacity), capacity_(capacity) {
        if (capacity == 0)
            throw std::invalid_argument("Capacity must be positive");
    }

References CircularBuffer< T >::capacity().

Member Function Documentation

capacity()

template<typename T >

size_t CircularBuffer< T >::capacity ( ) const

inline

Definition at line 53 of file data_structures.hpp.

                            {
        return capacity_;
    }

References CircularBuffer< T >::capacity_.

Referenced by CircularBuffer< T >::CircularBuffer().

empty()

template<typename T >

bool CircularBuffer< T >::empty ( ) const

inline

Definition at line 44 of file data_structures.hpp.

                       {
        return size_ == 0;
    }

References CircularBuffer< T >::size_.

Referenced by CircularBuffer< T >::pop(), and TEST().

full()

template<typename T >

bool CircularBuffer< T >::full ( ) const

inline

Definition at line 47 of file data_structures.hpp.

                      {
        return size_ == capacity_;
    }

References CircularBuffer< T >::capacity_, and CircularBuffer< T >::size_.

Referenced by TEST().

pop()

template<typename T >

T CircularBuffer< T >::pop ( )

inline

Definition at line 35 of file data_structures.hpp.

            {
        if (empty())
            throw std::runtime_error("Buffer is empty");
        T item = buffer_[head_];
        head_ = (head_ + 1) % capacity_;
        --size_;
        return item;
    }

References CircularBuffer< T >::buffer_, CircularBuffer< T >::capacity_, CircularBuffer< T >::empty(), CircularBuffer< T >::head_, and CircularBuffer< T >::size_.

push()

template<typename T >

void CircularBuffer< T >::push ( const T &  item )

inline

Definition at line 25 of file data_structures.hpp.

                             {
        buffer_[tail_] = item;
        tail_ = (tail_ + 1) % capacity_;
        if (size_ < capacity_) {
            ++size_;
        } else {
            head_ = (head_ + 1) % capacity_;
        }
    }

References CircularBuffer< T >::buffer_, CircularBuffer< T >::capacity_, CircularBuffer< T >::head_, CircularBuffer< T >::size_, and CircularBuffer< T >::tail_.

Referenced by TEST().

size()

template<typename T >

size_t CircularBuffer< T >::size ( ) const

inline

Definition at line 50 of file data_structures.hpp.

                        {
        return size_;
    }

References CircularBuffer< T >::size_.

Referenced by TEST().

to_vector()

template<typename T >

std::vector< T > CircularBuffer< T >::to_vector ( ) const

inline

Definition at line 57 of file data_structures.hpp.

                                   {
        std::vector<T> result;
        result.reserve(size_);
        size_t current = head_;
        for (size_t i = 0; i < size_; ++i) {
            result.push_back(buffer_[current]);
            current = (current + 1) % capacity_;
        }
        return result;
    }

References CircularBuffer< T >::buffer_, CircularBuffer< T >::capacity_, CircularBuffer< T >::head_, and CircularBuffer< T >::size_.

Referenced by TEST().

Member Data Documentation

buffer_

template<typename T >

std::vector<T> CircularBuffer< T >::buffer_

private

Definition at line 13 of file data_structures.hpp.

Referenced by CircularBuffer< T >::pop(), CircularBuffer< T >::push(), and CircularBuffer< T >::to_vector().

capacity_

template<typename T >

size_t CircularBuffer< T >::capacity_

private

Definition at line 17 of file data_structures.hpp.

Referenced by CircularBuffer< T >::capacity(), CircularBuffer< T >::full(), CircularBuffer< T >::pop(), CircularBuffer< T >::push(), and CircularBuffer< T >::to_vector().

head_

template<typename T >

size_t CircularBuffer< T >::head_ = 0

private

Definition at line 14 of file data_structures.hpp.

Referenced by CircularBuffer< T >::pop(), CircularBuffer< T >::push(), and CircularBuffer< T >::to_vector().

size_

template<typename T >

size_t CircularBuffer< T >::size_ = 0

private

Definition at line 16 of file data_structures.hpp.

Referenced by CircularBuffer< T >::empty(), CircularBuffer< T >::full(), CircularBuffer< T >::pop(), CircularBuffer< T >::push(), CircularBuffer< T >::size(), and CircularBuffer< T >::to_vector().

tail_

template<typename T >

size_t CircularBuffer< T >::tail_ = 0

private

Definition at line 15 of file data_structures.hpp.

Referenced by CircularBuffer< T >::push().

---

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

• data_structures.hpp