void* pblSetRemoveFirst

( PblSet* set )

Removes and returns the first element in this set.

Documentation

Removes and returns the first element in this set.

For hash sets removing an element at the start of the set has a time complexity of O(N), with N being the capacity of the set.

For tree sets removing an element at the start of the set has a time complexity of O(Log N), with N being the number of elements in the set.

Parameters:

set - The set to use

Returns:

void * retptr != NULL: The element that was removed.
void * retptr == NULL: An error, see pbl_errno:
PBL_ERROR_OUT_OF_BOUNDS - This set is empty.

Alphabetic index