#include <Base/include/Framework/Collection/Queue.hpp>
template<typename T>
bpf::collection::Queue class

Contents

Constructors, destructors, conversion operators

Queue(fsize maxsize = 0) explicit
Queue(const std::initializer_list<T>& lst)
Queue(const Queue<T>& other)
Queue(Queue<T>&& other) noexcept

Public functions

auto operator=(const Queue<T>& other) -> Queue<T>&
auto operator=(Queue<T>&& other) -> Queue<T>& noexcept
void Clear()
void Push(const T& element)
void Push(T&& element)
auto Pop() -> T
auto Top() -> T&
auto Top() const -> const T&
auto Size() const -> fsize

Function documentation

template<typename T>
bpf::collection::Queue<T>::Queue(fsize maxsize = 0) explicit

Parameters
maxsize maximum size of queue (0 = infinity/unlimited)

Constructs an empty Queue

template<typename T>
bpf::collection::Queue<T>::Queue(const std::initializer_list<T>& lst)

Parameters
lst the initial list of items to push to this new queue

Constructs a Queue from an existing initializer list

template<typename T>
bpf::collection::Queue<T>::Queue(const Queue<T>& other)

Copy constructor

template<typename T>
bpf::collection::Queue<T>::Queue(Queue<T>&& other) noexcept

Move constructor

template<typename T>
Queue<T>& bpf::collection::Queue<T>::operator=(const Queue<T>& other)

Copy assignment operator

template<typename T>
Queue<T>& bpf::collection::Queue<T>::operator=(Queue<T>&& other) noexcept

Move assignment operator

template<typename T>
void bpf::collection::Queue<T>::Clear()

Clears this queue

template<typename T>
void bpf::collection::Queue<T>::Push(const T& element)

Parameters
element the element to push

Pushes an element on the queue

template<typename T>
void bpf::collection::Queue<T>::Push(T&& element)

Parameters
element the element to push

Pushes an element on the queue

template<typename T>
T bpf::collection::Queue<T>::Pop()

Returns the extracted/removed item
Exceptions
IndexException if the queue is empty

Extracts the top of the queue

template<typename T>
T& bpf::collection::Queue<T>::Top()

Returns mutable item
Exceptions
IndexException if the queue is empty

Returns the top of the queue

template<typename T>
const T& bpf::collection::Queue<T>::Top() const

Returns immutable item
Exceptions
IndexException if the queue is empty

Returns the top of the queue

template<typename T>
fsize bpf::collection::Queue<T>::Size() const

Returns number of items as unsigned

Returns the number of items in this queue