Skip to content

Hashtables

Hashtables package is an implementation of hashtables in Gothic. Currently (version 2.8.0) only integers are supported as keys. The Hashtables grow automatically.

Dependencies

Initialization

Initialize with LeGo_PermMem flag. 

1
LeGo_Init(LeGo_PermMem);

Implementation

Hashtable.d on GitHub

Functions

HT_CreateSized

Generates a hashtable of the specified size. 

1
func int HT_CreateSized(var int size)
Parameters
  • var int size
    Size of the hashtable to be created

Return value

The function returns a handle to the created hashtable.

HT_Create

Generates a standard size hashtable. 

1
func int HT_Create()
Return value

The function returns a handle to the created hashtable.

HT_Insert

Inserts a value into the Hashtable. 

1
func void HT_Insert(var int handle, var int val, var int key)
Parameters
  • var int handle
    Handle of a hashtable
  • var int val
    The value to be inserted
  • var int key
    The key associated with the value

HT_Resize

Changes the size of the hashtable (usually not necessary as it happens automatically). 

1
func void HT_Resize(var int handle, var int size)
Parameters
  • var int handle
    Handle of a hashtable
  • var int size
    The new size of the hashtable

HT_Get

Reads a value from the hashtable. 

1
func int HT_Get(var int handle, var int key)
Parameters
  • var int handle
    Handle of a hashtable
  • var int key
    The key whose value is to be read

Return value

The function returns the value associated with the key.

HT_Has

Checks if the key already exist in hashtable. 

1
func int HT_Has(var int handle, var int key)
Parameters
  • var int handle
    Handle of a hashtable
  • var int key
    The key to be checked Return value

The function returns TRUE if the key exist, FALSE is returned otherwise.

HT_Remove

Removes a key from the hashtable. 

1
func void HT_Remove(var int handle, var int key)
Parameters
  • var int handle
    Handle of a hashtable
  • var int key
    The key to be removed

HT_Change

Changes the value of a key already existing in the hashtable. 

1
func void HT_Change(var int handle, var int val, var int key)
Parameters
  • var int handle
    Handle of a hashtable
  • var int val
    The new value
  • var int key
    The key whose value is to be changed

HT_InsertOrChange

Inserts a value into the Hashtable, or changes the value if the key already exist into hashtable. 

1
func void HT_InsertOrChange(var int handle, var int val, var int key)
Parameters
  • var int handle
    Handle of a hashtable
  • var int val
    The new value
  • var int key
    The key whose value is to be changed or associated with the value.

HT_GetNumber

Returns the number of entries in a hashtable. 

1
func int HT_GetNumber(var int handle)
Parameters
  • var int handle
    Handle of a hashtable

Return value

The function returns the number of entries in the hashtable.

HT_ForEach

Performs a function for each value pair in the hashtable. 

1
func void HT_ForEach(var int handle, var func fnc)
Parameters
  • var int handle
    Handle of a hashtable
  • var func fnc
    A function with signature void (int key, int val)

HT_Destroy

Deletes the hashtable. 

1
func void HT_Destroy(var int handle)
Parameters
  • var int handle
    The handle of the hashtable to be deleted

Examples

Simple operations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
func void PrintKeyValuePair(var int key, var int val)
{
    Print(ConcatStrings(ConcatStrings("Key: ", IntToString(key)), ConcatStrings(", Value: ", IntToString(val))));
};

func void example()
{
    // Create a new hashtable
    var int hashtableHandle; hashtableHandle = HT_Create();

    // Insert values into the hashtable
    HT_Insert(hashtableHandle, 42, 1);
    HT_Insert(hashtableHandle, 23, 2);
    HT_Insert(hashtableHandle, 56, 3);

    // Get a value from the hashtable
    var int value; value = HT_Get(hashtableHandle, 2);
    Print(ConcatStrings("Value associated with key 2: ", IntToString(value)));

    // Check if a key exists in the hashtable
    if (HT_Has(hashtableHandle, 3))
    {
        Print("Key 3 exists in the hashtable.");
    }
    else
    {
        Print("Key 3 does not exist in the hashtable.");
    };

    // Remove a key from the hashtable
    HT_Remove(hashtableHandle, 1);

    // Change the value associated with a key
    HT_Change(hashtableHandle, 99, 3);

    // Insert a value or change it if the key exists
    HT_InsertOrChange(hashtableHandle, 123, 4);

    // Get the number of entries in the hashtable
    var int numEntries; numEntries = HT_GetNumber(hashtableHandle);
    Print(ConcatStrings("Number of entries in the hashtable: ", IntToString(numEntries)));


    // Iterate through the hashtable and print key-value pairs
    // Function from top of the example is used here
    HT_ForEach(hashtableHandle, PrintKeyValuePair);

    // Destroy the hashtable
    HT_Destroy(hashtableHandle);
};