function lfds700_hash_a_iterate

From liblfds.org
Revision as of 01:49, 30 December 2015 by Admin (talk | contribs) (→‎Example)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Source Files

└───liblfds700
    ├───inc
    │   └───liblfds700
    │           lfds700_hash_addonly.h
    └───src
        └───llfds700_hash_addonly
                lfds700_hash_addonly_iterate.c

Opaque Structures

struct lfds700_hash_a_element;
struct lfds700_hash_a_iterate;

Prototype

int lfds700_hash_a_iterate( struct lfds700_hash_a_iterate *hai, struct lfds700_hash_a_element **hae );

Parameters

struct lfds700_hash_a_iterate *hai

A pointer to an initialized struct lfds700_hash_a_iterate.

struct lfds700_hash_a_element **hae

Set to point to the next element in the iteration.

Return Value

Returns 1 on a successful iteration. Returns 0 when iteration is complete.

Notes

This function iterates over the hash elements. The underlying data structure is an array of btrees, and the function iterates over each btree, performing a smallest-to-largest walk on each btree. As such the iteration is overall unordered, but proceeds in ordered blocks. Any elements which are added to the hash during iteration may or may not be seen - it depends on whether or not they turn up 'in front' of the current position of the iterator.

Example

Coming soon. No, really! (Written 29th Dec 2015).

See Also