https://github.com/Shambles-Dev/AutoHotkey-HashTable

A Hash Table Implementation for AutoHotkey
https://github.com/Shambles-Dev/AutoHotkey-HashTable

ahk autohotkey hash-tables

Last synced: 2 months ago
JSON representation

A Hash Table Implementation for AutoHotkey

• Host: GitHub
• URL: https://github.com/Shambles-Dev/AutoHotkey-HashTable
• Owner: Shambles-Dev
• License: lgpl-3.0
• Created: 2016-03-11T06:03:53.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2021-11-26T15:24:39.000Z (over 2 years ago)
• Last Synced: 2024-01-27T09:09:18.709Z (5 months ago)
• Topics: ahk, autohotkey, hash-tables
• Language: AutoHotkey
• Size: 5.86 KB
• Stars: 10
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• awesome-AutoHotkey - HashTable - by Shambles - A Hash Table Implementation for AutoHotkey. (Libraries / <a name="libraries-data-structs-algorithms"></a>Data Structures and Algorithms)

README

        
HashTable

=========

HashTable is an improvement on storing items in AutoHotkey Objects.

With HashTable you can

* store any string key without losing access to HashTable’s methods

* prevent string keys from being case-folded

* prevent floating-point keys from being indexed by their current string representation instead of their value

:warning: Hash tables are inherently unordered.  When enumerating a hash table, do not expect to process keys in sorted order or insertion order.  If you need to process keys in a certain order, store them in that order in an Array and enumerate that while operating on the HashTable or use something other than a hash table (like an [AVL tree](https://en.wikipedia.org/wiki/AVL_tree)).

:warning: Mutating a hash table while enumerating it might cause items to be processed more than once or skipped.  You can get the desired effect by enumerating a clone of the HashTable while mutating the HashTable you intend to keep.

:warning: Floating-point keys are rarely useful because it is rarely safe to compare the result of a floating-point calculation exactly.  Deduplicating floating-point results and converting mathematical constants to their names are examples of valid uses.

:warning: Object keys are rarely useful because they are indexed by their address.  Two objects might behave identically in every way, but if they are not the *same* object (stored in the same location in memory), they will not be associated with the same value.  Recording visited nodes in a graph traversal algorithm is an example of a valid use.

[Design](docs/Design.md) contains the reasons for the design decisions.

HashTable is compatible with AutoHotkey v1.

## Installation

HashTable.ahk must be placed in a [library directory](https://www.autohotkey.com/docs/Functions.htm#lib).

## Usage

HashTable’s constructor accepts items as Arrays containing a key and a value, in that order.

HashTable supports the following methods:

```AutoHotkey

Get(Key)

Set(Key, Value)

```

`Get(Key)` reads the value associated with a key.

`Set(Key, Value)` writes the value associated with a key.

HashTable also supports the following interfaces from [Object](https://www.autohotkey.com/docs/objects/Object.htm):

```AutoHotkey

Delete(Key)

Count()

_NewEnum()

HasKey(Key)

Clone()

```

HashTable will throw an exception when attempting to get or delete a nonexistent key.