#include <hxhandle_table.hpp>

Public Types
using	value_t = T

Public Member Functions
	hxhandle_table (deleter_t_ deleter_=deleter_t_())
	~hxhandle_table (void)
template<typename self_t_, typename callable_t_>
auto	and_then (this self_t_ &&self_, hxhandle_t handle_, callable_t_ &&callable_) -> hxremove_cvref_t< decltype(hxforward< callable_t_ >(callable_)(hxforward_like< self_t_ >(hxdeclval< T & >())))>
hxsize_t	capacity (void) const
template<typename deleter_u_>
void	clear (deleter_u_ &&deleter_) noexcept
void	clear (void) noexcept
const deleter_t_ &	deleter (void) const
deleter_t_ &	deleter (void)
bool	empty (void) const
template<typename callable_t_>
hxsize_t	erase_if (callable_t_ &&callable_) noexcept
hxptr< T, deleter_t_ >	extract (hxhandle_t handle_) noexcept
bool	full (void) const
hxhandle_t	insert (T *ptr_) noexcept
template<typename deleter_u_>
hxhandle_t	insert (hxptr< T, deleter_u_ > &&ptr_) noexcept
hxsize_t	max_size (void) const
template<typename self_t_, typename callable_t_>
auto	or_else (this self_t_ &&self_, hxhandle_t handle_, callable_t_ &&callable_) -> decltype(self_.value(handle_))
void	release_all (void) noexcept
template<typename deleter_u_>
bool	reset (hxhandle_t handle_, deleter_u_ &&deleter_) noexcept
bool	reset (hxhandle_t handle_) noexcept
void	set_size_bits (uint32_t bits_)
hxsize_t	size (void) const
const T *	value (hxhandle_t handle_) const noexcept
T *	value (hxhandle_t handle_) noexcept
template<typename self_t_, typename... args_t_>
T	value_or (this self_t_ &&self_, hxhandle_t handle_, args_t_ &&... args_)

Detailed Description

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>
class hxhandle_table< T, deleter_t_, table_size_bits_ >

hxhandle_table - A table that maps 64-bit handles to owned pointers without reallocating memory or moving values.

The table is a fixed 2^table_size_bits - 1 array of handles. Use set_size_bits to configure the size dynamically.

T : The pointed-to type stored in the table.
deleter_t : A class type invoked as deleter(T*) to free the owned pointer. See also hxdo_not_delete.
table_size_bits : If non-zero, fixes the table to 2^table_size_bits-1 slots. Otherwise the size is dynamic.

Member Typedef Documentation

◆ value_t

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

using hxhandle_table< T, deleter_t_, table_size_bits_ >::value_t = T

Constructor & Destructor Documentation

◆ hxhandle_table()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

hxhandle_table< T, deleter_t_, table_size_bits_ >::hxhandle_table ( deleter_t_ deleter_ = deleter_t_() )

explicit

Constructs an empty table with a capacity of 2^table_size_bits - 1 slots and an optional deleter instance.

deleter : Callable with signature bool deleter(T*).

◆ ~hxhandle_table()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

hxhandle_table< T, deleter_t_, table_size_bits_ >::~hxhandle_table ( void )

Destructs the table and deletes all owned values.

Member Function Documentation

◆ and_then()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

template<typename self_t_, typename callable_t_>

auto hxhandle_table< T, deleter_t_, table_size_bits_ >::and_then	(	this self_t_ &&	self_,
		hxhandle_t	handle_,
		callable_t_ &&	callable_ )->hxremove_cvref_t< decltype(hxforward< callable_t_ >(callable_)(hxforward_like< self_t_ >(hxdeclval< T & >())))>

Returns the result of calling callable with the value referenced by handle, otherwise returns hxnil.

Use and_then to return hxptr, hxref or hxexpected.

handle : The handle identifying the value to look up.
callable : The function to call with the value.

◆ capacity()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

hxsize_t hxhandle_table< T, deleter_t_, table_size_bits_ >::capacity ( void ) const

inline

Returns the number of slots in the table.

