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

Contents

Constructors, destructors, conversion operators

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

Public functions

auto operator=(const Stack<T>& other) -> Stack<T>&
auto operator=(Stack<T>&& other) -> Stack<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::Stack<T>::Stack(fsize maxsize = 0) explicit

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

Constructs an empty Stack

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

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

Constructs a Stack from an existing initializer list

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

Copy constructor

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

Move constructor

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

Copy assignment operator

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

Move assignment operator

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

Clears this stack

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

Parameters
element the element to push
Exceptions
StackOverflowException if the stack is full

Pushes an element on the stack

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

Parameters
element the element to push
Exceptions
StackOverflowException if the stack is full

Pushes an element on the stack

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

Returns the extracted/removed item
Exceptions
StackUnderflowException if the stack is empty

Extracts the top of the stack

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

Returns mutable item
Exceptions
IndexException if the stack is empty

Returns the top of the stack

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

Returns immutable item
Exceptions
IndexException if the stack is empty

Returns the top of the stack

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

Returns number of items as unsigned

Returns the number of items in this stack