Integer Hashtable

Overview

The IntHashTable class holds a collection of integers which are identified by integer key values. The IntHashTable object may expand to contain an increasing number of integers. It also supports “iterator” functions, which are used to successively visit each integer stored in the hashtable.

Definition
- define() - Define suggested number of stored items
- inquire() - Get current storage capacity
Set and query elements
- count() - Get number of contained integers
- maxKey() - Get maximum key value
- allKeys() - Get all key values
- emptyKey() - Find the first key with no value
- insert() - Place integer at specified location
- insertIfAbsent() - Place an integer in the hashtable if the key is not already defined
- lookup() - Find integer at specified location
- clear() - Remove all integers
- initializeIterator() - Prepare to successively visit each integer
- initializeOrderedIterator() - Monotonically increasing integer key
- nextItem() - Return the next integer in the sequence
General functions
- getErrorCode() - Return the current error code
- setName() - Set name
- getName() - Get name
- print() - Print content

Once a IntHashTable is instanced, an approximate number of integers to be stored may be defined using define(). As integers are inserted IntHashTable class will expand its internal storage as required. The method inquire() returns the number of integers which may be managed by the presently allocated storage.

Each new integer is placed in the hashtable using insert(). The total number of integers contained in the hashtable may be found by calling count(). An integer with a specified integer key may be retrieved using lookup(). The method clear() removes all integers from the hashtable. The maximum key used to store any integer may be queried using maxKey(). All keys may be queried using allKeys(). In this case the number of keys returned will be equal to the number of keys returned by count().

Each integer in the hashtable may be processed with an “iterator” construct. The pair of methods initializeIterator() and nextItem() are used to visit each key/integer pair using a loop. Call the first method before the body of the loop to prepare the IntHashTable object for the iteration. Within the loop body, call nextItem(). It will return an integer key and an integer value each time it is called. It will return a zero value when all the integers have been processed. Use initializeOrderedIterator() to visit the integers in monotonically increasing key value.

Class Members Descriptions

The currently available IntHashTable enumerations and functions are described in detail in this section.

class IntHashTable

Integer Hashtable.

Public Types

enum class IntegerParameter

Integer parameter types.

Values:

enumerator UNDEFINED: Undefined value.

Public Functions

HOOPS_CAE_EXTERN ErrorCode getErrorCode ()

Return the current ErrorCode of the IntHashTable object.

Returns:	`ErrorCode` - The current error code, or `NONE` if no error.

HOOPS_CAE_EXTERN Status define (int capacity)

Suggest a number of elements to be stored in the IntHashTable. This is used to allocate the initial array of storage which is used to hold each integer/integer pair. If the number of inserted elements is eventually greater than this initial estimate, storage space will be dynamically expanded to hold the extra integers. This function removes any previously entered integers.

Parameters:	capacity – Estimated number of integers to be held
Returns:	Status

Parameters:	capacity – [out] Number of integers that may be managed
Returns:	Status

Parameters:	parameter – `IntegerParameter` value – Value to set
Returns:	Status

Parameters:	itemCount – [out] Number of integers held in the IntHashTable object
Returns:	Status

Integer Hashtable

Overview

Class Members Descriptions

Hello! I'm HOOPSY