Mission Base

Program Base Library Functions

PblIterator* pblSetReverseIterator

( PblSet* set )

Returns a reverse iterator over the elements in this set.

Documentation

Returns a reverse iterator over the elements in this set.

The reverse iterator starts the iteration at the end of the set.

Note: The memory allocated by this method for the iterator returned needs to be released by calling pblIteratorFree() once the iterator is no longer needed.

The iterators returned by the this method are fail-fast: if the set is structurally modified at any time after the iterator is created, in any way except through the Iterator's own remove or add methods, the iterator will return a PBL_ERROR_CONCURRENT_MODIFICATION error.

Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

This method has a time complexity of O(1).

Parameters:
set - The set to create the iterator for
Returns:
void * retptr != NULL: The iterator.
void * retptr == NULL: An error, see pbl_errno:
PBL_ERROR_OUT_OF_MEMORY - Out of memory.
PBL_ERROR_PARAM_SET - The set cannot be iterated.

Alphabetic index



This page was generated with the help of DOC++.