A fixed size heap backed by an array. The container inherits the properties of a fixed size array of type T. The container keeps all N elements alive until its lifetime ends, even if elements are popped/removed from the stack. It is guaranteed that no dynamic memory allocation takes place. More...

#include <TArrayHeap.h>

Public Member Functions
	TArrayHeap ()

	TArrayHeap (IsLess isLess)

template<typename U >
void	push (U &&item)
	Adds an item to the heap. The item originally at the target index will be overwritten.

void	pop ()
	Removes the top item from the heap. The item originally at the target index is still alive after this call.

std::size_t	size () const

void	clear ()

bool	isEmpty () const


T &	top ()
	Access the top item of the heap. By default, the top item is the maximum item (max heap). If the comparator is reversed, e.g., comparing using `operator >`, then the top item is the minimum item (min heap).

const T &	top () const

Detailed Description

template<typename T, std::size_t N, typename IsLess = std::less<T>>
class ph::TArrayHeap< T, N, IsLess >

A fixed size heap backed by an array. The container inherits the properties of a fixed size array of type T. The container keeps all N elements alive until its lifetime ends, even if elements are popped/removed from the stack. It is guaranteed that no dynamic memory allocation takes place.

Template Parameters

T	Type of the array element.
N	Maximum size of the backing array.
IsLess	Comparator for the array element. The default comparator makes this heap a max heap.

Constructor & Destructor Documentation

◆ TArrayHeap() [1/2]

template<typename T , std::size_t N, typename IsLess >
requires std::default_initializable<IsLess>

ph::TArrayHeap< T, N, IsLess >::TArrayHeap ( )

inline

Creates empty heap.