◆ clear() [1/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

template<typename deleter_u_>

void hxhandle_table< T, deleter_t_, table_size_bits_ >::clear ( deleter_u_ && deleter_ )

noexcept

Removes all values and if deleter is true then calls deleter() on every value.

deleter : Callable with signature bool deleter(T*).

◆ clear() [2/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

void hxhandle_table< T, deleter_t_, table_size_bits_ >::clear ( void )

inlinenoexcept

Removes all values and calls the stored deleter on every value.

◆ deleter() [1/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

deleter_t_ & hxhandle_table< T, deleter_t_, table_size_bits_ >::deleter ( void )

◆ deleter() [2/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

const deleter_t_ & hxhandle_table< T, deleter_t_, table_size_bits_ >::deleter ( void ) const

Returns a const reference to the stored deleter.

◆ empty()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

bool hxhandle_table< T, deleter_t_, table_size_bits_ >::empty ( void ) const

inline

Checks if the table is empty.

◆ erase_if()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

template<typename callable_t_>

hxsize_t hxhandle_table< T, deleter_t_, table_size_bits_ >::erase_if ( callable_t_ && callable_ )

noexcept

Returns the number of values destroyed.

Calls callable with a T& for every value and calls the stored deleter on those for which it returns true.

callable : Returns true for values to erase.

◆ extract()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

hxptr< T, deleter_t_ > hxhandle_table< T, deleter_t_, table_size_bits_ >::extract ( hxhandle_t handle_ )

noexcept

Returns an hxptr owning the value referenced by handle, or an empty hxptr if handle does not resolve.

The slot is freed.

handle : The handle identifying the value to extract.

◆ full()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

bool hxhandle_table< T, deleter_t_, table_size_bits_ >::full ( void ) const

inline

Checks if the table is full.

◆ insert() [1/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

template<typename deleter_u_>

hxhandle_t hxhandle_table< T, deleter_t_, table_size_bits_ >::insert ( hxptr< T, deleter_u_ > && ptr_ )

noexcept

Takes ownership of the value owned by ptr and returns a non-zero handle referencing it, or hxnull_handle if ptr is empty.

The table must not be full.

ptr : The hxptr owning the value to insert.

◆ insert() [2/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

hxhandle_t hxhandle_table< T, deleter_t_, table_size_bits_ >::insert ( T * ptr_ )

noexcept

Takes ownership of ptr and returns a non-zero handle referencing it, or hxnull_handle if ptr is null.

The table must not be full.

ptr : The value to insert.

◆ max_size()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

hxsize_t hxhandle_table< T, deleter_t_, table_size_bits_ >::max_size ( void ) const

inline

Returns the maximum number of values that can be stored.

◆ or_else()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

template<typename self_t_, typename callable_t_>

auto hxhandle_table< T, deleter_t_, table_size_bits_ >::or_else	(	this self_t_ &&	self_,
		hxhandle_t	handle_,
		callable_t_ &&	callable_ )->decltype(self_.value(handle_))

Returns a pointer to the value referenced by handle, or the result of calling callable when the handle does not resolve.

handle : The handle identifying the value to look up.
callable : The function to call when lookup fails. Must return a T pointer.

◆ release_all()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

void hxhandle_table< T, deleter_t_, table_size_bits_ >::release_all ( void )

inlinenoexcept

Clears the table without deleting any values.

◆ reset() [1/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

bool hxhandle_table< T, deleter_t_, table_size_bits_ >::reset ( hxhandle_t handle_ )

inlinenoexcept

Removes and calls the stored deleter on the value referenced by handle.

handle : The handle identifying the value to remove.

◆ reset() [2/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

template<typename deleter_u_>

bool hxhandle_table< T, deleter_t_, table_size_bits_ >::reset	(	hxhandle_t	handle_,
		deleter_u_ &&	deleter_ )

noexcept

Releases the value referenced by handle if deleter is true then calls deleter on it.

handle : The handle identifying the value to remove.
deleter : Callable with signature bool deleter(T*).

◆ set_size_bits()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

void hxhandle_table< T, deleter_t_, table_size_bits_ >::set_size_bits ( uint32_t bits_ )

Sets the number of index bits and allocates memory for the table (only for dynamic capacity).

bits : The number of index bits to set for the table, in the range [1, 30].

◆ size()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

hxsize_t hxhandle_table< T, deleter_t_, table_size_bits_ >::size ( void ) const

inline

Returns the number of values in the table.

◆ value() [1/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

const T * hxhandle_table< T, deleter_t_, table_size_bits_ >::value ( hxhandle_t handle_ ) const

noexcept

Returns the value referenced by handle if it resolves, otherwise hxnull.

handle : The handle identifying the value to look up.

◆ value() [2/2]

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

T * hxhandle_table< T, deleter_t_, table_size_bits_ >::value ( hxhandle_t handle_ )

noexcept

◆ value_or()

template<hxhandle_table_concept_ T, typename deleter_t_ = hxdefault_delete, uint32_t table_size_bits_ = hxallocator_dynamic_capacity>

template<typename self_t_, typename... args_t_>

T hxhandle_table< T, deleter_t_, table_size_bits_ >::value_or	(	this self_t_ &&	self_,
		hxhandle_t	handle_,
		args_t_ &&...	args_ )

Returns a copy of the value referenced by handle, or a value constructed from args when the handle does not resolve.

handle : The handle identifying the value to look up.
args : The arguments used to construct the value when lookup fails.

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

include/hx/hxhandle_table.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ value_t

Constructor & Destructor Documentation

◆ hxhandle_table()

◆ ~hxhandle_table()

Member Function Documentation

◆ and_then()

◆ capacity()

◆ clear() [1/2]

◆ clear() [2/2]

◆ deleter() [1/2]

◆ deleter() [2/2]

◆ empty()

◆ erase_if()

◆ extract()

◆ full()

◆ insert() [1/2]

◆ insert() [2/2]

◆ max_size()

◆ or_else()

◆ release_all()

◆ reset() [1/2]

◆ reset() [2/2]

◆ set_size_bits()

◆ size()

◆ value() [1/2]

◆ value() [2/2]

◆ value_or()