hci - Hash Cell Table Iterator

Module Description

The hci module implements an iterator on the hash cell table [hct].

Module Words

Iterator structure

hci% ( - n )
Get the required space for a hci data structure

Iterator creation, initialisation and destruction words

hci-init ( w:hct w:hci - )
Initialise the iterator with a hash table

hci-create ( C: w:hct "name" - R: - w )
Create a named iterator in the dictionary

hci-new ( w:hct - w:hci )
Create an iterator on the heap

hci-free ( w:hci - )
Free iterator from heap

Member words

hci-get ( w:hci - false | w true )
Get the cell data from the current record

hci-key ( w:hci - c-addr u )
Get the key from the current record

hci-set ( w w:hci - )
Set the cell data for the current record

Iterator words

hci-first ( w:hci - w true | false )
Move the iterator to the first record

hci-next ( w:hci - w true | false )
Move the iterator to the next record

hci-move ( w w:hci - f )
Move the iterator to the next record with the cell data

hci-first? ( w:hci - f )
Check if the iterator is on the first record

hci-last? ( w:hci - f )
Check if the iterator is on the last record

Inspection

hci-dump ( w:hci - )
Dump the iterator


generated 09-Jan-2007 by ofcfrth-0.2.0