Skip to content

README.md

Latest commit

聽

History

History
51 lines (35 loc) 路 1.4 KB

README.md

File metadata and controls

51 lines (35 loc) 路 1.4 KB
Raw

emojitable

Fixed-size Hash Map written in native Emojicode.

Compatibility

  • This package was written for and has been tested with Emojicode v0.3 only.
  • This package supports installation on macOS and Linux systems. It has been tested on macOS 10.11.6 and Ubuntu 14.04.

Installation

Note: If you are running this on a VM, keep in mind that Emojicode requires 512MB for heap allocation. You should have at least 1GB of RAM in order to run these tests.

$ # Download and setup Emojicode.
$ sudo make install
$ # Run tests on this package.
$ make test
$ # Run a stress test on this package (don't expect much 馃榿).
$ make stress-test

Example Code

馃懘 First import the emojitable package.
馃摝 emojitable 馃敶

馃懘 Initialize a new emojitable (馃摂) of size 10 that stores String (馃敗) keys.
馃崷 table 馃敺 馃摂馃悮馃敗 馃摝 10

馃懘 Insert the key-value pair: ("Hello", "World"). Returns true (馃憤) on success.
馃崷 success 馃摑 table 馃敜Hello馃敜 馃敜World馃敜

馃懘 Fetch the value that is mapped to by "Hello". Returns an optional (馃崿).
馃崷 value 馃摉 table 馃敜Hello馃敜

馃懘 Delete a key-value pair. Returns the value that was deleted as an optional (馃崿).
馃崷 deleted-value 馃棏 table 馃敜Hello馃敜

馃懘 Get the load factor of the hashmap. Returns a double (馃殌).
馃搱 table

Uninstallation

$ # Remove the emojitable package.
$ make uninstall