void* pblSetRemove

( PblSet* set )

Retrieves and removes the head (first element) of this set.

Documentation

Retrieves and removes the head (first element) of this set.

For tree sets this method has a time complexity of O(Log N), with N being the size of the set.

For hash sets this method has a time complexity of O(N), with N being the capacity of 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