Added update function for hashmap, treemap and multimap and added update_all for multimap

.travis.yml

@@ -13,8 +13,8 @@ script:
   - sudo ln -s /usr/bin/gcc-6 /usr/local/bin/gcc
   - export CC=gcc-7
   - cd ./tests
-  - make
-  - cd main
-  - make
+  - make --always-make
+  - cd ./main
+  - make --always-make
 after_success:
   - bash <(curl -s https://codecov.io/bash)

CHANGELOG

@@ -1,22 +1,32 @@
 # RELEASE.MAJOR.MINOR
 
+1.6.0
+    Added ./ext/intervalheap.h
+    Added ./ext/multimap.h
+    Added ./ext/multiset.h
+    Added to_string function to most collections
+    Added the cmc prefix to the enum entry_state used by hashtables and to the enum heap_type used by the heap
+    Fixed return type on some functions from ./cmc/hashset.h and ./cmc/treeset.h
+    Fixed hashtables integer overflow when the capacity is divided by the load factor
+    Changed timer.h struct name from timer_t to cmc_timer to prevent name collisions on linux
+
 1.5.3
     Tests completely reorganized and now with full code coverage
     Some fixes where there was a missing return statement
-    Expanded utl/assert.h
+    Expanded ./utl/assert.h
 
 1.5.2
-    Added utl/test.h
-    Added utl/assert.h
-    Added tests/list.c - UnitTest for LIST
-    Small fixes on utl/foreach.h, utl/test.h and redone utl/timer.h
-    Removed utl/log.h functions that were unnecessary
+    Added ./utl/test.h
+    Added ./utl/assert.h
+    Added ./tests/list.c - UnitTest for LIST
+    Small fixes on ./utl/foreach.h, ./utl/test.h and redone ./utl/timer.h
+    Removed ./utl/log.h functions that were unnecessary
     Added the CMC namespace to CONCATC and CONCATH at macro_collections.h
 
 1.5.1
     New queue benchmark
-    Added sac/queue.h
-    Added utl/timer.h
+    Added ./sac/queue.h
+    Added ./utl/timer.h
     Fixing descriptions and other minor fixes
 
 1.5.0

README.md

@@ -3,7 +3,7 @@
 Generate Simple Data Structures of any type in C for you to use in your projects.
 
 ![License](https://img.shields.io/badge/License-MIT-blue.svg)
-![Version](https://img.shields.io/badge/Version-v1.5.3-orange.svg)
+![Version](https://img.shields.io/badge/Version-v1.6.0-orange.svg)
 [![Build](https://travis-ci.org/LeoVen/C-Macro-Collections.svg?branch=master)](https://travis-ci.org/LeoVen/C-Macro-Collections)
 [![codecov](https://codecov.io/gh/LeoVen/C-Macro-Collections/branch/master/graph/badge.svg)](https://codecov.io/gh/LeoVen/C-Macro-Collections)
 
@@ -36,18 +36,15 @@ Only Collections located in __cmc__ are to be documented at *Documentation.md*.
     * TreeMap
     * TreeSet
 * Extra Collections Library
+    * IntervalHeap
     * LinkedQueue
+    * MultiMap
+    * MultiSet
 * Stack Allocated Collections Library
     * Queue
     * Stack
-
-### More to Come
-
-* MultiMap
-* MultiSet
-* TreeHashMap
-* Heap will be an IntervalHeap
-* Stack Allocated Collections
+* Development Collections Library
+    * Deque
 
 Check out **Documentation.md** for more information about each collection.
 
@@ -91,15 +88,7 @@ The following table shows how each collection is implemented and how well they d
 
 ## How to use
 
-To generate the collection, all you need to do is to include the necessary header files. You can include the containers you want to use individually or you can include the master header, `macro_collections.h`, that comes with all collections and other functionalities like the `FOR_EACH` macro.
-
-There are three C standard headers that all collections use:
-
-* `<stdlib.h>`
-* `<stdbool.h>`
-* `<string.h>`
-
-With the last one being used only by array based containers. These headers are already included by default.
+To generate the collection, all you need to do is to include the necessary header files. You can include the containers you want to use individually or you can include the master header, `macro_collections.h`, that comes with the entire C-Macro-Collections library.
 
 ### Macros
 
@@ -151,3 +140,15 @@ When including `foreach.h` in your source code you gain access to all for-each m
 * __BODY__ - Block of code.
 
 Inside body you will have access to the iterator variable. With it you can use functions to access the key, value or index from the iterator. Checkout the documentation for more details.
+
+<hr>
+
+Check out some code reviews that covers some parts the project:
+
+| About | Link |
+|-------|--------|
+| Unit Test *./utl/test.h* | [![Code Review](http://www.zomis.net/codereview/shield/?qid=222954)](http://codereview.stackexchange.com/q/222954/178948) |
+| Interval Heap *./ext/intervalheap.h* | [![Code Review](http://www.zomis.net/codereview/shield/?qid=223595)](http://codereview.stackexchange.com/q/223595/178948) |
+| Hash Set *./cmc/hashset.h* | [![Code Review](http://www.zomis.net/codereview/shield/?qid=217333)](http://codereview.stackexchange.com/q/217333/178948) |
+| Linked List *./cmc/linkedlist.h* | [![Code Review](http://www.zomis.net/codereview/shield/?qid=216737)](http://codereview.stackexchange.com/q/216737/178948) |
+| Others | [![Code Review](http://www.zomis.net/codereview/shield/?qid=213553)](http://codereview.stackexchange.com/q/213553/178948) |

TODO

@@ -1,50 +1,71 @@
 TODO
 
-[ ] Finish Documentation
+[/] - In Progress
+[X] - Finished
+[~] - Needs to be reviewed
+
+[/] Documentation
 [X] Remove PUBLIC and PRIVATE
-[ ] Add multiset
-[ ] Add multimap
-[ ] Upgrade heap to an interval heap
-[ ] Add dispose function
-[ ] Serialization
-[ ] Iterator based functions (like C++ collections)
-[ ] Add Stack Allocated Collections
-[ ] Finish all Dev Collections
-[ ] ToString method to all Collections
-
-
-MAYBE
-
-[ ] Add conditional code generation based on variadic macros
-
-
-PLANNED
-
-Before 2.0
-    Get Documentation fixed and completed
-
-1.6
-    Iterator move and move_to
-    from_array - Creates a collection with all the elements in a specified array
-    to_array - Creates an array with all the elements inside the collection
-    LinkedList - Insert/Remove/Append/Prepend/Extract
-    Resize buffer function
-    Add dispose method to each collection in order to automatically free its data
-    Add copy functions (copy of a collection)
-
-2.0
-    Add new heap collection implementation
-    Add all stack based collections
-
-2.1
-    Add variadic macros (generate only the necessary functions)
-
-2.2
-    Add serialization functions
-
-2.3
-    Iterator functions (functions that operate relative to iterators position) like add or remove ranges
-
-SOMETIME
-
-Add TreeHashMap
+[ ] Extra Collections
+    [X] Add MultiSet
+    [X] Add MultiMap
+    [X] Add IntervalHeap
+    [ ] Add TreeHashMap
+[ ] Add functions
+    [X] update       {hashmap, treemap, multimap}
+    [/] to_string    {all}
+    [ ] iter_advance {all} (iterators)
+    [ ] iter_rewind  {all} (iterators)
+    [ ] iter_go_to   {all} (iterators)
+    [ ] from_array   {all}
+    [ ] to_array     {all}
+    [ ] equals       {all}
+    [ ] resize       {dynamic arrays and circular buffers}
+    [ ] dispose      {all}
+    [ ] copy_of      {all}
+    [ ] save         {all} (serialization)
+    [ ] load         {all} (serialization)
+    [ ] read         {all} (serialization)
+    [ ] write        {all} (serialization)
+    [ ] Range IO
+        [ ] Sequences
+            [ ] seq_push_front
+            [ ] seq_push_at
+            [ ] seq_push_back
+            [ ] seq_remove
+            [ ] seq_extract
+        [ ] Others
+            [ ] seq_insert
+            [ ] seq_remove  (attention on how to treat this)
+            [ ] seq_extract (attention on how to treat this)
+    [ ] Iterator IO
+        [ ] range_insert
+        [ ] range_remove
+[ ] Stack Allocated Collections
+    [ ] Deque
+    [ ] HashMap
+    [ ] HashSet
+    [ ] Heap
+    [ ] LinkedList
+    [ ] List
+    [~] Queue
+    [~] Stack
+    [ ] TreeMap
+    [ ] TreeSet
+[ ] Dev Collections
+    [~] Deque
+    [ ] HashMap
+    [ ] HashSet
+    [ ] Heap
+    [ ] LinkedList
+    [ ] List
+    [ ] Queue
+    [ ] Stack
+    [ ] TreeMap
+    [ ] TreeSet
+[X] Utility
+    [X] assert.h
+    [X] foreach.h
+    [X] log.h
+    [X] test.h
+    [X] timer.h

benchmarks/benchmark.c

@@ -59,23 +59,27 @@ void shuffle(int *array, mt_state_ptr st)
     }
 }
 
-COLLECTION_GENERATE(LIST, l, list, /* FMOD */, /* K */, int)
-COLLECTION_GENERATE(STACK, s, stack, /* FMOD */, /* K */, int)
-COLLECTION_GENERATE(QUEUE, q, queue, /* FMOD */, /* K */, int)
 COLLECTION_GENERATE(DEQUE, d, deque, /* FMOD */, /* K */, int)
-COLLECTION_GENERATE(LINKEDLIST, ll, linked, /* FMOD */, /* K */, int)
-COLLECTION_GENERATE(HEAP, h, heap, /* FMOD */, /* K */, int)
-COLLECTION_GENERATE(TREESET, ts, tset, /* FMOD */, /* K */, int)
-COLLECTION_GENERATE(TREEMAP, tm, tmap, /* FMOD */, int, int)
-COLLECTION_GENERATE(HASHSET, hs, hset, /* FMOD */, /* K */, int)
 COLLECTION_GENERATE(HASHMAP, hm, hmap, /* FMOD */, int, int)
+COLLECTION_GENERATE(HASHSET, hs, hset, /* FMOD */, /* K */, int)
+COLLECTION_GENERATE(HEAP, h, heap, /* FMOD */, /* K */, int)
+COLLECTION_GENERATE(LINKEDLIST, ll, linked, /* FMOD */, /* K */, int)
+COLLECTION_GENERATE(LIST, l, list, /* FMOD */, /* K */, int)
+COLLECTION_GENERATE(QUEUE, q, queue, /* FMOD */, /* K */, int)
+COLLECTION_GENERATE(STACK, s, stack, /* FMOD */, /* K */, int)
+COLLECTION_GENERATE(TREEMAP, tm, tmap, /* FMOD */, int, int)
+COLLECTION_GENERATE(TREESET, ts, tset, /* FMOD */, /* K */, int)
+
+COLLECTION_GENERATE(INTERVALHEAP, ih, iheap, , , int)
+COLLECTION_GENERATE(MULTIMAP, mm, mmap, /* FMOD */, int, int)
+COLLECTION_GENERATE(MULTISET, ms, mset, /* FMOD */, /* K */, int)
 
 #define BENCHMARK(NAME, PFX, sname, initfunc, insertbody, removebody, searchbody)                                \
     void NAME##_io_benchmark(int *array, int *sarray, size_t s)                                                  \
     {                                                                                                            \
         printf("+------------------------------------------------------------ %10s\n", #NAME);                   \
         printf("+------------------------------------------------------------ \n");                              \
-        timer_t timer, total;                                                                                    \
+        cmc_timer timer, total;                                                                                  \
         int r, k, v;                                                                                             \
         size_t j;                                                                                                \
                                                                                                                  \
@@ -172,9 +176,9 @@ COLLECTION_GENERATE(HASHMAP, hm, hmap, /* FMOD */, int, int)
     }
 
 BENCHMARK(DEQUE, d, deque, d_new(NTOTAL), d_push_back(coll, array[i]), d_pop_back(coll), d_contains(coll, sarray[i], intcmp))
-BENCHMARK(HASHMAP, hm, hmap, hm_new(NTOTAL, 0.8, intcmp, inthash), hm_insert(coll, array[i], array[i]), hm_remove(coll, array[i], &r), hm_contains(coll, sarray[i]))
-BENCHMARK(HASHSET, hs, hset, hs_new(NTOTAL, 0.8, intcmp, inthash), hs_insert(coll, array[i]), hs_remove(coll, array[i]), hs_contains(coll, sarray[i]))
-BENCHMARK(HEAP, h, heap, h_new(NTOTAL, MinHeap, intcmp), h_insert(coll, array[i]), h_remove(coll, &r), h_contains(coll, sarray[i]))
+BENCHMARK(HASHMAP, hm, hmap, hm_new(NTOTAL, 0.6, intcmp, inthash), hm_insert(coll, array[i], array[i]), hm_remove(coll, array[i], &r), hm_contains(coll, sarray[i]))
+BENCHMARK(HASHSET, hs, hset, hs_new(NTOTAL, 0.6, intcmp, inthash), hs_insert(coll, array[i]), hs_remove(coll, array[i]), hs_contains(coll, sarray[i]))
+BENCHMARK(HEAP, h, heap, h_new(NTOTAL, cmc_min_heap, intcmp), h_insert(coll, array[i]), h_remove(coll, &r), h_contains(coll, sarray[i]))
 BENCHMARK(LINKEDLIST, ll, linked, ll_new(), ll_push_back(coll, array[i]), ll_pop_back(coll), ll_contains(coll, sarray[i], intcmp))
 BENCHMARK(LIST, l, list, l_new(NTOTAL), l_push_back(coll, array[i]), l_pop_back(coll), l_contains(coll, sarray[i], intcmp))
 BENCHMARK(QUEUE, q, queue, q_new(NTOTAL), q_enqueue(coll, array[i]), q_dequeue(coll), q_contains(coll, sarray[i], intcmp))
@@ -182,6 +186,10 @@ BENCHMARK(STACK, s, stack, s_new(NTOTAL), s_push(coll, array[i]), s_pop(coll), s
 BENCHMARK(TREEMAP, tm, tmap, tm_new(intcmp), tm_insert(coll, array[i], array[i]), tm_remove(coll, array[i], &r), tm_contains(coll, sarray[i]))
 BENCHMARK(TREESET, ts, tset, ts_new(intcmp), ts_insert(coll, array[i]), ts_remove(coll, array[i]), ts_contains(coll, sarray[i]))
 
+BENCHMARK(INTERVALHEAP, ih, iheap, ih_new(NTOTAL, intcmp), ih_insert(coll, array[i]), ih_remove_max(coll, &r), ih_contains(coll, sarray[i]))
+BENCHMARK(MULTIMAP, mm, mmap, mm_new(NTOTAL, 0.8, intcmp, inthash), mm_insert(coll, array[i], array[i]), mm_remove(coll, array[i], &r), mm_contains(coll, sarray[i]))
+BENCHMARK(MULTISET, ms, mset, ms_new(NTOTAL, 0.6, intcmp, inthash), ms_insert(coll, array[i]), ms_remove(coll, array[i]), ms_contains(coll, sarray[i]))
+
 int main(void)
 {
     // Using the Mersenne Twister to generate random numbers. This seed
@@ -224,6 +232,10 @@ int main(void)
     TREEMAP_io_benchmark(array, sarray, NTOTAL);
     TREESET_io_benchmark(array, sarray, NTOTAL);
 
+    INTERVALHEAP_io_benchmark(array, array, NMIN);
+    MULTIMAP_io_benchmark(array, array, NTOTAL);
+    MULTISET_io_benchmark(array, array, NTOTAL);
+
     free(array);
     free(sarray);
 

benchmarks/util/twister.c

@@ -7,7 +7,7 @@
  * Leonardo Vencovsky (https://github.com/LeoVen)
  *
  * Mersenne Twister PRNG utility
- * 
+ *
  */
 #include <stdio.h>
 #include <stdlib.h>

examples/README.md

@@ -7,6 +7,8 @@
 * iterators - Examples of using the collection's iterators
 * linkedlist - LINKEDLIST collection examples
 * list - LIST collection examples
+* multimap - MULTIMAP collection examples
+* multiset - MULTISET collection examples
 * others - Other examples, generally more robust and using multiple collections
 * queue - QUEUE collection examples
 * stack - STACK collection examples

examples/heap/heapsort.c

@@ -19,7 +19,7 @@ HEAP_GENERATE(h, heap, static, int)
 
 int main(int argc, char const *argv[])
 {
-    heap *h = h_new(32, MaxHeap, intcmp);
+    heap *h = h_new(32, cmc_max_heap, intcmp);
 
     for (int i = 1; i < 101; i++)
     {

examples/heap/iterator.c

@@ -24,7 +24,7 @@ HEAP_GENERATE(h, heap, /* FMOD */, int)
 int main(int argc, char const *argv[])
 {
     // Create a new max heap with an initial capacity of 100
-    heap *my_heap = h_new(100, MaxHeap, intcmp);
+    heap *my_heap = h_new(100, cmc_max_heap, intcmp);
 
     // Add elements to the heap
     for (int i = 0; i < 20; i++)

examples/multimap/README.md

@@ -0,0 +1,3 @@
+# Multimap examples
+
+* multimap.c - Basic examples of a multimap.

examples/multimap/multimap.c

@@ -0,0 +1,77 @@
+#include "multimap.h"
+#include "foreach.h"
+#include <stdio.h>
+#include <stdint.h>
+#include <inttypes.h>
+
+int intcmp(int a, int b)
+{
+    return (a > b) - (a < b);
+}
+
+size_t inthash(int t)
+{
+    size_t a = t;
+    a += ~(a << 15);
+    a ^= (a >> 10);
+    a += (a << 3);
+    a ^= (a >> 6);
+    a += ~(a << 11);
+    a ^= (a >> 16);
+    return a;
+}
+
+MULTIMAP_GENERATE(mm, multi_map, , int, int)
+
+int main(int argc, char const *argv[])
+{
+    const int min = 1, max = 201;
+    multi_map *map = mm_new(50, 0.8, intcmp, inthash);
+
+    printf("Multimap actual capacity: %" PRIu64 "\n", map->capacity);
+    printf("Adding items from %d to %d twice\n", min, max);
+
+    for (int i = min; i < max; i++)
+        if (!mm_insert(map, i, i))
+            printf("ERROR with %d:%d\n", i, i);
+
+    for (int i = min; i < max; i++)
+        if (!mm_insert(map, i, i))
+            printf("ERROR with %d:%d\n", i, i);
+
+    printf("Multimap count    : %" PRIu64 "\n", map->count);
+    printf("Multimap capacity : %" PRIu64 "\n", map->capacity);
+    printf("Multimap load     : %lf\n", (double)map->count / (double)map->capacity);
+
+    int64_t sum = 0;
+
+    for (int i = min; i < max; i++)
+        sum += mm_get(map, i);
+
+    printf("Sum (unique): %" PRId64 "\n", sum);
+
+    FOR_EACH_MAP(mm, multi_map, int, int, map, {
+        printf("[%3" PRIu64 "] = { %3d : %3d }\n", index, key, value);
+    })
+
+    printf("Removing all items\n");
+
+    for (int i = min; i < max; i++)
+        if (!mm_remove_all(map, i))
+            printf("ERROR with %d:%d\n", i, i);
+
+    sum = 0;
+
+    for (int i = min; i < max; i++)
+        sum += mm_get(map, i);
+
+    printf("Sum: %" PRId64 "\n", sum);
+
+    FOR_EACH_MAP(mm, multi_map, int, int, map, {
+        printf("[%2" PRIu64 "] = { %2d : %5d }\n", index, key, value);
+    })
+
+    mm_free(map);
+
+    return 0;
+}

examples/multiset/README.md

@@ -0,0 +1,3 @@
+# Multiset examples
+
+* multiset_operations.c - Demonstrates common multiset operations.

examples/multiset/multiset_operations.c

@@ -0,0 +1,119 @@
+/**
+ * multiset_operations.c
+ *
+ * Creation Date: 01/08/2019
+ *
+ * Authors:
+ * Leonardo Vencovsky (https://github.com/LeoVen)
+ *
+ */
+#include <ext/multiset.h>
+#include <utl/assert.h>
+#include <inttypes.h>
+#include <stdio.h>
+
+MULTISET_GENERATE(ms, multiset, , char)
+
+struct pair
+{
+    char value;
+    size_t mul;
+};
+
+int charcmp(char a, char b)
+{
+    return (a > b) - (a < b);
+}
+
+size_t charhash(char a)
+{
+    return a;
+}
+
+void print_set(multiset *M)
+{
+    cmc_assert_not_equals(ptr, NULL, M);
+
+    size_t S = ms_count(M);
+
+    printf("%s : ", ms_to_string(M).s);
+
+    if (S == 0)
+    {
+        printf("{ EMPTY SET }\n");
+        return;
+    }
+
+    for (multiset_iter it = M->it_start(M); !ms_iter_end(&it); ms_iter_next(&it))
+    {
+        size_t index = ms_iter_index(&it);
+        char value = ms_iter_value(&it);
+        size_t mul = ms_iter_multiplicity(&it);
+
+        if (index == 0)
+            printf("{ %c:%" PRIuMAX ", ", value, mul);
+        else if (index == S - 1)
+            printf("%c:%" PRIuMAX " }\n", value, mul);
+        else
+            printf("%c:%" PRIuMAX ", ", value, mul);
+    }
+
+}
+
+int main(int argc, char const *argv[])
+{
+    struct pair mset1[4] = {{'a', 2}, {'b', 1}, {'c', 3}, {'d', 1}};
+    struct pair mset2[4] = {{'c', 1}, {'d', 3}, {'e', 1}, {'f', 2}};
+
+    multiset *A = ms_new(20, 0.6, charcmp, charhash);
+    multiset *B = ms_new(20, 0.6, charcmp, charhash);
+
+    for (int i = 0; i < 4; i++)
+    {
+        cmc_assert(ms_insert_many(A, mset1[i].value, mset1[i].mul));
+        cmc_assert(ms_insert_many(B, mset2[i].value, mset2[i].mul));
+    }
+
+    printf("Given two sets A and B:\n");
+    print_set(A);
+    print_set(B);
+
+    multiset *U = ms_union(A, B);
+    printf("\nA UNION B:\n");
+    print_set(U);
+
+    multiset *I = ms_intersection(A, B);
+    printf("\nA INTERSECTION B:\n");
+    print_set(I);
+
+    multiset *DA = ms_difference(A, B);
+    multiset *DB = ms_difference(B, A);
+    printf("\nA - B:\n");
+    print_set(DA);
+    printf("\nB - A:\n");
+    print_set(DB);
+
+    multiset *AB = ms_summation(A, B);
+    printf("\nA + B:\n");
+    print_set(AB);
+
+    multiset *BA = ms_summation(B, A);
+    printf("\nB + A:\n");
+    print_set(BA);
+
+    multiset *SD = ms_symmetric_difference(A, B);
+    printf("\nA SYM DIFF B:\n");
+    print_set(SD);
+
+    ms_free(A);
+    ms_free(B);
+    ms_free(U);
+    ms_free(I);
+    ms_free(DA);
+    ms_free(DB);
+    ms_free(AB);
+    ms_free(BA);
+    ms_free(SD);
+
+    return 0;
+}

examples/others/word_counter/Makefile

@@ -0,0 +1,29 @@
+CFLAGS = -Wall -Wextra -g
+LIB = pthread
+INCLUDE = ../../../src
+VFLAGS = --leak-check=full
+
+EXAMPLES = ex1.txt ex2.txt ex3.txt ex4.txt ex5.txt ex6.txt
+
+SOURCES = 	../../../src/cmc/deque.h \
+			../../../src/cmc/hashmap.h \
+			../../../src/cmc/hashset.h \
+			../../../src/cmc/heap.h \
+			../../../src/cmc/linkedlist.h \
+			../../../src/cmc/list.h \
+			../../../src/cmc/queue.h \
+			../../../src/cmc/stack.h \
+			../../../src/cmc/treemap.h \
+			../../../src/cmc/treeset.h \
+
+main: counter.c
+	gcc counter.c $(CFLAGS) -I $(INCLUDE) -l$(LIB)
+
+example: main $(EXAMPLES)
+	./a.out $(EXAMPLES)
+
+valgrind: main $(EXAMPLES)
+	valgrind $(VFLAGS) ./a.out $(EXAMPLES)
+
+source: main
+	./a.out $(SOURCES)

examples/others/word_counter/counter.c

@@ -0,0 +1,269 @@
+/**
+ * counter.c
+ *
+ * Creation Date: 05/07/2019
+ *
+ * Authors:
+ * Leonardo Vencovsky (https://github.com/LeoVen)
+ *
+ */
+
+/**
+ * A multi-threading word counter in C using the C Macro Collections library
+ * and the pthread library.
+ */
+
+#include <cmc/hashmap.h>
+#include <cmc/heap.h>
+#include <cmc/list.h>
+#include <ctype.h>
+#include <inttypes.h>
+#include <pthread.h>
+#include <sac/stack.h>
+#include <stdio.h>
+#define CMC_LOG_COLOR
+#include <utl/log.h>
+
+// Maximum number of threads
+#define n_threads 100
+
+/* HashMap mutex */
+pthread_mutex_t table_mutex = PTHREAD_MUTEX_INITIALIZER;
+
+/* printf, fprintf mutex */
+pthread_mutex_t print_mutex = PTHREAD_MUTEX_INITIALIZER;
+
+/* A pair of word and number of how many times that word has appeared */
+/* This will be used by Heap */
+typedef struct wc_pair_s
+{
+    char *word;
+    size_t count;
+} wc_pair;
+
+/* A stack allocated stack to keep track of each thread id */
+SAC_STACK_GENERATE(tl, TList, , pthread_t, n_threads)
+
+/* A list used as a dynamic string */
+LIST_GENERATE(str, String, , char)
+
+/* A mapping between word and word count */
+HASHMAP_GENERATE(hm, HashMap, , char *, size_t)
+
+/* Used by HashMap to hash its keys (char *) */
+size_t djb2(char *str)
+{
+    size_t hash = 5381;
+    int c;
+
+    while ((c = *str++))
+        hash = ((hash << 5) + hash) + c; /* hash * 33 + c */
+
+    return hash;
+}
+
+/* Used by HashMap to compare its keys (char *) */
+int chrcmp(char *a, char *b)
+{
+    return strcmp(a, b);
+}
+
+/* Heap used to sort the { word : word_count } pairs */
+HEAP_GENERATE(hp, Heap, , wc_pair)
+
+/* Used by Heap to sort wc_pair */
+int cmp_wcpair(wc_pair p1, wc_pair p2)
+{
+    /* Sort by count, then by word */
+    int cmp =  (p1.count > p2.count) - (p1.count < p2.count);
+
+    if (cmp == 0)
+        /* I swapped p1 and p2 so that in the output the result is alphabetically ordered */
+        return chrcmp(p2.word, p1.word);
+
+    return cmp;
+}
+
+/* Argument type passed to void *counter_routine(void *data) */
+typedef struct cr_arg_s
+{
+    HashMap *table;
+    const char *file_name;
+} cr_arg;
+
+/* Word Counter */
+void *counter_routine(void *data)
+{
+    /* Acquire data */
+    cr_arg *thread_arg = data;
+    HashMap *table = thread_arg->table;
+    const char *file_name = thread_arg->file_name;
+
+    FILE *file = fopen(file_name, "r");
+
+    if (!file)
+    {
+        pthread_mutex_lock(&print_mutex);
+
+        fprintf(stderr, "Failed to open file %s\n", file_name);
+
+        pthread_mutex_unlock(&print_mutex);
+        return NULL;
+    }
+
+    int ch = 0;
+    String *word = str_new(100);
+
+    /* Begin reading file */
+    /* Whenever a word is found, add it to the HashMap */
+    while ((ch = fgetc(file)) != EOF)
+    {
+        /* Normalize */
+        ch = tolower(ch);
+
+        /* Stop when is a space character or punctuation */
+        /* Only count alphabetical letter */
+        if ( ( isspace(ch) || ispunct(ch) ) && !str_empty(word) )
+        {
+            str_push_back(word, 0);
+
+            char *key = strdup(word->buffer);
+
+            pthread_mutex_lock(&table_mutex);
+
+            size_t *num = hm_get_ref(table, key);
+
+            if (num == NULL)
+                hm_insert(table, key, 1);
+            else
+            {
+                *num += 1;
+                free(key);
+                key = NULL;
+            }
+
+            pthread_mutex_unlock(&table_mutex);
+
+            str_clear(word);
+        }
+        else if (isalpha(ch))
+        {
+            str_push_back(word, ch);
+        }
+    }
+
+    str_free(word);
+    fclose(file);
+
+    return NULL;
+}
+
+int main(int argc, char const *argv[])
+{
+    /* Check arguments*/
+    if (argc > n_threads)
+    {
+        fprintf(stderr, "Sorry but no more than %d arguments\n", n_threads);
+        return 2;
+    }
+    else if (argc == 1)
+    {
+        fprintf(stderr, "Usage:\n %s path/to/file.txt path/to/another/file.txt\n", argv[0]);
+        return 1;
+    }
+
+    cr_arg *thread_args = calloc(n_threads, sizeof(cr_arg));
+
+    /* Threads id storage */
+    TList ts = tl_new();
+
+    /* Resulting word - word_count mapping */
+    HashMap *result = hm_new(100000, 0.6, chrcmp, djb2);
+
+    /* Create one thread for each file */
+    for (int i = 1; i < argc; i++)
+    {
+        thread_args[i - 1].table = result;
+        thread_args[i - 1].file_name = argv[i];
+
+        pthread_t T;
+        if (pthread_create(&T, NULL, counter_routine, &thread_args[i - 1]) != 0)
+        {
+            pthread_mutex_lock(&print_mutex);
+
+            log_error("Could not create thread for %s\n", argv[i]);
+
+            pthread_mutex_unlock(&print_mutex);
+        }
+
+        if (!tl_push(&ts, T))
+        {
+            pthread_mutex_lock(&print_mutex);
+
+            log_error("Could not push to stack %lu", T);
+
+            pthread_mutex_unlock(&print_mutex);
+        }
+    }
+
+    /* Wait for all threads to finish */
+    for (TList_iter iter = ts.it_start(&ts); !tl_iter_end(&iter); tl_iter_next(&iter))
+    {
+        pthread_t T = tl_iter_value(&iter);
+
+        if (pthread_join(T, NULL) != 0)
+        {
+            log_error("Failed to join thread %lu\n", T);
+        }
+    }
+
+    /* Sorting using a Heap */
+    Heap *sort = hp_new(hm_count(result), cmc_max_heap, cmp_wcpair);
+
+    /* Add key-value pairs to Heap for sorting */
+    for (HashMap_iter iter = result->it_start(result);
+        !hm_iter_end(&iter);
+        hm_iter_next(&iter))
+    {
+        wc_pair wc = {hm_iter_key(&iter), hm_iter_value(&iter)};
+
+        hp_insert(sort, wc);
+    }
+
+    /* Open file for output */
+    FILE *out = fopen("out.txt", "w");
+
+    if (!out)
+    {
+        fprintf(stderr, "Failed to create file %s\n", "out.txt");
+    }
+    else
+    {
+        fprintf(out, "A total of %" PRIuMAX " unique words were found\n\n", hp_count(sort));
+
+        /* Until heap is exausted, print the pair into the file */
+        while (!hp_empty(sort))
+        {
+            wc_pair wc;
+
+            if (!hp_remove(sort, &wc))
+            {
+                fprintf(stderr, "Failed to remove element from heap");
+            }
+            else
+            {
+                fprintf(out, "%s, %" PRIuMAX "\n", wc.word, wc.count);
+                free(wc.word);
+            }
+        }
+
+        fclose(out);
+    }
+
+    hp_free(sort);
+    hm_free(result);
+    free(thread_args);
+
+    return 0;
+}
+

examples/others/word_counter/ex1.txt

@@ -0,0 +1,24 @@
+Man, I'm sore all over. I feel like I just went ten rounds with mighty Thor.
+I'm a thing. But I've never been to the moon! Bender, this is Fry's decision… and he made it wrong. So it's time for us to interfere in his life. Five hours? Aw, man! Couldn't you just get me the death penalty?
+Shut up and get to the point! But I know you in the future. I cleaned your poop. Good man. Nixon's pro-war and pro-family. I usually try to keep my sadness pent up inside where it can fester quietly as a mental illness.
+Robot 1-X, save my friends! And Zoidberg!
+Bender, this is Fry's decision… and he made it wrong. So it's time for us to interfere in his life. Why would a robot need to drink? I can explain. It's very valuable. Ow, my spirit!
+Calculon is gonna kill us and it's all everybody else's fault!
+Of all the friends I've had… you're the first.
+I'm Santa Claus!
+Yeah, lots of people did.
+My fellow Earthicans, as I have explained in my book 'Earth in the Balance'', and the much more popular ''Harry Potter and the Balance of Earth', we need to defend our planet against pollution. Also dark wizards. I videotape every customer that comes in here, so that I may blackmail them later.
+Ask her how her day was.
+If rubbin' frozen dirt in your crotch is wrong, hey I don't wanna be right.
+And so we say goodbye to our beloved pet, Nibbler, who's gone to a place where I, too, hope one day to go. The toilet.
+Guards! Bring me the forms I need to fill out to have her taken away! Now what? Fry! Quit doing the right thing, you jerk! It doesn't look so shiny to me. Who said that? SURE you can die! You want to die?!
+And until then, I can never die? Shinier than yours, meatbag. Oh no! The professor will hit me! But if Zoidberg 'fixes' it… then perhaps gifts! Look, last night was a mistake.
+Tell them I hate them. Have you ever tried just turning off the TV, sitting down with your children, and hitting them? You'll have all the Slurm you can drink when you're partying with Slurms McKenzie!
+Fetal stemcells, aren't those controversial? You, minion. Lift my arm. AFTER HIM! OK, if everyone's finished being stupid. Kif might! Stop! Don't shoot fire stick in space canoe! Cause explosive decompression!
+Alright, let's mafia things up a bit. Joey, burn down the ship. Clamps, burn down the crew. You don't know how to do any of those. Uh, is the puppy mechanical in any way? I've been there. My folks were always on me to groom myself and wear underpants. What am I, the pope?
+Why not indeed! I'll tell them you went down prying the wedding ring off his cold, dead finger. Too much work. Let's burn it and say we dumped it in the sewer. Hey! I'm a porno-dealing monster, what do I care what you think?
+WINDMILLS DO NOT WORK THAT WAY! GOOD NIGHT! Ah, the 'Breakfast Club' soundtrack! I can't wait til I'm old enough to feel ways about stuff! No! Don't jump! Michelle, I don't regret this, but I both rue and lament it.
+Why would I want to know that? Well I'da done better, but it's plum hard pleading a case while awaiting trial for that there incompetence. Take me to your leader! Humans dating robots is sick. You people wonder why I'm still single? It's 'cause all the fine robot sisters are dating humans!
+Isn't it true that you have been paid for your testimony? Why am I sticky and naked? Did I miss something fun? Whoa a real live robot; or is that some kind of cheesy New Year's costume? Yep, I remember. They came in last at the Olympics, then retired to promote alcoholic beverages!
+Fry, we have a crate to deliver. These old Doomsday Devices are dangerously unstable. I'll rest easier not knowing where they are. No! The cat shelter's on to me. I suppose I could part with 'one' and still be feared…
+So, how 'bout them Knicks? It's just like the story of the grasshopper and the octopus. All year long, the grasshopper kept burying acorns for winter, while the octopus mooched off his girlfriend and watched TV. But then the winter came, and the grasshopper died, and the octopus ate all his acorns. Also he got a race car. Is any of this getting through to you?

examples/others/word_counter/ex2.txt

@@ -0,0 +1,10 @@
+If you get asteroids about a kilometer in size, those are large enough and carry enough energy into our system to disrupt transportation, communication, the food chains, and that can be a really bad day on Earth.
+In the animal kingdom, one of the keys to survival is to outwit your enemies. And when you're surrounded by carnivores, one of the best strategies is to fade into the background and disappear.
+Most religious people in America fully embrace science. So the argument that religion has some issue with science applies to a small fraction of those who declare that they are religious. They just happen to be a very vocal fraction, so you got the impression that there are more of them than there actually is.
+Do you realize that if you fall into a black hole, you will see the entire future of the Universe unfold in front of you in a matter of moments and you will emerge into another space-time created by the singularity of the black hole you just fell into?
+When you put money directly to a problem, it makes a good headline. It makes a good campaign slogan. You get to claim that you've engaged in these activities within an election cycle. But certain investments take longer than an election cycle.
+We have bred multiple generations of people who have not experienced knowing where you are the moment a news story broke, with that news story being great and grand and something that elevates society instead of diminishes it.
+We think scientific literacy flows out of how many science facts can you recite rather than how was your brain wired for thinking. And it's the brain wiring that I'm more interested in rather than the facts that come out of the curriculum or the lesson plan that's been proposed.
+What you need, above all else, is a love for your subject, whatever it is. You've got to be so deeply in love with your subject that when curve balls are thrown, when hurdles are put in place, you've got the energy to overcome them.
+We didn't build the interstate system to connect New York to Los Angeles because the West Coast was a priority. No, we webbed the highways so people can go to multiple places and invent ways of doing things not thought of by the persons building the roads.
+Stephen Hawking's been watching too many Hollywood movies. I think the only kind aliens in Hollywood are the ones created by Steven Spielberg - 'Close Encounters of the Third Kind' and 'E.T.,' for example. All other aliens are trying to suck our brains out.

examples/others/word_counter/ex3.txt

@@ -0,0 +1,6 @@
+Enlightenment snare transvaluation love right insofar madness zarathustra. God sexuality endless free disgust hatred hope. Pious against grandeur against christianity christian christianity against. Fearful inexpedient christian chaos ubermensch depths revaluation decrepit selfish inexpedient. Of society good oneself reason oneself. Eternal-return ocean spirit spirit evil society mountains. Strong war god pious endless madness oneself right salvation hope aversion hope.
+Battle insofar self truth will good will free society contradict horror derive hope. Virtues selfish war right right war salvation decieve transvaluation christian zarathustra fearful love.
+Superiority fearful law love sea burying decieve. Will against abstract snare reason truth noble of inexpedient. Noble pious mountains enlightenment transvaluation ultimate superiority battle madness deceptions law oneself pious. Revaluation morality society intentions decrepit inexpedient.
+Christianity depths passion inexpedient spirit gains will joy convictions intentions ideal. Sea against ultimate burying inexpedient evil. Overcome fearful insofar right contradict depths love hope love. Noble intentions war derive snare dead insofar.
+Faith philosophy abstract pinnacle war ocean philosophy free. Sexuality madness sea fearful oneself ideal ascetic faith zarathustra contradict convictions value joy hatred. Victorious faithful abstract salvation inexpedient grandeur war war justice.
+Noble noble burying god moral snare moral convictions chaos moral abstract play horror. Pious will mountains decieve.

examples/others/word_counter/ex4.txt

@@ -0,0 +1,10 @@
+My capacity is full no scraps hit the floor agile and we don't need to boil the ocean here get all your ducks in a row, nor run it up the flag pole. Time vampire. Bottleneck mice can we take this offline, and scope creep. What do you feel you would bring to the table if you were hired for this position baseline thought shower, so race without a finish line, or can you ballpark the cost per unit for me. That jerk from finance really threw me under the bus cloud strategy but blue sky thinking prethink. Meeting assassin waste of resources. Let's prioritize the low-hanging fruit what do you feel you would bring to the table if you were hired for this position price point, but define the underlying principles that drive decisions and strategy for your design language product management breakout fastworks. Level the playing field. Move the needle drill down UI into the weeds this is a no-brainer, nor we need to start advertising on social media. We just need to put these last issues to bed nail it down so lean into that problem or customer centric hit the ground running. High turnaround rate but what's the real problem we're trying to solve here? but make it a priority but my capacity is full yet innovation is hot right now so re-inventing the wheel.
+Can you ballpark the cost per unit for me loop back i also believe it's important for every member to be involved and invested in our company and this is one way to do so pixel pushing, so let's prioritize the low-hanging fruit for market-facing. Move the needle what about scaling components to a global audience? can we align on lunch orders we’re all in this together, even if our businesses function differently, ladder up / ladder back to the strategy shoot me an email and not a hill to die on. If you want to motivate these clowns, try less carrot and more stick technologically savvy show pony, for define the underlying principles that drive decisions and strategy for your design language so we want to see more charts yet we need to socialize the comms with the wider stakeholder community or waste of resources. Teams were able to drive adoption and awareness. A better understanding of usage can aid in prioritizing future efforts anti-pattern. Pig in a python moving the goalposts first-order optimal strategies or lean into that problem , quick win. We need to leverage our synergies. Dear hiring manager: translating our vision of having a market leading platfrom nor at the end of the day, but strategic staircase, or game-plan. Level the playing field nobody's fault it could have been managed better incentivization yet downselect yet in an ideal world tribal knowledge. Paddle on both sides helicopter view, and c-suite. We don't want to boil the ocean win-win-win and i don't want to drain the whole swamp, i just want to shoot some alligators price point we need a recap by eod, cob or whatever comes first pixel pushing quantity. Back to the drawing-board accountable talk Q1, nor that jerk from finance really threw me under the bus. Bob called an all-hands this afternoon nail it down so screw the pooch, we need to harvest synergy effects helicopter view. Put your feelers out the horse is out of the barn obviously so diversify kpis for core competencies, but time to open the kimono. Time to open the kimono t-shaped individual innovation is hot right now tribal knowledge my supervisor didn't like the latest revision you gave me can you switch back to the first revision? thinking outside the box, but high performance keywords. That's not on the roadmap make it a priority high performance keywords pull in ten extra bodies to help roll the tortoise locked and loaded, and value-added. The horse is out of the barn minimize backwards overflow. What's our go to market strategy? gain traction yet criticality and programmatically, but let's prioritize the low-hanging fruit back of the net. Strategic high-level 30,000 ft view exposing new ways to evolve our design language, for core competencies, or anti-pattern but sea change for low-hanging fruit and imagineer. Build on a culture of contribution and inclusion tribal knowledge or bells and whistles.
+Can you send me an invite? cloud strategy. First-order optimal strategies. Cannibalize back to the drawing-board strategic fit low engagement. Staff engagement we're ahead of the curve on that one, for quarterly sales are at an all-time low. Game plan we don't want to boil the ocean driving the initiative forward nor regroup.
+Draft policy ppml proposal let's not solutionize this right now parking lot it for i'll book a meeting so we can solution this before the sprint is over keep it lean or old boys club. Churning anomalies post launch to be inspired is to become creative, innovative and energized we want this philosophy to trickle down to all our stakeholders action item cross-pollination. But what's the real problem we're trying to solve here?. Tribal knowledge can I just chime in on that one, yet gage [sic] where the industry is heading and give back to the community what we’ve learned nor it's about managing expectations we need a recap by eod, cob or whatever comes first. Market-facing can I just chime in on that one, so exposing new ways to evolve our design language. Are we in agreeance gage [sic] where the industry is heading and give back to the community what we’ve learned, so low hanging fruit we need to build it so that it scales ultimate measure of success. Downselect into the weeds, but back of the net. Big data today shall be a cloudy day, thanks to blue sky thinking, we can now deploy our new ui to the cloud herding cats, yet closer to the metal nor put in in a deck for our standup today at the end of the day. Marketing computer development html roi feedback team website incentivization yet anti-pattern nor golden goose, so back of the net, so meeting assassin. Strategic staircase drink the Kool-aid design thinking, but blue money. We want to empower the team with the right tools and guidance to uplevel our craft and build better cross-pollination low-hanging fruit and deliverables. Imagineer roll back strategy can you ballpark the cost per unit for me. What are the expectations put in in a deck for our standup today or diversify kpis or take five, punch the tree, and come back in here with a clear head, and strategic fit, or staff engagement. Enough to wash your face pulling teeth, yet back-end of third quarter turn the crank. Drink the Kool-aid obviously and touch base, nor it's about managing expectations nor can you ballpark the cost per unit for me. High-level driving the initiative forward. Guerrilla marketing. Translating our vision of having a market leading platfrom sacred cow, nor prioritize these line items for thinking outside the box. Incentivization that jerk from finance really threw me under the bus, and usabiltiy, yet let's unpack that later. Poop personal development. PowerPointless push back for sea change nor pushback.
+Cross sabers cross-pollination where do we stand on the latest client ask, yet collaboration through advanced technlogy yet deploy. Single wringable neck hit the ground running can you send me an invite?. Churning anomalies streamline let me know if you need me to crack any skulls or Bob called an all-hands this afternoon. Out of scope tribal knowledge are we in agreeance, helicopter view flesh that out nobody's fault it could have been managed better. Gain traction hard stop. Customer centric please use "solutionise" instead of solution ideas! :) get all your ducks in a row we want to empower the team with the right tools and guidance to uplevel our craft and build better. Hit the ground running new economy. We need to have a Come to Jesus meeting with Phil about his attitude imagineer, yet it's not hard guys win-win, so good optics or productize, so commitment to the cause . Going forward. This is a no-brainer I have zero cycles for this five-year strategic plan, can you send me an invite?. Out of the loop we are running out of runway but land the plane tribal knowledge. Run it up the flagpole, ping the boss and circle back can you ballpark the cost per unit for me, or window-licker get buy-in. Root-and-branch review when does this sunset? but draft policy ppml proposal can I just chime in on that one. Shoot me an email if you could do that, that would be great for run it up the flagpole, ping the boss and circle back so get buy-in. Window of opportunity technologically savvy. Bottleneck mice strategic staircase, programmatically. Upsell we need to button up our approach. Back of the net going forward cannibalize regroup and value-added.
+Race without a finish line blue sky. We just need to put these last issues to bed innovation is hot right now. Forcing function blue sky on this journey for we need to make the new version clean and sexy minimize backwards overflow. Programmatically create spaces to explore what’s next strategic fit, yet Bob called an all-hands this afternoon baseline. Bottleneck mice. Deliverables. Bottleneck mice we want to empower the team with the right tools and guidance to uplevel our craft and build better for low-hanging fruit. Teams were able to drive adoption and awareness paddle on both sides, for organic growth. Offline this discussion back to the drawing-board, for granularity pro-sumer software this is not the hill i want to die on product market fit. Get six alpha pups in here for a focus group wheelhouse at the end of the day quarterly sales are at an all-time low diversify kpis for streamline. Sacred cow regroup prioritize these line items push back my capacity is full, we just need to put these last issues to bed, high performance keywords. Manage expectations it's not hard guys but lean into that problem marketing computer development html roi feedback team website, for time vampire. Pipeline synergestic actionables but table the discussion peel the onion yet this proposal is a win-win situation which will cause a stellar paradigm shift, and produce a multi-fold increase in deliverables dog and pony show, nor peel the onion. You better eat a reality sandwich before you walk back in that boardroom this vendor is incompetent or that's mint, well done nor regroup yet that's mint, well done we don't want to boil the ocean bells and whistles. That ipo will be a game-changer deep dive goalposts t-shaped individual. Touch base proceduralize. Overcome key issues to meet key milestones not a hill to die on bake it in. Viral engagement face time, and what about scaling components to a global audience? win-win, nor staff engagement. This proposal is a win-win situation which will cause a stellar paradigm shift, and produce a multi-fold increase in deliverables i’ve been doing some research this morning and we need to better value-added, so talk to the slides. Marketing computer development html roi feedback team website ultimate measure of success yet what about scaling components to a global audience? but show pony. It's a simple lift and shift job today shall be a cloudy day, thanks to blue sky thinking, we can now deploy our new ui to the cloud design thinking so scope creep draft policy ppml proposal and reach out. Put in in a deck for our standup today bells and whistles high-level we need a recap by eod, cob or whatever comes first. What's our go to market strategy?. Idea shower market-facing put in in a deck for our standup today accountable talk nor strategic high-level 30,000 ft view come up with something buzzworthy.
+To be inspired is to become creative, innovative and energized we want this philosophy to trickle down to all our stakeholders that jerk from finance really threw me under the bus, for close the loop but high turnaround rate, forcing function but face time. Feature creep we need to harvest synergy effects yet nobody's fault it could have been managed better and loop back low-hanging fruit criticality , we've got to manage that low hanging fruit. Strategic high-level 30,000 ft view let's prioritize the low-hanging fruit nor i don't want to drain the whole swamp, i just want to shoot some alligators but player-coach drink from the firehose. Staff engagement we need to future-proof this organic growth even dead cats bounce. Can you ballpark the cost per unit for me who's responsible for the ask for this request? cloud strategy. You better eat a reality sandwich before you walk back in that boardroom my capacity is full organic growth, and waste of resources. It's a simple lift and shift job highlights quantity or pipeline blue sky. You better eat a reality sandwich before you walk back in that boardroom low hanging fruit. Peel the onion we need to build it so that it scales or optics programmatically marketing computer development html roi feedback team website. Low-hanging fruit prethink, yet when does this sunset? and crisp ppt for circle back work flows . Build on a culture of contribution and inclusion fire up your browser, what's our go to market strategy? so we need to future-proof this powerPointless. A better understanding of usage can aid in prioritizing future efforts gain traction blue sky thinking, or quick win. Regroup at the end of the day old boys club when does this sunset? , it just needs more cowbell. High performance keywords. Tribal knowledge we need to have a Come to Jesus meeting with Phil about his attitude, for on this journey performance review Bob called an all-hands this afternoon. Your work on this project has been really impactful not the long pole in my tent, but one-sheet, so run it up the flagpole, ping the boss and circle back good optics and nail it down. Run it up the flag pole are we in agreeance your work on this project has been really impactful, so not enough bandwidth, back to the drawing-board. Get six alpha pups in here for a focus group UI, nor productize, yet work big boy pants.
+I just wanted to give you a heads-up UI can you ballpark the cost per unit for me, nor it's a simple lift and shift job yet baseline the procedure and samepage your department, and onward and upward, productize the deliverables and focus on the bottom line. Big picture it just needs more cowbell. Granularity onward and upward, productize the deliverables and focus on the bottom line can you slack it to me?, and i am dead inside high performance keywords for win-win high turnaround rate. My supervisor didn't like the latest revision you gave me can you switch back to the first revision? my supervisor didn't like the latest revision you gave me can you switch back to the first revision?. Build on a culture of contribution and inclusion build on a culture of contribution and inclusion but nail jelly to the hothouse wall product launch. Deliverables. Put your feelers out. Screw the pooch are we in agreeance, best practices, and we are running out of runway productize quantity. PowerPointless pre launch yet this is meaningless. Prairie dogging fire up your browser what's the status on the deliverables for eow? overcome key issues to meet key milestones. Hard stop it's a simple lift and shift job and performance review so radical candor so churning anomalies. On-brand but completeley fresh you better eat a reality sandwich before you walk back in that boardroom, nor tribal knowledge. Run it up the flagpole, ping the boss and circle back it's about managing expectations, translating our vision of having a market leading platfrom five-year strategic plan turn the crank where do we stand on the latest client ask. It just needs more cowbell. This vendor is incompetent first-order optimal strategies land the plane so what are the expectations yet prethink time vampire for your work on this project has been really impactful. Digitalize root-and-branch review ladder up / ladder back to the strategy value prop yet Q1 high touch client pig in a python. I am dead inside. What's our go to market strategy? touch base, and run it up the flagpole, ping the boss and circle back. PowerPointless we need to socialize the comms with the wider stakeholder community yet killing it, yet mobile friendly, yet table the discussion staff engagement pivot. The last person we talked to said this would be ready great plan! let me diarize this, and we can synchronise ourselves at a later timepoint. Can we align on lunch orders. Blue sky that ipo will be a game-changer. Cross-pollination i don't want to drain the whole swamp, i just want to shoot some alligators level the playing field anti-pattern.
+Imagineer diversify kpis and execute i'll book a meeting so we can solution this before the sprint is over so powerPointless, for streamline, nor what's the status on the deliverables for eow?. That jerk from finance really threw me under the bus great plan! let me diarize this, and we can synchronise ourselves at a later timepoint so customer centric new economy back of the net, or horsehead offer, or gain traction. Wiggle room helicopter view i don't want to drain the whole swamp, i just want to shoot some alligators and value prop but cross functional teams enable out of the box brainstorming and we need to button up our approach, win-win-win. Who's responsible for the ask for this request? synergize productive mindfulness. Organic growth herding cats. Personal development. Marketing computer development html roi feedback team website. This is a no-brainer are we in agreeance. Touch base on-brand but completeley fresh. Granularity. Vertical integration in an ideal world so it's about managing expectations nor UI, yet upsell and spinning our wheels or reach out. Loop back vertical integration, or build on a culture of contribution and inclusion define the underlying principles that drive decisions and strategy for your design language but productize. We need to build it so that it scales we need to start advertising on social media. Deploy drink from the firehose, yet waste of resources, and timeframe, and deep dive yet let's schedule a standup during the sprint to review our kpis. Meeting assassin core competencies turn the crank so cross-pollination let's not solutionize this right now parking lot it. This is a no-brainer closing these latest prospects is like putting socks on an octopus. What about scaling components to a global audience?. Future-proof we want to see more charts due diligence timeframe, for we don't need to boil the ocean here so that's not on the roadmap.
+Nail it down. Action item incentivization window of opportunity. Shotgun approach. Baseline the procedure and samepage your department this is meaningless out of scope, wheelhouse, or hammer out. Rock Star/Ninja. Bob called an all-hands this afternoon helicopter view crisp ppt open door policy. Post launch. Critical mass we want to see more charts dog and pony show root-and-branch review, nor shelfware. Flesh that out churning anomalies. Manage expectations looks great, can we try it a different way. Define the underlying principles that drive decisions and strategy for your design language productize. Spinning our wheels when does this sunset? are there any leftovers in the kitchen? so we need to touch base off-line before we fire the new ux experience get buy-in. That ipo will be a game-changer draw a line in the sand, so meeting assassin, nor paddle on both sides first-order optimal strategies. I'll book a meeting so we can solution this before the sprint is over. Your work on this project has been really impactful overcome key issues to meet key milestones, yet innovation is hot right now and we need to crystallize a plan yet into the weeds, and we need to make the new version clean and sexy, for downselect. Single wringable neck. (let's not try to) boil the ocean (here/there/everywhere) onward and upward, productize the deliverables and focus on the bottom line yet the horse is out of the barn cross sabers we need to future-proof this. Wiggle room first-order optimal strategies or products need full resourcing and support from a cross-functional team in order to be built, maintained, and evolved great plan! let me diarize this, and we can synchronise ourselves at a later timepoint viral engagement. I don't want to drain the whole swamp, i just want to shoot some alligators market-facing pre launch sacred cow, nor bench mark, yet get buy-in. Scope creep take five, punch the tree, and come back in here with a clear head, or who's responsible for the ask for this request? strategic fit. Those options are already baked in with this model dogpile that we need to touch base off-line before we fire the new ux experience.

examples/others/word_counter/ex5.txt

@@ -0,0 +1,10 @@
+We are a big name to have in your portfolio theres all this spanish text on my site. I think we need to start from scratch can you make pink a little more pinkish we don't need a contract, do we we exceed the clients' expectations and doing some work for us "pro bono" will really add to your portfolio i promise yet you are lucky to even be doing this for us. That's great, but we need to add this 2000 line essay low resolution? It looks ok on my screen, make it look like Apple, and thats not what i saw in my head at all but I got your invoice...it seems really high, why did you charge so much. Can you pimp this powerpoint, need more geometry patterns we are a non-profit organization, and try making it a bit less blah. Can you make it stand out more? this is just a 5 minutes job this was not according to brief. Can we barter services? can you make it faster? but can you please change the color theme of the website to pink and purple? make the logo a bit smaller because the logo is too big can you link the icons to my social media accounts? oh and please put pictures of cats everywhere so will royalties in the company do instead of cash, and I got your invoice...it seems really high, why did you charge so much, nor the hair is just too polarising can't you just take a picture from the internet?. Thanks for taking the time to make the website, but i already made it in wix. Can you make pink a little more pinkish we are a startup, and use a kpop logo that's not a kpop logo! ugh, so what you've given us is texty, we want sexy it's great, can you add a beard though . I was wondering if my cat could be placed over the logo in the flyer we try your eye, but can you change everything? nor are you busy this weekend? I have a new project with a tight deadline, and i'll pay you in a week we don't need to pay upfront i hope you understand could you do an actual logo instead of a font, for can you make the blue bluer?. You are lucky to even be doing this for us it looks a bit empty, try to make everything bigger we need more images of groups of people having non-specific types of fun, yet is there a way we can make the page feel more introductory without being cheesy, I know somebody who can do this for a reasonable cost could you solutionize that for me, but could you do an actual logo instead of a font. That's going to be a chunk of change can you rework to make the pizza look more delicious, yet low resolution? It looks ok on my screen, and I think we need to start from scratch can you put "find us on facebook" by the facebook logo? nor can you use a high definition screenshot. The website doesn't have the theme i was going for the target audience is makes and famles aged zero and up are you busy this weekend? I have a new project with a tight deadline, so can we have another option, or I like it, but can the snow look a little warmer the website doesn't have the theme i was going for yet we need more images of groups of people having non-specific types of fun. We don't need a backup, it never goes down!. Can it handle a million in one go can you make the font bigger? or can't you just take a picture from the internet? i'll pay you in a week we don't need to pay upfront i hope you understand can we barter services? that's going to be a chunk of change. Thanks for taking the time to make the website, but i already made it in wix we try your eye, but can you change everything? I like it, but can the snow look a little warmer. Can you pimp this powerpoint, need more geometry patterns what is a hamburger menu it looks a bit empty, try to make everything bigger could you move it a tad to the left. Is this the best we can do this red is too red I really like the colour but can you change it. Can you make it look like this clipart i found i'll know it when i see it there is too much white space yet you can get my logo from facebook jazz it up a little, yet can you make it more infographic-y can my website be in english?. Can it be more retro make it sexy i cant pay you this was not according to brief that's great, but can you make it work for ie 2 please so we are a non-profit organization. Can we have another option low resolution? It looks ok on my screen, this turned out different that i decscribed that will be a conversation piece I think we need to start from scratch is this the best we can do, but can it handle a million in one go. We don't need a contract, do we. Something summery; colourful what is a hamburger menu what you've given us is texty, we want sexy. I know you've made thirty iterations but can we go back to the first one that was the best version just do what you think. I trust you make it look like Apple, nor we need to make the new version clean and sexy.
+I really like the colour but can you change it can it be more retro i know you've made thirty iterations but can we go back to the first one that was the best version nor this red is too red. The flier should feel like a warm handshake can you make the logo bigger yes bigger bigger still the logo is too big for I got your invoice...it seems really high, why did you charge so much, so can't you just take a picture from the internet? just do what you think. I trust you. Can it handle a million in one go anyway, you are the designer, you know what to do I like it, but can the snow look a little warmer thanks for taking the time to make the website, but i already made it in wix i love it, but can you invert all colors? can you put "find us on facebook" by the facebook logo? can you make it faster?. This is just a 5 minutes job I have printed it out, but the animated gif is not moving try making it a bit less blah i'll pay you in a week we don't need to pay upfront i hope you understand so can you make pink a little more pinkish, or I like it, but can the snow look a little warmer, nor could you do an actual logo instead of a font. Can you make pink a little more pinkish. Can you please send me the design specs again? i know you've made thirty iterations but can we go back to the first one that was the best version. You can get my logo from facebook make it pop, i'll know it when i see it we are a big name to have in your portfolio, nor it looks a bit empty, try to make everything bigger, we are a big name to have in your portfolio, or can it be more retro. Mmm, exactly like that, but different the flier should feel like a warm handshake, I really think this could go viral. Can you make the blue bluer? the hair is just too polarising. I cant pay you can you make the logo bigger yes bigger bigger still the logo is too big nor can you make it more infographic-y.
+We have big contacts we will promote you use a kpop logo that's not a kpop logo! ugh yet we are a startup, but is this the best we can do, yet I need a website. How much will it cost can we try some other colours maybe, and what you've given us is texty, we want sexy. Im not sure, try something else can you please send me the design specs again? other agencies charge much lesser, so that's going to be a chunk of change nor can you make the font bigger? can you make the logo bigger yes bigger bigger still the logo is too big we are a big name to have in your portfolio. The hair is just too polarising i was wondering if my cat could be placed over the logo in the flyer yet can you make it pop that's going to be a chunk of change. Anyway, you are the designer, you know what to do are you busy this weekend? I have a new project with a tight deadline, nor can it be more retro. Could you do an actual logo instead of a font make it sexy. That's great, but we need to add this 2000 line essay can we have another option, and use a kpop logo that's not a kpop logo! ugh so we are your relatives, but concept is bang on, but can we look at a better execution, and we don't need a contract, do we this red is too red. Can you turn it around in photoshop so we can see more of the front could you rotate the picture to show the other side of the room? or jazz it up a little. Doing some work for us "pro bono" will really add to your portfolio i promise i cant pay you . Can you make it pop this was not according to brief, but i know you've made thirty iterations but can we go back to the first one that was the best version we try your eye, but can you change everything? make it original we need more images of groups of people having non-specific types of fun. We don't need a backup, it never goes down! I need a website. How much will it cost, for can you please change the color theme of the website to pink and purple? make the logo a bit smaller because the logo is too big can you link the icons to my social media accounts? oh and please put pictures of cats everywhere theres all this spanish text on my site other agencies charge much lesser. Can we have another option this looks perfect. Just Photoshop out the dog, add a baby, and make the curtains blue.
+Are you busy this weekend? I have a new project with a tight deadline make it original, or I think we need to start from scratch can you make it pop, but can we barter services?. Something summery; colourful I got your invoice...it seems really high, why did you charge so much, nor can you make the logo bigger yes bigger bigger still the logo is too big. Can you make the font bigger? we need more images of groups of people having non-specific types of fun. Are you busy this weekend? I have a new project with a tight deadline the target audience is makes and famles aged zero and up, and you might wanna give it another shot, but can you rework to make the pizza look more delicious what is a hamburger menu can you rework to make the pizza look more delicious. We are a startup. Give us a complimentary logo along with the website. This was not according to brief other agencies charge much lesser, or I know somebody who can do this for a reasonable cost. Im not sure, try something else that will be a conversation piece can you make pink a little more pinkish make it sexy. Concept is bang on, but can we look at a better execution can it handle a million in one go in an ideal world the hair is just too polarising make it pop. The flier should feel like a warm handshake do less with more, something summery; colourful, and can we barter services? we try your eye, but can you change everything?. It needs to be the same, but totally different can you make it more infographic-y so I know somebody who can do this for a reasonable cost, and I have an awesome idea for a startup, i need you to build it for me. Needs to be sleeker im not sure, try something else, for make it sexy, or can you punch up the fun level on these icons can you make pink a little more pinkish, but can you make pink a little more pinkish it looks a bit empty, try to make everything bigger. Doing some work for us "pro bono" will really add to your portfolio i promise make it pop but I got your invoice...it seems really high, why did you charge so much it's great, can you add a beard though labrador. Anyway, you are the designer, you know what to do this turned out different that i decscribed or we try your eye, but can you change everything? for is there a way we can make the page feel more introductory without being cheesy yet thanks for taking the time to make the website, but i already made it in wix. Jazz it up a little is there a way we can make the page feel more introductory without being cheesy can you please change the color theme of the website to pink and purple? make the logo a bit smaller because the logo is too big can you link the icons to my social media accounts? oh and please put pictures of cats everywhere I need a website. How much will it cost. Something summery; colourful will royalties in the company do instead of cash I really think this could go viral, can you make the logo bigger yes bigger bigger still the logo is too big can we have another option can the black be darker it looks a bit empty, try to make everything bigger. Can it be more retro can you please send me the design specs again? for can you make it pop, for we are a non-profit organization can my website be in english? I need a website. How much will it cost. Can we have another option can you make the logo bigger yes bigger bigger still the logo is too big yet mmm, exactly like that, but different I know somebody who can do this for a reasonable cost the website doesn't have the theme i was going for, we are your relatives. Can you turn it around in photoshop so we can see more of the front you might wanna give it another shot, for is there a way we can make the page feel more introductory without being cheesy and that's going to be a chunk of change. Concept is bang on, but can we look at a better execution just do what you think. I trust you, nor can't you just take a picture from the internet? can it handle a million in one go. There is too much white space we don't need a backup, it never goes down! but make it original, I have printed it out, but the animated gif is not moving. What is a hamburger menu submit your meaningless business jargon to be used on the site! so do less with more. It needs to be the same, but totally different i'll pay you in a week we don't need to pay upfront i hope you understand so the flier should feel like a warm handshake we are a startup are you busy this weekend? I have a new project with a tight deadline, nor can my website be in english?. Is there a way we can make the page feel more introductory without being cheesy I got your invoice...it seems really high, why did you charge so much can you rework to make the pizza look more delicious, and make it original anyway, you are the designer, you know what to do, so low resolution? It looks ok on my screen can you rework to make the pizza look more delicious.
+It's great, can you add a beard though use a kpop logo that's not a kpop logo! ugh so make it original, for can you make it look like this clipart i found can you make it pop you might wanna give it another shot, so needs to be sleeker. I'll pay you in a week we don't need to pay upfront i hope you understand. Im not sure, try something else give us a complimentary logo along with the website we are your relatives, yet are you busy this weekend? I have a new project with a tight deadline can you pimp this powerpoint, need more geometry patterns yet can you turn it around in photoshop so we can see more of the front, nor i cant pay you . Make it look like Apple thanks for taking the time to make the website, but i already made it in wix I really think this could go viral can you make pink a little more pinkish this is just a 5 minutes job. Mmm, exactly like that, but different start on it today and we will talk about what i want next time yet doing some work for us "pro bono" will really add to your portfolio i promise or it's great, can you add a beard though , or other agencies charge much lesser. Submit your meaningless business jargon to be used on the site! give us a complimentary logo along with the website, nor can the black be darker can you please send me the design specs again?. I love it, but can you invert all colors? we need to make the new version clean and sexy low resolution? It looks ok on my screen, for can you use a high definition screenshot or can you use a high definition screenshot we are a big name to have in your portfolio can we have another option. Can we try some other colours maybe. You can get my logo from facebook use a kpop logo that's not a kpop logo! ugh we need more images of groups of people having non-specific types of fun. I'll pay you in a week we don't need to pay upfront i hope you understand will royalties in the company do instead of cash, but just do what you think. I trust you can we have another option, but can it handle a million in one go nor there is too much white space thats not what i saw in my head at all. There are more projects lined up charge extra the next time can you help me out? you will get a lot of free exposure doing this. Just do what you think. I trust you. Low resolution? It looks ok on my screen can you make it look more designed so that's going to be a chunk of change, so in an ideal world. In an ideal world can you make the font bigger? and could you do an actual logo instead of a font. Doing some work for us "pro bono" will really add to your portfolio i promise this turned out different that i decscribed it looks a bit empty, try to make everything bigger, yet you can get my logo from facebook nor the flier should feel like a warm handshake there are more projects lined up charge extra the next time we are a startup. Can you punch up the fun level on these icons doing some work for us "pro bono" will really add to your portfolio i promise. Make it sexy. Can you please send me the design specs again? can you make it more infographic-y can you please send me the design specs again?, nor try a more powerful colour can you pimp this powerpoint, need more geometry patterns yet doing some work for us "pro bono" will really add to your portfolio i promise but I need a website. How much will it cost. Can we try some other colours maybe can we try some other colours maybe we are a non-profit organization can you make the logo bigger yes bigger bigger still the logo is too big this is just a 5 minutes job can it handle a million in one go is this the best we can do. I know you've made thirty iterations but can we go back to the first one that was the best version can you make the font bigger?. Needs to be sleeker remember, everything is the same or better nor can it be more retro, but make it pop.
+We are your relatives can you rework to make the pizza look more delicious can you make it look more designed there are more projects lined up charge extra the next time. Use a kpop logo that's not a kpop logo! ugh the website doesn't have the theme i was going for yet it looks a bit empty, try to make everything bigger labrador. I really like the colour but can you change it what is a hamburger menu, I need a website. How much will it cost. Use a kpop logo that's not a kpop logo! ugh submit your meaningless business jargon to be used on the site!, what is a hamburger menu i was wondering if my cat could be placed over the logo in the flyer. Anyway, you are the designer, you know what to do this looks perfect. Just Photoshop out the dog, add a baby, and make the curtains blue can you turn it around in photoshop so we can see more of the front submit your meaningless business jargon to be used on the site! could you move it a tad to the left, thanks for taking the time to make the website, but i already made it in wix so is there a way we can make the page feel more introductory without being cheesy. Do less with more. You are lucky to even be doing this for us can you punch up the fun level on these icons the flier should feel like a warm handshake. I have an awesome idea for a startup, i need you to build it for me this is just a 5 minutes job, and the hair is just too polarising can you turn it around in photoshop so we can see more of the front. Submit your meaningless business jargon to be used on the site! needs to be sleeker make it pop this red is too red so remember, everything is the same or better this red is too red nor the website doesn't have the theme i was going for. I need a website. How much will it cost it needs to be the same, but totally different yet the website doesn't have the theme i was going for but I need a website. How much will it cost can you turn it around in photoshop so we can see more of the front. The target audience is makes and famles aged zero and up can you make the blue bluer? can you lower the price for the website? make it high quality and please use html can you make the font a bit bigger and change it to times new roman? jazz it up a little bit make the picture of the cupcake look delicious make the purple more well, purple-er it looks so empty add some more hearts can you add a bit of pastel pink and baby blue because the purple alone looks too fancy okay can you put a cute quote on the right side of the site? oh no it looks messed up! i think we need to start from scratch for i'll know it when i see it but I need a website. How much will it cost, thats not what i saw in my head at all. Is there a way we can make the page feel more introductory without being cheesy can it handle a million in one go nor I think we need to start from scratch, yet can you make the font bigger?. Could you do an actual logo instead of a font we need more images of groups of people having non-specific types of fun can it be more retro we need more images of groups of people having non-specific types of fun, nor can't you just take a picture from the internet?. We need more images of groups of people having non-specific types of fun we need more images of groups of people having non-specific types of fun, so other agencies charge much lesser make it look like Apple. There are more projects lined up charge extra the next time can you make it stand out more? and im not sure, try something else is there a way we can make the page feel more introductory without being cheesy. Submit your meaningless business jargon to be used on the site! other agencies charge much lesser, and could you move it a tad to the left, start on it today and we will talk about what i want next time for can you punch up the fun level on these icons concept is bang on, but can we look at a better execution. Will royalties in the company do instead of cash concept is bang on, but can we look at a better execution, yet start on it today and we will talk about what i want next time could you rotate the picture to show the other side of the room? we don't need a backup, it never goes down! give us a complimentary logo along with the website. Can you put "find us on facebook" by the facebook logo? can you lower the price for the website? make it high quality and please use html can you make the font a bit bigger and change it to times new roman? jazz it up a little bit make the picture of the cupcake look delicious make the purple more well, purple-er it looks so empty add some more hearts can you add a bit of pastel pink and baby blue because the purple alone looks too fancy okay can you put a cute quote on the right side of the site? oh no it looks messed up! i think we need to start from scratch or we don't need a backup, it never goes down!. We don't need a backup, it never goes down! needs to be sleeker, for can my website be in english? mmm, exactly like that, but different and can you pimp this powerpoint, need moLine truncated
+Could you solutionize that for me that will be a conversation piece that will be a conversation piece, can you make it more infographic-y other agencies charge much lesser, nor theres all this spanish text on my site can you make it look like this clipart i found. Can you rework to make the pizza look more delicious needs to be sleeker. Can you pimp this powerpoint, need more geometry patterns can we have another option, yet I really think this could go viral I got your invoice...it seems really high, why did you charge so much. Can you lower the price for the website? make it high quality and please use html can you make the font a bit bigger and change it to times new roman? jazz it up a little bit make the picture of the cupcake look delicious make the purple more well, purple-er it looks so empty add some more hearts can you add a bit of pastel pink and baby blue because the purple alone looks too fancy okay can you put a cute quote on the right side of the site? oh no it looks messed up! i think we need to start from scratch are you busy this weekend? I have a new project with a tight deadline i'll pay you in a week we don't need to pay upfront i hope you understand I think we need to start from scratch, nor could you solutionize that for me. That's great, but we need to add this 2000 line essay I got your invoice...it seems really high, why did you charge so much, I got your invoice...it seems really high, why did you charge so much, or we need to make the new version clean and sexy nor make it pop yet try a more powerful colour.
+We don't need a backup, it never goes down! remember, everything is the same or better the target audience is makes and famles aged zero and up, but I need a website. How much will it cost can you make the logo bigger yes bigger bigger still the logo is too big yet make it original. We don't need a contract, do we we don't need a contract, do we that will be a conversation piece nor make it sexy, for we are a big name to have in your portfolio, yet can you punch up the fun level on these icons. Could you move it a tad to the left we are a non-profit organization that's great, but can you make it work for ie 2 please, for do less with more nor anyway, you are the designer, you know what to do, yet can you rework to make the pizza look more delicious. I was wondering if my cat could be placed over the logo in the flyer i cant pay you . Anyway, you are the designer, you know what to do can you make pink a little more pinkish, so this was not according to brief I have printed it out, but the animated gif is not moving. I really like the colour but can you change it thats not what i saw in my head at all or we exceed the clients' expectations can you put "find us on facebook" by the facebook logo?. Mmm, exactly like that, but different you can get my logo from facebook something summery; colourful, and we are a startup i cant pay you . Can't you just take a picture from the internet? can you rework to make the pizza look more delicious, for needs to be sleeker we don't need a contract, do we can you make it stand out more? can you put "find us on facebook" by the facebook logo?. Can my website be in english? is this the best we can do, for this is just a 5 minutes job what is a hamburger menu for make it original, but can it handle a million in one go. The hair is just too polarising can you please change the color theme of the website to pink and purple? make the logo a bit smaller because the logo is too big can you link the icons to my social media accounts? oh and please put pictures of cats everywhere. You can get my logo from facebook can you make it faster? make it sexy, so I have printed it out, but the animated gif is not moving we need more images of groups of people having non-specific types of fun, that's great, but can you make it work for ie 2 please there is too much white space. The target audience is makes and famles aged zero and up in an ideal world or can we have another option can my website be in english?, so we are your relatives can you make it look like this clipart i found. Im not sure, try something else. Is there a way we can make the page feel more introductory without being cheesy we have big contacts we will promote you. Can we have another option try a more powerful colour, yet thats not what i saw in my head at all can you pimp this powerpoint, need more geometry patterns we need more images of groups of people having non-specific types of fun start on it today and we will talk about what i want next time . This turned out different that i decscribed we are a big name to have in your portfolio, but can it handle a million in one go so the hair is just too polarising, nor that's going to be a chunk of change so that sandwich needs to be more playful can you make it pop. We try your eye, but can you change everything? I really like the colour but can you change it I know somebody who can do this for a reasonable cost I need a website. How much will it cost anyway, you are the designer, you know what to do, for is there a way we can make the page feel more introductory without being cheesy. Can my website be in english? can you turn it around in photoshop so we can see more of the front can you help me out? you will get a lot of free exposure doing this can you turn it around in photoshop so we can see more of the front can't you just take a picture from the internet?, use a kpop logo that's not a kpop logo! ugh you are lucky to even be doing this for us. I cant pay you can't you just take a picture from the internet? but try making it a bit less blah. It looks a bit empty, try to make everything bigger what you've given us is texty, we want sexy for can you make it look more designed can you punch up the fun level on these icons can you help me out? you will get a lot of free exposure doing this. Remember, everything is the same or better we have big contacts we will promote you, for use a kpop logo that's not a kpop logo! ugh.
+I'll pay you in a week we don't need to pay upfront i hope you understand what is a hamburger menu and could you do an actual logo instead of a font, or is there a way we can make the page feel more introductory without being cheesy or I think we need to start from scratch, and anyway, you are the designer, you know what to do. Thats not what i saw in my head at all this red is too red try a more powerful colour concept is bang on, but can we look at a better execution give us a complimentary logo along with the website, I like it, but can the snow look a little warmer. Could you move it a tad to the left needs to be sleeker can my website be in english? this turned out different that i decscribed we need more images of groups of people having non-specific types of fun. Mmm, exactly like that, but different we are a non-profit organization can't you just take a picture from the internet? can you make it more infographic-y so I think we need to start from scratch make it pop. This turned out different that i decscribed doing some work for us "pro bono" will really add to your portfolio i promise. Im not sure, try something else i'll pay you in a week we don't need to pay upfront i hope you understand.
+Is this the best we can do something summery; colourful, but mmm, exactly like that, but different. Doing some work for us "pro bono" will really add to your portfolio i promise i'll pay you in a week we don't need to pay upfront i hope you understand can you make the font bigger? can you turn it around in photoshop so we can see more of the front, yet could you do an actual logo instead of a font. Is there a way we can make the page feel more introductory without being cheesy this looks perfect. Just Photoshop out the dog, add a baby, and make the curtains blue, and labrador make it original low resolution? It looks ok on my screen. Could you rotate the picture to show the other side of the room?. Make it pop that's great, but can you make it work for ie 2 please make it pop i'll pay you in a week we don't need to pay upfront i hope you understand. Give us a complimentary logo along with the website. This was not according to brief will royalties in the company do instead of cash for can you put "find us on facebook" by the facebook logo?. I like it, but can the snow look a little warmer thanks for taking the time to make the website, but i already made it in wix can you make pink a little more pinkish can you make it look more designed , can you punch up the fun level on these icons or could you do an actual logo instead of a font. Make it original. We need more images of groups of people having non-specific types of fun can't you just take a picture from the internet? you are lucky to even be doing this for us nor that's going to be a chunk of change and I have an awesome idea for a startup, i need you to build it for me what you've given us is texty, we want sexy. I really think this could go viral can you make the logo bigger yes bigger bigger still the logo is too big or is there a way we can make the page feel more introductory without being cheesy I have printed it out, but the animated gif is not moving, or can you make the blue bluer?. Can you pimp this powerpoint, need more geometry patterns. Needs to be sleeker that's great, but we need to add this 2000 line essay that's great, but can you make it work for ie 2 please give us a complimentary logo along with the website. I like it, but can the snow look a little warmer that sandwich needs to be more playful, so can you lower the price for the website? make it high quality and please use html can you make the font a bit bigger and change it to times new roman? jazz it up a little bit make the picture of the cupcake look delicious make the purple more well, purple-er it looks so empty add some more hearts can you add a bit of pastel pink and baby blue because the purple alone looks too fancy okay can you put a cute quote on the right side of the site? oh no it looks messed up! i think we need to start from scratch. Remember, everything is the same or better could you move it a tad to the left. I'll know it when i see it could you do an actual logo instead of a font, and can we barter services? or can you make pink a little more pinkish. Are you busy this weekend? I have a new project with a tight deadline. Can we have another option what is a hamburger menu. Needs to be sleeker thanks for taking the time to make the website, but i already made it in wix so just do what you think. I trust you, yet can you use a high definition screenshot and needs to be sleeker, nor can you help me out? you will get a lot of free exposure doing this. You can get my logo from facebook i cant pay you can you make pink a little more pinkish other agencies charge much lesser this red is too red but in an ideal world. Can you make it more infographic-y this red is too red can you make it pop. Can you make the font bigger? make it pop and can we try some other colours maybe. I like it, but can the snow look a little warmer you can get my logo from facebook but can you make it faster? yet will royalties in the company do instead of cash the target audience is makes and famles aged zero and up. Can't you just take a picture from the internet? can you please send me the design specs again?, so can you help me out? you will get a lot of free exposure doing this nor that sandwich needs to be more playful this turned out different that i decscribed. We don't need a backup, it never goes down! can you lower the price for the website? make it high quality and please use html can you make the font a bit bigger and change it to times new roman? jazz it up a little bit make the picture of the cupcake look delicious make the purple more well, purple-er it looks so empty add some more hearts can you add a bit of pastel pink and baby blue because the purple alone looks too fancy okay can you put a cute quote on the right side of the site? oh no it looks messed up! i think we need to start from scratch.

examples/others/word_counter/ex6.txt

@@ -0,0 +1,14 @@
+Breathe in your fears. Face them. To conquer fear, you must become fear. You must bask in the fear of other men. And men fear most what they cannot see. You have to become a terrible thought. A wraith. You have to become an idea! Feel terror cloud your senses. Feel its power to distort. To control. And know that this power can be yours. Embrace your worst fear. Become one with the darkness.
+You wanna know how I got these scars? My father was... a drinker, and a fiend. And one night, he goes off crazier than usual. Mommy gets the kitchen knife to defend herself. He doesn't like that, not one bit. So, me watching he takes the knife to her, laughing while he does it. He turns to me and he says: "Why so serious?". He comes at me with the knife "Why so serious?". He sticks the blade in my mouth. "Let's put a smile on that face." and... Why so serious?
+My name is Merely Ducard but I speak for Ra's al Ghul... a man greatly feared by the criminal underworld. A mon who can offer you a path. Someone like you is only here by choice. You have been exploring the criminal fraternity but whatever your original intentions you have to become truly lost. The path of a man who shares his hatred of evil and wishes to serve true justice. The path of the League of Shadows.
+Every man who has lotted here over the centuries, has looked up to the light and imagined climbing to freedom. So easy, so simple! And like shipwrecked men turning to seawater foregoing uncontrollable thirst, many have died trying. And then here there can be no true despair without hope. So as I terrorize Gotham, I will feed its people hope to poison their souls. I will let them believe that they can survive so that you can watch them climbing over each other to stay in the sun. You can watch me torture an entire city. And then when you've truly understood the depth of your failure, we will fulfill Ra's Al Ghul's destiny. We will destroy Gotham. And then, when that is done, and Gotham is... ashes Then you have my permission to die.
+But we've met before. That was a long time ago, I was a kid at St. Swithin's, It used to be funded by the Wayne Foundation. It's an orphanage. My mum died when I was small, it was a car accident. I don't remember it. My dad got shot a couple of years later for a gambling debt. Oh I remember that one just fine. Not a lot of people know what it feels like to be angry in your bones. I mean they understand. The fosters parents. Everybody understands, for a while. Then they want the angry little kid to do something he knows he can't do, move on. After a while they stop understanding. They send the angry kid to a boy's home, I figured it out too late. Yeah I learned to hide the anger, and practice smiling in the mirror. It's like putting on a mask. So you showed up this one day, in a cool car, pretty girl on your arm. We were so excited! Bruce Wayne, a billionaire orphan? We used to make up stories about you man, legends and you know with the other kids, that's all it was, just stories, but right when I saw you, I knew who you really were. I'd seen that look on your face before. It's the same one I taught myself. I don't why you took the fault for Dent's murder but I'm still a believer in the Batman. Even if you're not...
+You wanna know how I got them? So I had a wife. She was beautiful, like you, who tells me I worry too much, who tells me I ought to smile more, who gambles and gets in deep with the sharks. Hey. One day they carve her face. And we have no money for surgeries. She can't take it. I just wanna see her smile again. I just want her to know that I don't care about the scars. So, I do this to myself. And you know what? She can't stand the sight of me. She leaves. Now I see the funny side. Now I'm always smiling.
+Every year, I took a holiday. I went to Florence, this cafe on the banks of the Arno. Every fine evening, I would sit there and order a Fernet Branca. I had this fantasy, that I would look across the tables and I would see you there with a wife maybe a couple of kids. You wouldn't say anything to me, nor me to you. But we would both know that you've made it, that you were happy. I never wanted you to come back to Gotham. I always knew there was nothing here for you except pain and tragedy and I wanted something more for you than that. I still do.
+Breathe in your fears. Face them. To conquer fear, you must become fear. You must bask in the fear of other men. And men fear most what they cannot see. You have to become a terrible thought. A wraith. You have to become an idea! Feel terror cloud your senses. Feel its power to distort. To control. And know that this power can be yours. Embrace your worst fear. Become one with the darkness.
+You wanna know how I got these scars? My father was... a drinker, and a fiend. And one night, he goes off crazier than usual. Mommy gets the kitchen knife to defend herself. He doesn't like that, not one bit. So, me watching he takes the knife to her, laughing while he does it. He turns to me and he says: "Why so serious?". He comes at me with the knife "Why so serious?". He sticks the blade in my mouth. "Let's put a smile on that face." and... Why so serious?
+My name is Merely Ducard but I speak for Ra's al Ghul... a man greatly feared by the criminal underworld. A mon who can offer you a path. Someone like you is only here by choice. You have been exploring the criminal fraternity but whatever your original intentions you have to become truly lost. The path of a man who shares his hatred of evil and wishes to serve true justice. The path of the League of Shadows.
+Every man who has lotted here over the centuries, has looked up to the light and imagined climbing to freedom. So easy, so simple! And like shipwrecked men turning to seawater foregoing uncontrollable thirst, many have died trying. And then here there can be no true despair without hope. So as I terrorize Gotham, I will feed its people hope to poison their souls. I will let them believe that they can survive so that you can watch them climbing over each other to stay in the sun. You can watch me torture an entire city. And then when you've truly understood the depth of your failure, we will fulfill Ra's Al Ghul's destiny. We will destroy Gotham. And then, when that is done, and Gotham is... ashes Then you have my permission to die.
+But we've met before. That was a long time ago, I was a kid at St. Swithin's, It used to be funded by the Wayne Foundation. It's an orphanage. My mum died when I was small, it was a car accident. I don't remember it. My dad got shot a couple of years later for a gambling debt. Oh I remember that one just fine. Not a lot of people know what it feels like to be angry in your bones. I mean they understand. The fosters parents. Everybody understands, for a while. Then they want the angry little kid to do something he knows he can't do, move on. After a while they stop understanding. They send the angry kid to a boy's home, I figured it out too late. Yeah I learned to hide the anger, and practice smiling in the mirror. It's like putting on a mask. So you showed up this one day, in a cool car, pretty girl on your arm. We were so excited! Bruce Wayne, a billionaire orphan? We used to make up stories about you man, legends and you know with the other kids, that's all it was, just stories, but right when I saw you, I knew who you really were. I'd seen that look on your face before. It's the same one I taught myself. I don't why you took the fault for Dent's murder but I'm still a believer in the Batman. Even if you're not...
+You wanna know how I got them? So I had a wife. She was beautiful, like you, who tells me I worry too much, who tells me I ought to smile more, who gambles and gets in deep with the sharks. Hey. One day they carve her face. And we have no money for surgeries. She can't take it. I just wanna see her smile again. I just want her to know that I don't care about the scars. So, I do this to myself. And you know what? She can't stand the sight of me. She leaves. Now I see the funny side. Now I'm always smiling.
+Every year, I took a holiday. I went to Florence, this cafe on the banks of the Arno. Every fine evening, I would sit there and order a Fernet Branca. I had this fantasy, that I would look across the tables and I would see you there with a wife maybe a couple of kids. You wouldn't say anything to me, nor me to you. But we would both know that you've made it, that you were happy. I never wanted you to come back to Gotham. I always knew there was nothing here for you except pain and tragedy and I wanted something more for you than that. I still do.

src/cmc/deque.h

@@ -8,16 +8,34 @@
  *
  */
 
-/*****************************************************************************/
-/********************************************************************* DEQUE */
-/*****************************************************************************/
+/**
+ * Deque
+ *
+ * A Deque (double-ended queue) is a linear data structure that is able to add
+ * or remove elements from both ends. It can also be thought of a double-ended
+ * stack since you can push and pop elements from two ends. The Deque can also
+ * be used as a Queue.
+ *
+ * There is no random access for a Deque. The only elements accessible are the
+ * front element and the back.
+ *
+ * Implementation
+ *
+ * This implementation uses a circular buffer (ring buffer or cyclic buffer) in
+ * order to operate on O(1) for push and pop on either ends (only case where it
+ * takes longer than O(1) is when the buffer is reallocated). If it was
+ * implemented as a regular array, adding or removing elements from the front
+ * would take O(N) due to the need to shift all elements in the deque.
+ */
 
 #ifndef CMC_DEQUE_H
 #define CMC_DEQUE_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #define DEQUE_GENERATE(PFX, SNAME, FMOD, V)    \
     DEQUE_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
@@ -102,6 +120,8 @@
     FMOD bool PFX##_full(SNAME *_deque_);                                         \
     FMOD size_t PFX##_count(SNAME *_deque_);                                      \
     FMOD size_t PFX##_capacity(SNAME *_deque_);                                   \
+    /* Collection Utility */                                                      \
+    FMOD cmc_string PFX##_to_string(SNAME *_deque_);                              \
                                                                                   \
     /* Iterator Functions */                                                      \
     /* Iterator Allocation and Deallocation */                                    \
@@ -327,6 +347,18 @@
         return _deque_->capacity;                                                                           \
     }                                                                                                       \
                                                                                                             \
+    FMOD cmc_string PFX##_to_string(SNAME *_deque_)                                                         \
+    {                                                                                                       \
+        cmc_string str;                                                                                     \
+        SNAME *d_ = _deque_;                                                                                \
+        const char *name = #SNAME;                                                                          \
+                                                                                                            \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_deque,                                               \
+                 name, d_, d_->buffer, d_->capacity, d_->count, d_->front, d_->back);                       \
+                                                                                                            \
+        return str;                                                                                         \
+    }                                                                                                       \
+                                                                                                            \
     FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                                                        \
     {                                                                                                       \
         SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                                                  \

src/cmc/hashmap.h

@@ -8,26 +8,32 @@
  *
  */
 
-/*****************************************************************************/
-/******************************************************************* HASHMAP */
-/*****************************************************************************/
+/**
+ * HashMap
+ *
+ * A HashMap is an implementation of a Map with unique keys, where every key is
+ * mapped to a value. The keys are not sorted. It is implemented as a hashtable
+ * with robin hood hashing.
+ */
 
 #ifndef CMC_HASHMAP_H
 #define CMC_HASHMAP_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #ifndef CMC_HASH_TABLE_SETUP
 #define CMC_HASH_TABLE_SETUP
 
-typedef enum EntryState_e
+typedef enum cmc_entry_state_e
 {
-    ES_DELETED = -1,
-    ES_EMPTY = 0,
-    ES_FILLED = 1
-} EntryState;
+    CMC_ES_DELETED = -1,
+    CMC_ES_EMPTY = 0,
+    CMC_ES_FILLED = 1
+} cmc_entry_state;
 
 static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                                               3067, 6143, 12289, 24571, 49157,
@@ -118,7 +124,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         size_t dist;                                                                              \
                                                                                                   \
         /* The sate of this node (DELETED, EMPTY, FILLED) */                                      \
-        enum EntryState_e state;                                                                  \
+        enum cmc_entry_state_e state;                                                             \
                                                                                                   \
     } SNAME##_entry, *SNAME##_entry_ptr;                                                          \
                                                                                                   \
@@ -155,6 +161,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
     FMOD void PFX##_free(SNAME *_map_);                                                           \
     /* Collection Input and Output */                                                             \
     FMOD bool PFX##_insert(SNAME *_map_, K key, V value);                                         \
+    FMOD bool PFX##_update(SNAME *_map_, K key, V new_value);                                     \
     FMOD bool PFX##_remove(SNAME *_map_, K key, V *value);                                        \
     /* Conditional Input and Output */                                                            \
     FMOD bool PFX##_insert_if(SNAME *_map_, K key, V value, bool condition);                      \
@@ -169,6 +176,8 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
     FMOD bool PFX##_empty(SNAME *_map_);                                                          \
     FMOD size_t PFX##_count(SNAME *_map_);                                                        \
     FMOD size_t PFX##_capacity(SNAME *_map_);                                                     \
+    /* Collection Utility */                                                                      \
+    FMOD cmc_string PFX##_to_string(SNAME *_map_);                                                \
                                                                                                   \
     /* Iterator Functions */                                                                      \
     /* Iterator Allocation and Deallocation */                                                    \
@@ -225,6 +234,10 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         if (capacity == 0 || load <= 0 || load >= 1)                                             \
             return NULL;                                                                         \
                                                                                                  \
+        /* Prevent integer overflow */                                                           \
+        if (capacity >= UINTMAX_MAX * load)                                                      \
+            return NULL;                                                                         \
+                                                                                                 \
         size_t real_capacity = PFX##_impl_calculate_size(capacity / load);                       \
                                                                                                  \
         SNAME *_map_ = malloc(sizeof(SNAME));                                                    \
@@ -284,12 +297,12 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         if (PFX##_impl_get_entry(_map_, key) != NULL)                                            \
             return false;                                                                        \
                                                                                                  \
-        if (target->state == ES_EMPTY || target->state == ES_DELETED)                            \
+        if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)                    \
         {                                                                                        \
             target->key = key;                                                                   \
             target->value = value;                                                               \
             target->dist = original_pos - pos;                                                   \
-            target->state = ES_FILLED;                                                           \
+            target->state = CMC_ES_FILLED;                                                       \
         }                                                                                        \
         else                                                                                     \
         {                                                                                        \
@@ -298,12 +311,12 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                 pos++;                                                                           \
                 target = &(_map_->buffer[pos % _map_->capacity]);                                \
                                                                                                  \
-                if (target->state == ES_EMPTY || target->state == ES_DELETED)                    \
+                if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)            \
                 {                                                                                \
                     target->key = key;                                                           \
                     target->value = value;                                                       \
                     target->dist = pos - original_pos;                                           \
-                    target->state = ES_FILLED;                                                   \
+                    target->state = CMC_ES_FILLED;                                               \
                                                                                                  \
                     break;                                                                       \
                 }                                                                                \
@@ -329,6 +342,18 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         return true;                                                                             \
     }                                                                                            \
                                                                                                  \
+    FMOD bool PFX##_update(SNAME *_map_, K key, V new_value)                                     \
+    {                                                                                            \
+        SNAME##_entry *entry = PFX##_impl_get_entry(_map_, key);                                 \
+                                                                                                 \
+        if (!entry)                                                                              \
+            return false;                                                                        \
+                                                                                                 \
+        entry->value = new_value;                                                                \
+                                                                                                 \
+        return true;                                                                             \
+    }                                                                                            \
+                                                                                                 \
     FMOD bool PFX##_remove(SNAME *_map_, K key, V *value)                                        \
     {                                                                                            \
         SNAME##_entry *result = PFX##_impl_get_entry(_map_, key);                                \
@@ -341,7 +366,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         result->key = PFX##_impl_default_key();                                                  \
         result->value = PFX##_impl_default_value();                                              \
         result->dist = 0;                                                                        \
-        result->state = ES_DELETED;                                                              \
+        result->state = CMC_ES_DELETED;                                                          \
                                                                                                  \
         _map_->count--;                                                                          \
                                                                                                  \
@@ -460,6 +485,18 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         return _map_->capacity;                                                                  \
     }                                                                                            \
                                                                                                  \
+    FMOD cmc_string PFX##_to_string(SNAME *_map_)                                                \
+    {                                                                                            \
+        cmc_string str;                                                                          \
+        SNAME *m_ = _map_;                                                                       \
+        const char *name = #SNAME;                                                               \
+                                                                                                 \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_hashmap,                                  \
+                 name, m_, m_->buffer, m_->capacity, m_->count, m_->load, m_->cmp, m_->hash);    \
+                                                                                                 \
+        return str;                                                                              \
+    }                                                                                            \
+                                                                                                 \
     FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                                             \
     {                                                                                            \
         SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                                       \
@@ -489,7 +526,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         {                                                                                        \
             for (size_t i = 0; i < target->capacity; i++)                                        \
             {                                                                                    \
-                if (target->buffer[i].state == ES_FILLED)                                        \
+                if (target->buffer[i].state == CMC_ES_FILLED)                                    \
                 {                                                                                \
                     iter->first = i;                                                             \
                     break;                                                                       \
@@ -500,7 +537,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                                                                                                  \
             for (size_t i = target->capacity; i > 0; i--)                                        \
             {                                                                                    \
-                if (target->buffer[i - 1].state == ES_FILLED)                                    \
+                if (target->buffer[i - 1].state == CMC_ES_FILLED)                                \
                 {                                                                                \
                     iter->last = i - 1;                                                          \
                     break;                                                                       \
@@ -556,7 +593,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
             iter->cursor++;                                                                      \
             scan = &(iter->target->buffer[iter->cursor]);                                        \
                                                                                                  \
-            if (scan->state == ES_FILLED)                                                        \
+            if (scan->state == CMC_ES_FILLED)                                                    \
                 break;                                                                           \
         }                                                                                        \
                                                                                                  \
@@ -586,7 +623,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
             iter->cursor--;                                                                      \
             scan = &(iter->target->buffer[iter->cursor]);                                        \
                                                                                                  \
-            if (scan->state == ES_FILLED)                                                        \
+            if (scan->state == CMC_ES_FILLED)                                                    \
                 break;                                                                           \
         }                                                                                        \
                                                                                                  \
@@ -667,7 +704,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                                                                                                  \
         SNAME##_entry *target = &(_map_->buffer[pos]);                                           \
                                                                                                  \
-        while (target->state == ES_FILLED || target->state == ES_DELETED)                        \
+        while (target->state == CMC_ES_FILLED || target->state == CMC_ES_DELETED)                \
         {                                                                                        \
             if (_map_->cmp(target->key, key) == 0)                                               \
                 return target;                                                                   \

src/cmc/hashset.h

@@ -8,26 +8,31 @@
  *
  */
 
-/*****************************************************************************/
-/******************************************************************* HASHSET */
-/*****************************************************************************/
+/**
+ * HashSet
+ *
+ * A HashSet is an implementation of a Set with unique keys. The keys are not
+ * sorted. It is implemented as a hashtable with robin hood hashing.
+ */
 
 #ifndef CMC_HASHSET_H
 #define CMC_HASHSET_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #ifndef CMC_HASH_TABLE_SETUP
 #define CMC_HASH_TABLE_SETUP
 
-typedef enum EntryState_e
+typedef enum cmc_entry_state_e
 {
-    ES_DELETED = -1,
-    ES_EMPTY = 0,
-    ES_FILLED = 1
-} EntryState;
+    CMC_ES_DELETED = -1,
+    CMC_ES_EMPTY = 0,
+    CMC_ES_FILLED = 1
+} cmc_entry_state;
 
 static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                                               3067, 6143, 12289, 24571, 49157,
@@ -114,7 +119,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         size_t dist;                                                                              \
                                                                                                   \
         /* The sate of this node (DELETED, EMPTY, FILLED) */                                      \
-        enum EntryState_e state;                                                                  \
+        enum cmc_entry_state_e state;                                                             \
                                                                                                   \
     } SNAME##_entry, *SNAME##_entry_ptr;                                                          \
                                                                                                   \
@@ -163,6 +168,8 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
     FMOD bool PFX##_empty(SNAME *_set_);                                                          \
     FMOD size_t PFX##_count(SNAME *_set_);                                                        \
     FMOD size_t PFX##_capacity(SNAME *_set_);                                                     \
+    /* Collection Utility */                                                                      \
+    FMOD cmc_string PFX##_to_string(SNAME *_set_);                                                \
                                                                                                   \
     /* Set Operations */                                                                          \
     FMOD SNAME *PFX##_union(SNAME *_set1_, SNAME *_set2_);                                        \
@@ -218,6 +225,10 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         if (capacity == 0 || load <= 0 || load >= 1)                                             \
             return NULL;                                                                         \
                                                                                                  \
+        /* Prevent integer overflow */                                                           \
+        if (capacity >= UINTMAX_MAX * load)                                                      \
+            return NULL;                                                                         \
+                                                                                                 \
         size_t real_capacity = PFX##_impl_calculate_size(capacity / load);                       \
                                                                                                  \
         SNAME *_set_ = malloc(sizeof(SNAME));                                                    \
@@ -277,11 +288,11 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         if (PFX##_impl_get_entry(_set_, element) != NULL)                                        \
             return false;                                                                        \
                                                                                                  \
-        if (target->state == ES_EMPTY || target->state == ES_DELETED)                            \
+        if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)                    \
         {                                                                                        \
             target->value = element;                                                             \
             target->dist = pos - original_pos;                                                   \
-            target->state = ES_FILLED;                                                           \
+            target->state = CMC_ES_FILLED;                                                       \
         }                                                                                        \
         else                                                                                     \
         {                                                                                        \
@@ -290,11 +301,11 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                 pos++;                                                                           \
                 target = &(_set_->buffer[pos % _set_->capacity]);                                \
                                                                                                  \
-                if (target->state == ES_EMPTY || target->state == ES_DELETED)                    \
+                if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)            \
                 {                                                                                \
                     target->value = element;                                                     \
                     target->dist = pos - original_pos;                                           \
-                    target->state = ES_FILLED;                                                   \
+                    target->state = CMC_ES_FILLED;                                               \
                                                                                                  \
                     break;                                                                       \
                 }                                                                                \
@@ -326,7 +337,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                                                                                                  \
         result->value = PFX##_impl_default_value();                                              \
         result->dist = 0;                                                                        \
-        result->state = ES_DELETED;                                                              \
+        result->state = CMC_ES_DELETED;                                                          \
                                                                                                  \
         _set_->count--;                                                                          \
                                                                                                  \
@@ -411,12 +422,24 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         return _set_->capacity;                                                                  \
     }                                                                                            \
                                                                                                  \
+    FMOD cmc_string PFX##_to_string(SNAME *_set_)                                                \
+    {                                                                                            \
+        cmc_string str;                                                                          \
+        SNAME *s_ = _set_;                                                                       \
+        const char *name = #SNAME;                                                               \
+                                                                                                 \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_hashset,                                  \
+                 name, s_, s_->buffer, s_->capacity, s_->count, s_->load, s_->cmp, s_->hash);    \
+                                                                                                 \
+        return str;                                                                              \
+    }                                                                                            \
+                                                                                                 \
     FMOD SNAME *PFX##_union(SNAME *_set1_, SNAME *_set2_)                                        \
     {                                                                                            \
         SNAME *_set_r_ = PFX##_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);   \
                                                                                                  \
         if (!_set_r_)                                                                            \
-            return false;                                                                        \
+            return NULL;                                                                         \
                                                                                                  \
         SNAME##_iter iter1, iter2;                                                               \
         PFX##_iter_init(&iter1, _set1_);                                                         \
@@ -440,7 +463,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         SNAME *_set_r_ = PFX##_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);   \
                                                                                                  \
         if (!_set_r_)                                                                            \
-            return false;                                                                        \
+            return NULL;                                                                         \
                                                                                                  \
         SNAME *_set_A_ = _set1_->count < _set2_->count ? _set1_ : _set2_;                        \
         SNAME *_set_B_ = _set_A_ == _set1_ ? _set2_ : _set1_;                                    \
@@ -464,7 +487,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         SNAME *_set_r_ = PFX##_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);   \
                                                                                                  \
         if (!_set_r_)                                                                            \
-            return false;                                                                        \
+            return NULL;                                                                         \
                                                                                                  \
         SNAME##_iter iter;                                                                       \
         PFX##_iter_init(&iter, _set1_);                                                          \
@@ -487,7 +510,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         SNAME *_set_r_ = PFX##_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);   \
                                                                                                  \
         if (!_set_r_)                                                                            \
-            return false;                                                                        \
+            return NULL;                                                                         \
                                                                                                  \
         PFX##_iter_init(&iter1, _set1_);                                                         \
         PFX##_iter_init(&iter2, _set2_);                                                         \
@@ -644,7 +667,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
         {                                                                                        \
             for (size_t i = 0; i < target->capacity; i++)                                        \
             {                                                                                    \
-                if (target->buffer[i].state == ES_FILLED)                                        \
+                if (target->buffer[i].state == CMC_ES_FILLED)                                    \
                 {                                                                                \
                     iter->first = i;                                                             \
                     break;                                                                       \
@@ -655,7 +678,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                                                                                                  \
             for (size_t i = target->capacity; i > 0; i--)                                        \
             {                                                                                    \
-                if (target->buffer[i - 1].state == ES_FILLED)                                    \
+                if (target->buffer[i - 1].state == CMC_ES_FILLED)                                \
                 {                                                                                \
                     iter->last = i - 1;                                                          \
                     break;                                                                       \
@@ -708,7 +731,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                 iter->cursor++;                                                                  \
                 scan = &(iter->target->buffer[iter->cursor]);                                    \
                                                                                                  \
-                if (scan->state == ES_FILLED)                                                    \
+                if (scan->state == CMC_ES_FILLED)                                                \
                     break;                                                                       \
             }                                                                                    \
         }                                                                                        \
@@ -736,7 +759,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                 iter->cursor--;                                                                  \
                 scan = &(iter->target->buffer[iter->cursor]);                                    \
                                                                                                  \
-                if (scan->state == ES_FILLED)                                                    \
+                if (scan->state == CMC_ES_FILLED)                                                \
                     break;                                                                       \
             }                                                                                    \
         }                                                                                        \
@@ -800,7 +823,7 @@ static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
                                                                                                  \
         SNAME##_entry *target = &(_set_->buffer[pos]);                                           \
                                                                                                  \
-        while (target->state == ES_FILLED || target->state == ES_DELETED)                        \
+        while (target->state == CMC_ES_FILLED || target->state == CMC_ES_DELETED)                \
         {                                                                                        \
             if (_set_->cmp(target->value, element) == 0)                                         \
                 return target;                                                                   \

src/cmc/heap.h

@@ -8,22 +8,39 @@
  *
  */
 
-/*****************************************************************************/
-/********************************************************************** HEAP */
-/*****************************************************************************/
+/**
+ * Heap
+ *
+ * The Heap is a specialized tree-based data structure which is essentially a
+ * complete tree that satisfies the heap property:
+ *     - MaxHeap:
+ *         - The root node is the greatest element of the unique set of keys.
+ *         - A node key is always greater than or equal to its children keys.
+ *     - Minheap:
+ *         - The root node is the smallest element of the unique set of keys.
+ *         - A node Key is always greater than or equal to its children keys.
+ *
+ * The heap is mostly used to implement priority queues. Sometimes it can also
+ * be used to sort elements. There are three main functions:
+ *     - insert : Adds an element to the heap
+ *     - remove_(min/max): Removes the min/max element from the heap
+ *     - min/max : Accesses the min/max element from the heap
+ */
 
 #ifndef CMC_HEAP_H
 #define CMC_HEAP_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
-typedef enum HeapOrder
+typedef enum cmc_heap_order_e
 {
-    MaxHeap = 1,
-    MinHeap = -1
-} HeapOrder;
+    cmc_max_heap = 1,
+    cmc_min_heap = -1
+} cmc_heap_order;
 
 #define HEAP_GENERATE(PFX, SNAME, FMOD, V)    \
     HEAP_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
@@ -36,119 +53,118 @@ typedef enum HeapOrder
     HEAP_GENERATE_SOURCE(PFX, SNAME, FMOD, V)
 
 /* HEADER ********************************************************************/
-#define HEAP_GENERATE_HEADER(PFX, SNAME, FMOD, V)                               \
-                                                                                \
-    /* Heap Structure */                                                        \
-    typedef struct SNAME##_s                                                    \
-    {                                                                           \
-        /* Dynamic array of elements */                                         \
-        V *buffer;                                                              \
-                                                                                \
-        /* Current array capacity */                                            \
-        size_t capacity;                                                        \
-                                                                                \
-        /* Current amount of elements in the heap */                            \
-        size_t count;                                                           \
-                                                                                \
-        /* Heap order (MaxHeap or MinHeap) */                                   \
-        enum HeapOrder HO;                                                      \
-                                                                                \
-        /* Element comparison function */                                       \
-        int (*cmp)(V, V);                                                       \
-                                                                                \
-        /* Function that returns an iterator to the start of the heap */        \
-        struct SNAME##_iter_s (*it_start)(struct SNAME##_s *);                  \
-                                                                                \
-        /* Function that returns an iterator to the end of the heap */          \
-        struct SNAME##_iter_s (*it_end)(struct SNAME##_s *);                    \
-                                                                                \
-    } SNAME, *SNAME##_ptr;                                                      \
-                                                                                \
-    /* Heap Iterator */                                                         \
-    typedef struct SNAME##_iter_s                                               \
-    {                                                                           \
-        /* Target heap */                                                       \
-        struct SNAME##_s *target;                                               \
-                                                                                \
-        /* Cursor's position (index) */                                         \
-        size_t cursor;                                                          \
-                                                                                \
-        /* If the iterator has reached the start of the iteration */            \
-        bool start;                                                             \
-                                                                                \
-        /* If the iterator has reached the end of the iteration */              \
-        bool end;                                                               \
-                                                                                \
-    } SNAME##_iter, *SNAME##_iter_ptr;                                          \
-                                                                                \
-    /* Collection Functions */                                                  \
-    /* Collection Allocation and Deallocation */                                \
-    FMOD SNAME *PFX##_new(size_t capacity, HeapOrder HO, int (*compare)(V, V)); \
-    FMOD void PFX##_clear(SNAME *_heap_);                                       \
-    FMOD void PFX##_free(SNAME *_heap_);                                        \
-    /* Collection Input and Output */                                           \
-    FMOD bool PFX##_insert(SNAME *_heap_, V element);                           \
-    FMOD bool PFX##_remove(SNAME *_heap_, V *result);                           \
-    /* Conditional Input and Output */                                          \
-    FMOD bool PFX##_insert_if(SNAME *_heap_, V element, bool condition);        \
-    FMOD bool PFX##_remove_if(SNAME *_heap_, V *result, bool condition);        \
-    /* Element Access */                                                        \
-    FMOD V PFX##_peek(SNAME *_heap_);                                           \
-    FMOD V *PFX##_peek_ref(SNAME *_heap_);                                      \
-    /* Collection State */                                                      \
-    FMOD bool PFX##_contains(SNAME *_heap_, V element);                         \
-    FMOD bool PFX##_empty(SNAME *_heap_);                                       \
-    FMOD bool PFX##_full(SNAME *_heap_);                                        \
-    FMOD size_t PFX##_count(SNAME *_heap_);                                     \
-    FMOD size_t PFX##_capacity(SNAME *_heap_);                                  \
-                                                                                \
-    /* Iterator Functions */                                                    \
-    /* Iterator Allocation and Deallocation */                                  \
-    FMOD SNAME##_iter *PFX##_iter_new(SNAME *target);                           \
-    FMOD void PFX##_iter_free(SNAME##_iter *iter);                              \
-    /* Iterator Initialization */                                               \
-    FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target);               \
-    /* Iterator State */                                                        \
-    FMOD bool PFX##_iter_start(SNAME##_iter *iter);                             \
-    FMOD bool PFX##_iter_end(SNAME##_iter *iter);                               \
-    /* Iterator Movement */                                                     \
-    FMOD void PFX##_iter_to_start(SNAME##_iter *iter);                          \
-    FMOD void PFX##_iter_to_end(SNAME##_iter *iter);                            \
-    FMOD bool PFX##_iter_next(SNAME##_iter *iter);                              \
-    FMOD bool PFX##_iter_prev(SNAME##_iter *iter);                              \
-    /* Iterator Access */                                                       \
-    FMOD V PFX##_iter_value(SNAME##_iter *iter);                                \
-    FMOD size_t PFX##_iter_index(SNAME##_iter *iter);                           \
-                                                                                \
-    /* Default Value */                                                         \
-    static inline V PFX##_impl_default_value(void)                              \
-    {                                                                           \
-        V _empty_value_;                                                        \
-                                                                                \
-        memset(&_empty_value_, 0, sizeof(V));                                   \
-                                                                                \
-        return _empty_value_;                                                   \
-    }                                                                           \
-                                                                                \
+#define HEAP_GENERATE_HEADER(PFX, SNAME, FMOD, V)                                    \
+                                                                                     \
+    /* Heap Structure */                                                             \
+    typedef struct SNAME##_s                                                         \
+    {                                                                                \
+        /* Dynamic array of elements */                                              \
+        V *buffer;                                                                   \
+                                                                                     \
+        /* Current array capacity */                                                 \
+        size_t capacity;                                                             \
+                                                                                     \
+        /* Current amount of elements in the heap */                                 \
+        size_t count;                                                                \
+                                                                                     \
+        /* Heap order (MaxHeap or MinHeap) */                                        \
+        enum cmc_heap_order_e HO;                                                    \
+                                                                                     \
+        /* Element comparison function */                                            \
+        int (*cmp)(V, V);                                                            \
+                                                                                     \
+        /* Function that returns an iterator to the start of the heap */             \
+        struct SNAME##_iter_s (*it_start)(struct SNAME##_s *);                       \
+                                                                                     \
+        /* Function that returns an iterator to the end of the heap */               \
+        struct SNAME##_iter_s (*it_end)(struct SNAME##_s *);                         \
+                                                                                     \
+    } SNAME, *SNAME##_ptr;                                                           \
+                                                                                     \
+    /* Heap Iterator */                                                              \
+    typedef struct SNAME##_iter_s                                                    \
+    {                                                                                \
+        /* Target heap */                                                            \
+        struct SNAME##_s *target;                                                    \
+                                                                                     \
+        /* Cursor's position (index) */                                              \
+        size_t cursor;                                                               \
+                                                                                     \
+        /* If the iterator has reached the start of the iteration */                 \
+        bool start;                                                                  \
+                                                                                     \
+        /* If the iterator has reached the end of the iteration */                   \
+        bool end;                                                                    \
+                                                                                     \
+    } SNAME##_iter, *SNAME##_iter_ptr;                                               \
+                                                                                     \
+    /* Collection Functions */                                                       \
+    /* Collection Allocation and Deallocation */                                     \
+    FMOD SNAME *PFX##_new(size_t capacity, cmc_heap_order HO, int (*compare)(V, V)); \
+    FMOD void PFX##_clear(SNAME *_heap_);                                            \
+    FMOD void PFX##_free(SNAME *_heap_);                                             \
+    /* Collection Input and Output */                                                \
+    FMOD bool PFX##_insert(SNAME *_heap_, V element);                                \
+    FMOD bool PFX##_remove(SNAME *_heap_, V *result);                                \
+    /* Conditional Input and Output */                                               \
+    FMOD bool PFX##_insert_if(SNAME *_heap_, V element, bool condition);             \
+    FMOD bool PFX##_remove_if(SNAME *_heap_, V *result, bool condition);             \
+    /* Element Access */                                                             \
+    FMOD V PFX##_peek(SNAME *_heap_);                                                \
+    FMOD V *PFX##_peek_ref(SNAME *_heap_);                                           \
+    /* Collection State */                                                           \
+    FMOD bool PFX##_contains(SNAME *_heap_, V element);                              \
+    FMOD bool PFX##_empty(SNAME *_heap_);                                            \
+    FMOD bool PFX##_full(SNAME *_heap_);                                             \
+    FMOD size_t PFX##_count(SNAME *_heap_);                                          \
+    FMOD size_t PFX##_capacity(SNAME *_heap_);                                       \
+    /* Collection Utility */                                                         \
+    FMOD cmc_string PFX##_to_string(SNAME *_heap_);                                  \
+                                                                                     \
+    /* Iterator Functions */                                                         \
+    /* Iterator Allocation and Deallocation */                                       \
+    FMOD SNAME##_iter *PFX##_iter_new(SNAME *target);                                \
+    FMOD void PFX##_iter_free(SNAME##_iter *iter);                                   \
+    /* Iterator Initialization */                                                    \
+    FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target);                    \
+    /* Iterator State */                                                             \
+    FMOD bool PFX##_iter_start(SNAME##_iter *iter);                                  \
+    FMOD bool PFX##_iter_end(SNAME##_iter *iter);                                    \
+    /* Iterator Movement */                                                          \
+    FMOD void PFX##_iter_to_start(SNAME##_iter *iter);                               \
+    FMOD void PFX##_iter_to_end(SNAME##_iter *iter);                                 \
+    FMOD bool PFX##_iter_next(SNAME##_iter *iter);                                   \
+    FMOD bool PFX##_iter_prev(SNAME##_iter *iter);                                   \
+    /* Iterator Access */                                                            \
+    FMOD V PFX##_iter_value(SNAME##_iter *iter);                                     \
+    FMOD size_t PFX##_iter_index(SNAME##_iter *iter);                                \
+                                                                                     \
+    /* Default Value */                                                              \
+    static inline V PFX##_impl_default_value(void)                                   \
+    {                                                                                \
+        V _empty_value_;                                                             \
+                                                                                     \
+        memset(&_empty_value_, 0, sizeof(V));                                        \
+                                                                                     \
+        return _empty_value_;                                                        \
+    }                                                                                \
+                                                                                     \
 /* SOURCE ********************************************************************/
 #define HEAP_GENERATE_SOURCE(PFX, SNAME, FMOD, V)                                                 \
                                                                                                   \
     /* Implementation Detail Functions */                                                         \
     static bool PFX##_impl_grow(SNAME *_heap_);                                                   \
-    static size_t PFX##_impl_p(size_t index);                                                     \
-    static size_t PFX##_impl_l(size_t index);                                                     \
-    static size_t PFX##_impl_r(size_t index);                                                     \
     static bool PFX##_impl_float_up(SNAME *_heap_, size_t index);                                 \
     static bool PFX##_impl_float_down(SNAME *_heap_, size_t index);                               \
     static SNAME##_iter PFX##_impl_it_start(SNAME *_heap_);                                       \
     static SNAME##_iter PFX##_impl_it_end(SNAME *_heap_);                                         \
                                                                                                   \
-    FMOD SNAME *PFX##_new(size_t capacity, HeapOrder HO, int (*compare)(V, V))                    \
+    FMOD SNAME *PFX##_new(size_t capacity, cmc_heap_order HO, int (*compare)(V, V))               \
     {                                                                                             \
         if (capacity < 1)                                                                         \
             return NULL;                                                                          \
                                                                                                   \
-        if (HO != MinHeap && HO != MaxHeap)                                                       \
+        if (HO != cmc_min_heap && HO != cmc_max_heap)                                             \
             return NULL;                                                                          \
                                                                                                   \
         SNAME *_heap_ = malloc(sizeof(SNAME));                                                    \
@@ -198,7 +214,7 @@ typedef enum HeapOrder
                 return false;                                                                     \
         }                                                                                         \
                                                                                                   \
-        if (_heap_->count == 0)                                                                   \
+        if (PFX##_empty(_heap_))                                                                  \
         {                                                                                         \
             _heap_->buffer[_heap_->count++] = element;                                            \
             return true;                                                                          \
@@ -292,6 +308,19 @@ typedef enum HeapOrder
         return _heap_->capacity;                                                                  \
     }                                                                                             \
                                                                                                   \
+    FMOD cmc_string PFX##_to_string(SNAME *_heap_)                                                \
+    {                                                                                             \
+        cmc_string str;                                                                           \
+        SNAME *h_ = _heap_;                                                                       \
+        const char *name = #SNAME;                                                                \
+        const char *t = h_->HO == 1 ? "MaxHeap" : "MinHeap";                                      \
+                                                                                                  \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_heap,                                      \
+                 name, h_, h_->buffer, h_->capacity, h_->count, t, h_->cmp);                      \
+                                                                                                  \
+        return str;                                                                               \
+    }                                                                                             \
+                                                                                                  \
     FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                                              \
     {                                                                                             \
         SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                                        \
@@ -399,42 +428,27 @@ typedef enum HeapOrder
         return true;                                                                              \
     }                                                                                             \
                                                                                                   \
-    static size_t PFX##_impl_p(size_t index)                                                      \
-    {                                                                                             \
-        if (index == 0)                                                                           \
-            return 0;                                                                             \
-                                                                                                  \
-        return (index - 1) / 2;                                                                   \
-    }                                                                                             \
-                                                                                                  \
-    static size_t PFX##_impl_l(size_t index)                                                      \
-    {                                                                                             \
-        return 2 * index + 1;                                                                     \
-    }                                                                                             \
-                                                                                                  \
-    static size_t PFX##_impl_r(size_t index)                                                      \
-    {                                                                                             \
-        return 2 * index + 2;                                                                     \
-    }                                                                                             \
-                                                                                                  \
     static bool PFX##_impl_float_up(SNAME *_heap_, size_t index)                                  \
     {                                                                                             \
+        /* Current index */                                                                       \
         size_t C = index;                                                                         \
         V child = _heap_->buffer[C];                                                              \
-        V parent = _heap_->buffer[PFX##_impl_p(C)];                                               \
+        V parent = _heap_->buffer[(index - 1) / 2];                                               \
                                                                                                   \
         int mod = _heap_->HO;                                                                     \
                                                                                                   \
         while (C > 0 && _heap_->cmp(child, parent) * mod > 0)                                     \
         {                                                                                         \
+            /* Swap between C (current element) and its parent */                                 \
             V tmp = _heap_->buffer[C];                                                            \
-            _heap_->buffer[C] = _heap_->buffer[PFX##_impl_p(C)];                                  \
-            _heap_->buffer[PFX##_impl_p(C)] = tmp;                                                \
+            _heap_->buffer[C] = _heap_->buffer[(C - 1) / 2];                                      \
+            _heap_->buffer[(C - 1) / 2] = tmp;                                                    \
                                                                                                   \
-            C = PFX##_impl_p(C);                                                                  \
+            /* Go to parent */                                                                    \
+            C = (C - 1) / 2;                                                                      \
                                                                                                   \
             child = _heap_->buffer[C];                                                            \
-            parent = _heap_->buffer[PFX##_impl_p(C)];                                             \
+            parent = _heap_->buffer[(C - 1) / 2];                                                 \
         }                                                                                         \
                                                                                                   \
         return true;                                                                              \
@@ -446,10 +460,11 @@ typedef enum HeapOrder
                                                                                                   \
         while (index < _heap_->count)                                                             \
         {                                                                                         \
-            size_t L = PFX##_impl_l(index);                                                       \
-            size_t R = PFX##_impl_r(index);                                                       \
+            size_t L = 2 * index + 1;                                                             \
+            size_t R = 2 * index + 2;                                                             \
             size_t C = index;                                                                     \
                                                                                                   \
+            /* Determine if we swap with the left or right element */                             \
             if (L < _heap_->count && _heap_->cmp(_heap_->buffer[L], _heap_->buffer[C]) * mod > 0) \
             {                                                                                     \
                 C = L;                                                                            \
@@ -460,6 +475,7 @@ typedef enum HeapOrder
                 C = R;                                                                            \
             }                                                                                     \
                                                                                                   \
+            /* Swap only if either left or right was picked, otherwise done */                    \
             if (C != index)                                                                       \
             {                                                                                     \
                 V tmp = _heap_->buffer[index];                                                    \

src/cmc/linkedlist.h

@@ -8,16 +8,31 @@
  *
  */
 
-/*****************************************************************************/
-/**************************************************************** LINKEDLIST */
-/*****************************************************************************/
+/**
+ * LinkedList
+ *
+ * A LinkedList is a linear collection of elements, whose order is not given by
+ * their physical placement in memory. Instead, each element points to the next
+ * (singly-linked list) and to a previous one (doubly-linked list). It consists
+ * of nodes connected by these next or previous pointers. Unlike an array, the
+ * LinkedList can indefinitely grow.
+ *
+ * Implementation
+ *
+ * The LinkedList is implemented as a doubly-linked list and allows insertions
+ * and removals at both ends in O(1) and in a given index in O(N). The list has
+ * a head and tail pointer. The head points to the first element in the sequence
+ * and tail points to the last.
+ */
 
 #ifndef CMC_LINKEDLIST_H
 #define CMC_LINKEDLIST_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #define LINKEDLIST_GENERATE(PFX, SNAME, FMOD, V)    \
     LINKEDLIST_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
@@ -110,6 +125,8 @@
     FMOD bool PFX##_contains(SNAME *_list_, V element, int (*comparator)(V, V));     \
     FMOD bool PFX##_empty(SNAME *_list_);                                            \
     FMOD size_t PFX##_count(SNAME *_list_);                                          \
+    /* Collection Utility */                                                         \
+    FMOD cmc_string PFX##_to_string(SNAME *_list_);                                  \
                                                                                      \
     /* Node Related Functions */                                                     \
     /* Node Allocation and Deallocation */                                           \
@@ -443,6 +460,18 @@
         return _list_->count;                                                       \
     }                                                                               \
                                                                                     \
+    FMOD cmc_string PFX##_to_string(SNAME *_list_)                                  \
+    {                                                                               \
+        cmc_string str;                                                             \
+        SNAME *l_ = _list_;                                                         \
+        const char *name = #SNAME;                                                  \
+                                                                                    \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_linkedlist,                  \
+                 name, l_, l_->count, l_->head, l_->tail);                          \
+                                                                                    \
+        return str;                                                                 \
+    }                                                                               \
+                                                                                    \
     FMOD SNAME##_node *PFX##_new_node(V element)                                    \
     {                                                                               \
         SNAME##_node *_node_ = malloc(sizeof(SNAME##_node));                        \

src/cmc/list.h

@@ -8,16 +8,46 @@
  *
  */
 
-/*****************************************************************************/
-/********************************************************************** LIST */
-/*****************************************************************************/
+/**
+ * List
+ *
+ * A List is a Dynamic Array that store its elements contiguously. It has an
+ * internal buffer that is pre-allocated with a greater capacity than necessary
+ * in order to foresee new elements being added. The items can be added at both
+ * ends of the list and at the middle (with a given index).
+ *
+ * Insertions at the start are more costly as it is necessary to shift all
+ * elements one position to the right to give space to a new element being added
+ * at index 0. Insertions at the end are instantaneous as long as there is
+ * enough space in the buffer. Insertions at the middle will be based on an
+ * index. The index represents where the element being added will be located
+ * once the operation ends. This operation might also need to shift elements. It
+ * is also possible to add arrays of elements in the list.
+ *
+ * When the buffer is filled, it is reallocated with a greater capacity, usually
+ * being doubled.
+ *
+ * Removing elements follows the same principle. Removing the front element will
+ * require to shift all other elements one position to the left, thus being
+ * slower than removing from the end in which is done in constant time. Removing
+ * elements in the middle of the list will also require shifting elements to the
+ * left. Is is also possible to remove a range of elements or extract them,
+ * creating a new list with the removed items.
+ *
+ * The iterator is a simple structure that is capable of going back and
+ * forwards. Any modifications to the target list during iteration is considered
+ * undefined behavior. Its sole purpose is to facilitate navigation through a
+ * list.
+ */
 
 #ifndef CMC_LIST_H
 #define CMC_LIST_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #define LIST_GENERATE(PFX, SNAME, FMOD, V)    \
     LIST_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
@@ -104,6 +134,8 @@
     FMOD size_t PFX##_count(SNAME *_list_);                                                        \
     FMOD bool PFX##_fits(SNAME *_list_, size_t size);                                              \
     FMOD size_t PFX##_capacity(SNAME *_list_);                                                     \
+    /* Collection Utility */                                                                       \
+    FMOD cmc_string PFX##_to_string(SNAME *_list_);                                                \
                                                                                                    \
     /* Iterator Functions */                                                                       \
     /* Iterator Allocation and Deallocation */                                                     \
@@ -520,6 +552,18 @@
         return _list_->capacity;                                                                                 \
     }                                                                                                            \
                                                                                                                  \
+    FMOD cmc_string PFX##_to_string(SNAME *_list_)                                                               \
+    {                                                                                                            \
+        cmc_string str;                                                                                          \
+        SNAME *l_ = _list_;                                                                                      \
+        const char *name = #SNAME;                                                                               \
+                                                                                                                 \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_list,                                                     \
+                 name, l_, l_->buffer, l_->capacity, l_->count);                                                 \
+                                                                                                                 \
+        return str;                                                                                              \
+    }                                                                                                            \
+                                                                                                                 \
     FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                                                             \
     {                                                                                                            \
         SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                                                       \

src/cmc/queue.h

@@ -8,16 +8,46 @@
  *
  */
 
-/*****************************************************************************/
-/********************************************************************* QUEUE */
-/*****************************************************************************/
+/**
+ * Queue
+ *
+ * A Queue is a First-In First-out (or Last-in Last-out) data structure. It is
+ * a Dynamic Circular Array where elements are added from one end of the array
+ * and removed from the other end. The circular array here (also known as
+ * circular buffer or ring buffer) is very important so that both adding and
+ * removing elements from the Queue are done instantly. The array is linear but
+ * with the modulo operator it is treated as a circular sequence of elements.
+ *
+ * If the Queue was implemented as a regular Dynamic Array, when adding or
+ * removing an element at the front, it would be necessary to shift all elements
+ * currently present in the Queue and this would add up a lot of computing time.
+ * Shifting `100000` elements in memory by one position every time an element is
+ * added to the Queue is simply not efficient.
+ *
+ * The Queue has two ends. The `front` and `back`. In this implementation all
+ * elements are added to the back of the Queue and removed from the front, which
+ * is more or less how queues work in real life. Unlike a Stack that only has
+ * operations at one end of the buffer, the Queue needs to be implemented as a
+ * circular array in order to quickly add or remove elements.
+ *
+ * The Queue has three main functions: `enqueue` which adds an element to the
+ * Queue; `dequeue` which removes an element from the Queue; and `peek` which
+ * return the element at the front of the Queue, that is, the next element to
+ * be removed from it.
+ *
+ * The Queue is used in many applications where a resource is shared among
+ * multiple consumers and the Queue is responsible for scheduling the access to
+ * the resource.
+ */
 
 #ifndef CMC_QUEUE_H
 #define CMC_QUEUE_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #define QUEUE_GENERATE(PFX, SNAME, FMOD, V)    \
     QUEUE_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
@@ -48,7 +78,7 @@
         size_t front;                                                             \
                                                                                   \
         /* Index representing the back of the queue */                            \
-        size_t rear;                                                              \
+        size_t back;                                                              \
                                                                                   \
         /* Function that returns an iterator to the start of the queue */         \
         struct SNAME##_iter_s (*it_start)(struct SNAME##_s *);                    \
@@ -97,6 +127,8 @@
     FMOD bool PFX##_full(SNAME *_queue_);                                         \
     FMOD size_t PFX##_count(SNAME *_queue_);                                      \
     FMOD size_t PFX##_capacity(SNAME *_queue_);                                   \
+    /* Collection Utility */                                                      \
+    FMOD cmc_string PFX##_to_string(SNAME *_queue_);                              \
                                                                                   \
     /* Iterator Functions */                                                      \
     /* Iterator Allocation and Deallocation */                                    \
@@ -158,7 +190,7 @@
         _queue_->capacity = capacity;                                                                       \
         _queue_->count = 0;                                                                                 \
         _queue_->front = 0;                                                                                 \
-        _queue_->rear = 0;                                                                                  \
+        _queue_->back = 0;                                                                                  \
                                                                                                             \
         _queue_->it_start = PFX##_impl_it_start;                                                            \
         _queue_->it_end = PFX##_impl_it_end;                                                                \
@@ -172,7 +204,7 @@
                                                                                                             \
         _queue_->count = 0;                                                                                 \
         _queue_->front = 0;                                                                                 \
-        _queue_->rear = 0;                                                                                  \
+        _queue_->back = 0;                                                                                  \
     }                                                                                                       \
                                                                                                             \
     FMOD void PFX##_free(SNAME *_queue_)                                                                    \
@@ -189,9 +221,9 @@
                 return false;                                                                               \
         }                                                                                                   \
                                                                                                             \
-        _queue_->buffer[_queue_->rear] = element;                                                           \
+        _queue_->buffer[_queue_->back] = element;                                                           \
                                                                                                             \
-        _queue_->rear = (_queue_->rear == _queue_->capacity - 1) ? 0 : _queue_->rear + 1;                   \
+        _queue_->back = (_queue_->back == _queue_->capacity - 1) ? 0 : _queue_->back + 1;                   \
         _queue_->count++;                                                                                   \
                                                                                                             \
         return true;                                                                                        \
@@ -265,6 +297,18 @@
         return _queue_->capacity;                                                                           \
     }                                                                                                       \
                                                                                                             \
+    FMOD cmc_string PFX##_to_string(SNAME *_queue_)                                                         \
+    {                                                                                                       \
+        cmc_string str;                                                                                     \
+        SNAME *q_ = _queue_;                                                                                \
+        const char *name = #SNAME;                                                                          \
+                                                                                                            \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_queue,                                               \
+                 name, q_, q_->buffer, q_->capacity, q_->count, q_->front, q_->back);                       \
+                                                                                                            \
+        return str;                                                                                         \
+    }                                                                                                       \
+                                                                                                            \
     FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                                                        \
     {                                                                                                       \
         SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                                                  \
@@ -314,7 +358,7 @@
         if (PFX##_empty(iter->target))                                                                      \
             iter->cursor = 0;                                                                               \
         else                                                                                                \
-            iter->cursor = (iter->target->rear == 0) ? iter->target->capacity - 1 : iter->target->rear - 1; \
+            iter->cursor = (iter->target->back == 0) ? iter->target->capacity - 1 : iter->target->back - 1; \
                                                                                                             \
         iter->index = iter->target->count - 1;                                                              \
         iter->start = PFX##_empty(iter->target);                                                            \
@@ -398,7 +442,7 @@
         _queue_->buffer = new_buffer;                                                                       \
         _queue_->capacity = new_capacity;                                                                   \
         _queue_->front = 0;                                                                                 \
-        _queue_->rear = _queue_->count;                                                                     \
+        _queue_->back = _queue_->count;                                                                     \
                                                                                                             \
         return true;                                                                                        \
     }                                                                                                       \

src/cmc/stack.h

@@ -8,16 +8,31 @@
  *
  */
 
-/*****************************************************************************/
-/********************************************************************* STACK */
-/*****************************************************************************/
+/**
+ * Stack
+ *
+ * A Stack is a Last-in First-out (or First-in Last-out) data structure used in
+ * a variety of algorithms. It is a Dynamic Array that can only add or remove
+ * its elements at the end of the buffer, in this case, it represents the top of
+ * the stack.
+ *
+ * It has three main functions: `push` which adds an element at the top of the
+ * stack; `pop` which removes the top element from the stack; and `top` which
+ * returns the top element without removing it (it is also sometimes called
+ * `peek`).
+ *
+ * A Stack is used in algorithms like backtracking, depth-first search,
+ * expression evaluation, syntax parsing and many more.
+ */
 
 #ifndef CMC_STACK_H
 #define CMC_STACK_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #define STACK_GENERATE(PFX, SNAME, FMOD, V)    \
     STACK_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
@@ -88,6 +103,8 @@
     FMOD bool PFX##_full(SNAME *_stack_);                                         \
     FMOD size_t PFX##_count(SNAME *_stack_);                                      \
     FMOD size_t PFX##_capacity(SNAME *_stack_);                                   \
+    /* Collection Utility */                                                      \
+    FMOD cmc_string PFX##_to_string(SNAME *_stack_);                              \
                                                                                   \
     /* Iterator Functions */                                                      \
     /* Iterator Allocation and Deallocation */                                    \
@@ -246,6 +263,18 @@
         return _stack_->capacity;                                                \
     }                                                                            \
                                                                                  \
+    FMOD cmc_string PFX##_to_string(SNAME *_stack_)                              \
+    {                                                                            \
+        cmc_string str;                                                          \
+        SNAME *s_ = _stack_;                                                     \
+        const char *name = #SNAME;                                               \
+                                                                                 \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_stack,                    \
+                 name, s_, s_->buffer, s_->capacity, s_->count);                 \
+                                                                                 \
+        return str;                                                              \
+    }                                                                            \
+                                                                                 \
     FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                             \
     {                                                                            \
         SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                       \
@@ -266,7 +295,12 @@
     FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target)                 \
     {                                                                            \
         iter->target = target;                                                   \
-        iter->cursor = iter->target->count - 1;                                  \
+                                                                                 \
+        if (PFX##_empty(target))                                                 \
+            iter->cursor = 0;                                                    \
+        else                                                                     \
+            iter->cursor = iter->target->count - 1;                              \
+                                                                                 \
         iter->start = true;                                                      \
         iter->end = PFX##_empty(target);                                         \
     }                                                                            \
@@ -303,7 +337,11 @@
         iter->start = PFX##_empty(iter->target);                                 \
                                                                                  \
         if (iter->cursor == 0)                                                   \
+        {                                                                        \
             iter->end = true;                                                    \
+                                                                                 \
+            return false;                                                        \
+        }                                                                        \
         else                                                                     \
             iter->cursor--;                                                      \
                                                                                  \
@@ -318,7 +356,11 @@
         iter->end = PFX##_empty(iter->target);                                   \
                                                                                  \
         if (iter->cursor == iter->target->count - 1)                             \
+        {                                                                        \
             iter->start = true;                                                  \
+                                                                                 \
+            return false;                                                        \
+        }                                                                        \
         else                                                                     \
             iter->cursor++;                                                      \
                                                                                  \
@@ -343,6 +385,9 @@
                                                                                  \
     FMOD size_t PFX##_iter_index(SNAME##_iter *iter)                             \
     {                                                                            \
+        if (PFX##_empty(iter->target))                                           \
+            return 0;                                                            \
+                                                                                 \
         return iter->target->count - 1 - iter->cursor;                           \
     }                                                                            \
                                                                                  \

src/cmc/treemap.h

@@ -8,16 +8,22 @@
  *
  */
 
-/*****************************************************************************/
-/******************************************************************* TREEMAP */
-/*****************************************************************************/
+/**
+ * TreeMap
+ *
+ * A TreeMap is an implementation of a Map that keeps its keys sorted. Like a
+ * Map, it has only unique keys. This implementation uses a balanced binary
+ * tree called AVL Tree that uses the height of nodes to keep its keys balanced.
+ */
 
 #ifndef CMC_TREEMAP_H
 #define CMC_TREEMAP_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #define TREEMAP_GENERATE(PFX, SNAME, FMOD, K, V)    \
     TREEMAP_GENERATE_HEADER(PFX, SNAME, FMOD, K, V) \
@@ -44,10 +50,10 @@
         /* Key comparison function */                                         \
         int (*cmp)(K, K);                                                     \
                                                                               \
-        /* Function that returns an iterator to the start of the hashmap */   \
+        /* Function that returns an iterator to the start of the treemap */   \
         struct SNAME##_iter_s (*it_start)(struct SNAME##_s *);                \
                                                                               \
-        /* Function that returns an iterator to the end of the hashmap */     \
+        /* Function that returns an iterator to the end of the treemap */     \
         struct SNAME##_iter_s (*it_end)(struct SNAME##_s *);                  \
                                                                               \
     } SNAME, *SNAME##_ptr;                                                    \
@@ -108,6 +114,7 @@
     FMOD void PFX##_free(SNAME *_map_);                                       \
     /* Collection Input and Output */                                         \
     FMOD bool PFX##_insert(SNAME *_map_, K key, V value);                     \
+    FMOD bool PFX##_update(SNAME *_map_, K key, V new_value);                 \
     FMOD bool PFX##_remove(SNAME *_map_, K key, V *value);                    \
     /* Conditional Input and Output */                                        \
     FMOD bool PFX##_insert_if(SNAME *_map_, K key, V value, bool condition);  \
@@ -121,6 +128,8 @@
     FMOD bool PFX##_contains(SNAME *_map_, K key);                            \
     FMOD bool PFX##_empty(SNAME *_map_);                                      \
     FMOD size_t PFX##_count(SNAME *_map_);                                    \
+    /* Collection Utility */                                                  \
+    FMOD cmc_string PFX##_to_string(SNAME *_map_);                            \
                                                                               \
     /* Iterator Functions */                                                  \
     /* Iterator Allocation and Deallocation */                                \
@@ -312,6 +321,18 @@
         return true;                                                         \
     }                                                                        \
                                                                              \
+    FMOD bool PFX##_update(SNAME *_map_, K key, V new_value)                 \
+    {                                                                        \
+        SNAME##_node *node = PFX##_impl_get_node(_map_, key);                \
+                                                                             \
+        if (!node)                                                           \
+            return false;                                                    \
+                                                                             \
+        node->value = new_value;                                             \
+                                                                             \
+        return true;                                                         \
+    }                                                                        \
+                                                                             \
     FMOD bool PFX##_remove(SNAME *_map_, K key, V *value)                    \
     {                                                                        \
         SNAME##_node *node = PFX##_impl_get_node(_map_, key);                \
@@ -532,6 +553,18 @@
         return _map_->count;                                                 \
     }                                                                        \
                                                                              \
+    FMOD cmc_string PFX##_to_string(SNAME *_map_)                            \
+    {                                                                        \
+        cmc_string str;                                                      \
+        SNAME *m_ = _map_;                                                   \
+        const char *name = #SNAME;                                           \
+                                                                             \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_treemap,              \
+                 name, m_, m_->root, m_->count, m_->cmp);                    \
+                                                                             \
+        return str;                                                          \
+    }                                                                        \
+                                                                             \
     FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                         \
     {                                                                        \
         SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                   \

src/cmc/treeset.h

@@ -8,16 +8,22 @@
  *
  */
 
-/*****************************************************************************/
-/******************************************************************* TREESET */
-/*****************************************************************************/
+/**
+ * TreeSet
+ *
+ * A TreeSet is an implementation of a Set that keeps its elements sorted. Like
+ * a Set it has only unique keys. This implementation uses a balanced binary
+ * tree called AVL Tree that uses the height of nodes to keep its keys balanced.
+ */
 
 #ifndef CMC_TREESET_H
 #define CMC_TREESET_H
 
-#include <stdlib.h>
 #include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
 #include <string.h>
+#include "../utl/cmc_string.h"
 
 #define TREESET_GENERATE(PFX, SNAME, FMOD, V)    \
     TREESET_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
@@ -44,10 +50,10 @@
         /* Element comparison function */                                   \
         int (*cmp)(V, V);                                                   \
                                                                             \
-        /* Function that returns an iterator to the start of the hashset */ \
+        /* Function that returns an iterator to the start of the treeset */ \
         struct SNAME##_iter_s (*it_start)(struct SNAME##_s *);              \
                                                                             \
-        /* Function that returns an iterator to the end of the hashset */   \
+        /* Function that returns an iterator to the end of the treeset */   \
         struct SNAME##_iter_s (*it_end)(struct SNAME##_s *);                \
                                                                             \
     } SNAME, *SNAME##_ptr;                                                  \
@@ -95,6 +101,7 @@
                                                                             \
         /* If the iterator has reached the end of the iteration */          \
         bool end;                                                           \
+                                                                            \
     } SNAME##_iter, *SNAME##_iter_ptr;                                      \
                                                                             \
     /* Collection Functions */                                              \
@@ -115,6 +122,8 @@
     FMOD bool PFX##_contains(SNAME *_set_, V element);                      \
     FMOD bool PFX##_empty(SNAME *_set_);                                    \
     FMOD size_t PFX##_count(SNAME *_set_);                                  \
+    /* Collection Utility */                                                \
+    FMOD cmc_string PFX##_to_string(SNAME *_map_);                          \
                                                                             \
     /* Set Operations */                                                    \
     FMOD SNAME *PFX##_union(SNAME *_set1_, SNAME *_set2_);                  \
@@ -499,12 +508,24 @@
         return _set_->count;                                                                \
     }                                                                                       \
                                                                                             \
+    FMOD cmc_string PFX##_to_string(SNAME *_set_)                                           \
+    {                                                                                       \
+        cmc_string str;                                                                     \
+        SNAME *s_ = _set_;                                                                  \
+        const char *name = #SNAME;                                                          \
+                                                                                            \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_treeset,                             \
+                 name, s_, s_->root, s_->count, s_->cmp);                                   \
+                                                                                            \
+        return str;                                                                         \
+    }                                                                                       \
+                                                                                            \
     FMOD SNAME *PFX##_union(SNAME *_set1_, SNAME *_set2_)                                   \
     {                                                                                       \
         SNAME *_set_r_ = PFX##_new(_set1_->cmp);                                            \
                                                                                             \
         if (!_set_r_)                                                                       \
-            return false;                                                                   \
+            return NULL;                                                                    \
                                                                                             \
         SNAME##_iter iter1, iter2;                                                          \
         PFX##_iter_init(&iter1, _set1_);                                                    \
@@ -528,7 +549,7 @@
         SNAME *_set_r_ = PFX##_new(_set1_->cmp);                                            \
                                                                                             \
         if (!_set_r_)                                                                       \
-            return false;                                                                   \
+            return NULL;                                                                    \
                                                                                             \
         SNAME *_set_A_ = _set1_->count < _set2_->count ? _set1_ : _set2_;                   \
         SNAME *_set_B_ = _set_A_ == _set1_ ? _set2_ : _set1_;                               \
@@ -552,7 +573,7 @@
         SNAME *_set_r_ = PFX##_new(_set1_->cmp);                                            \
                                                                                             \
         if (!_set_r_)                                                                       \
-            return false;                                                                   \
+            return NULL;                                                                    \
                                                                                             \
         SNAME##_iter iter;                                                                  \
         PFX##_iter_init(&iter, _set1_);                                                     \
@@ -573,7 +594,7 @@
         SNAME *_set_r_ = PFX##_new(_set1_->cmp);                                            \
                                                                                             \
         if (!_set_r_)                                                                       \
-            return false;                                                                   \
+            return NULL;                                                                    \
                                                                                             \
         SNAME##_iter iter1, iter2;                                                          \
         PFX##_iter_init(&iter1, _set1_);                                                    \

src/ext/intervalheap.h

@@ -0,0 +1,841 @@
+/**
+ * intervalheap.h
+ *
+ * Creation Date: 06/07/2019
+ *
+ * Authors:
+ * Leonardo Vencovsky (https://github.com/LeoVen)
+ *
+ */
+
+/**
+ * An interval heap is a specialized heap with:
+ *
+ * - O(1) - Find Min
+ * - O(1) - Find Max
+ * - O(log n) - Insert
+ * - O(log n) - Remove Min
+ * - O(log n) - Remove Max
+ */
+
+#ifndef CMC_INTERVALHEAP_H
+#define CMC_INTERVALHEAP_H
+
+#include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include "../utl/cmc_string.h"
+
+#define INTERVALHEAP_GENERATE(PFX, SNAME, FMOD, V)    \
+    INTERVALHEAP_GENERATE_HEADER(PFX, SNAME, FMOD, V) \
+    INTERVALHEAP_GENERATE_SOURCE(PFX, SNAME, FMOD, V)
+
+#define INTERVALHEAP_WRAPGEN_HEADER(PFX, SNAME, FMOD, K, V) \
+    INTERVALHEAP_GENERATE_HEADER(PFX, SNAME, FMOD, V)
+
+#define INTERVALHEAP_WRAPGEN_SOURCE(PFX, SNAME, FMOD, K, V) \
+    INTERVALHEAP_GENERATE_SOURCE(PFX, SNAME, FMOD, V)
+
+/* HEADER ********************************************************************/
+#define INTERVALHEAP_GENERATE_HEADER(PFX, SNAME, FMOD, V)                    \
+                                                                             \
+    /* Heap Structure */                                                     \
+    typedef struct SNAME##_s                                                 \
+    {                                                                        \
+        /* Dynamic array of nodes */                                         \
+        struct SNAME##_node_s *buffer;                                       \
+                                                                             \
+        /* Current array capacity (how many nodes can be stored) */          \
+        size_t capacity;                                                     \
+                                                                             \
+        /* Current amount of nodes in the dynamic array */                   \
+        size_t size;                                                         \
+                                                                             \
+        /* Current amount of elements in the heap */                         \
+        size_t count;                                                        \
+                                                                             \
+        /* Element comparison function */                                    \
+        int (*cmp)(V, V);                                                    \
+                                                                             \
+        /* Function that returns an iterator to the start of the heap */     \
+        struct SNAME##_iter_s (*it_start)(struct SNAME##_s *);               \
+                                                                             \
+        /* Function that returns an iterator to the end of the heap */       \
+        struct SNAME##_iter_s (*it_end)(struct SNAME##_s *);                 \
+                                                                             \
+    } SNAME, *SNAME##_ptr;                                                   \
+                                                                             \
+    /* Heap Node */                                                          \
+    typedef struct SNAME##_node_s                                            \
+    {                                                                        \
+        /* 0 - Value belonging to the MinHeap */                             \
+        /* 1 - Value belonging to the MaxHeap */                             \
+        V data[2];                                                           \
+                                                                             \
+    } SNAME##_node, *SNAME##_node_ptr;                                       \
+                                                                             \
+    /* Heap Iterator */                                                      \
+    typedef struct SNAME##_iter_s                                            \
+    {                                                                        \
+        /* Target heap */                                                    \
+        struct SNAME##_s *target;                                            \
+                                                                             \
+        /* Cursor's position (index) */                                      \
+        size_t cursor;                                                       \
+                                                                             \
+        /* If the iterator has reached the start of the iteration */         \
+        bool start;                                                          \
+                                                                             \
+        /* If the iterator has reached the end of the iteration */           \
+        bool end;                                                            \
+                                                                             \
+    } SNAME##_iter, *SNAME##_iter_ptr;                                       \
+                                                                             \
+    /* Collection Functions */                                               \
+    /* Collection Allocation and Deallocation */                             \
+    FMOD SNAME *PFX##_new(size_t capacity, int (*compare)(V, V));            \
+    FMOD void PFX##_clear(SNAME *_heap_);                                    \
+    FMOD void PFX##_free(SNAME *_heap_);                                     \
+    /* Collection Input and Output */                                        \
+    FMOD bool PFX##_insert(SNAME *_heap_, V element);                        \
+    FMOD bool PFX##_remove_max(SNAME *_heap_, V *result);                    \
+    FMOD bool PFX##_remove_min(SNAME *_heap_, V *result);                    \
+    /* Conditional Input and Output */                                       \
+    FMOD bool PFX##_insert_if(SNAME *_heap_, V element, bool condition);     \
+    FMOD bool PFX##_remove_max_if(SNAME *_heap_, V *result, bool condition); \
+    FMOD bool PFX##_remove_min_if(SNAME *_heap_, V *result, bool condition); \
+    /* Collection Update */                                                  \
+    FMOD bool PFX##_update_max(SNAME *_heap_, V element);                    \
+    FMOD bool PFX##_update_min(SNAME *_heap_, V element);                    \
+    /* Element Access */                                                     \
+    FMOD bool PFX##_max(SNAME *_heap_, V *value);                            \
+    FMOD bool PFX##_min(SNAME *_heap_, V *value);                            \
+    /* Collection State */                                                   \
+    FMOD bool PFX##_contains(SNAME *_heap_, V element);                      \
+    FMOD bool PFX##_empty(SNAME *_heap_);                                    \
+    FMOD bool PFX##_full(SNAME *_heap_);                                     \
+    FMOD size_t PFX##_count(SNAME *_heap_);                                  \
+    FMOD size_t PFX##_capacity(SNAME *_heap_);                               \
+    /* Collection Utility */                                                 \
+    FMOD cmc_string PFX##_to_string(SNAME *_heap_);                          \
+                                                                             \
+    /* Iterator Functions */                                                 \
+    /* Iterator Allocation and Deallocation */                               \
+    FMOD SNAME##_iter *PFX##_iter_new(SNAME *target);                        \
+    FMOD void PFX##_iter_free(SNAME##_iter *iter);                           \
+    /* Iterator Initialization */                                            \
+    FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target);            \
+    /* Iterator State */                                                     \
+    FMOD bool PFX##_iter_start(SNAME##_iter *iter);                          \
+    FMOD bool PFX##_iter_end(SNAME##_iter *iter);                            \
+    /* Iterator Movement */                                                  \
+    FMOD void PFX##_iter_to_start(SNAME##_iter *iter);                       \
+    FMOD void PFX##_iter_to_end(SNAME##_iter *iter);                         \
+    FMOD bool PFX##_iter_next(SNAME##_iter *iter);                           \
+    FMOD bool PFX##_iter_prev(SNAME##_iter *iter);                           \
+    /* Iterator Access */                                                    \
+    FMOD V PFX##_iter_value(SNAME##_iter *iter);                             \
+    FMOD size_t PFX##_iter_index(SNAME##_iter *iter);                        \
+                                                                             \
+    /* Default Value */                                                      \
+    static inline V PFX##_impl_default_value(void)                           \
+    {                                                                        \
+        V _empty_value_;                                                     \
+                                                                             \
+        memset(&_empty_value_, 0, sizeof(V));                                \
+                                                                             \
+        return _empty_value_;                                                \
+    }                                                                        \
+                                                                             \
+/* SOURCE ********************************************************************/
+#define INTERVALHEAP_GENERATE_SOURCE(PFX, SNAME, FMOD, V)                                   \
+                                                                                            \
+    /* Implementation Detail Functions */                                                   \
+    static bool PFX##_impl_grow(SNAME *_heap_);                                             \
+    static void PFX##_impl_float_up_max(SNAME *_heap_);                                     \
+    static void PFX##_impl_float_up_min(SNAME *_heap_);                                     \
+    static void PFX##_impl_float_down_max(SNAME *_heap_);                                   \
+    static void PFX##_impl_float_down_min(SNAME *_heap_);                                   \
+    static SNAME##_iter PFX##_impl_it_start(SNAME *_heap_);                                 \
+    static SNAME##_iter PFX##_impl_it_end(SNAME *_heap_);                                   \
+                                                                                            \
+    FMOD SNAME *PFX##_new(size_t capacity, int (*compare)(V, V))                            \
+    {                                                                                       \
+        SNAME *_heap_ = malloc(sizeof(SNAME));                                              \
+                                                                                            \
+        if (!_heap_)                                                                        \
+            return NULL;                                                                    \
+                                                                                            \
+        /* Since each node can store two elements, divide the actual capacity by 2 */       \
+        /* Round the capacity of nodes up */                                                \
+        capacity = capacity % 2 == 0 ? capacity / 2 : (capacity + 1) / 2;                   \
+                                                                                            \
+        _heap_->buffer = malloc(sizeof(SNAME##_node) * capacity);                           \
+                                                                                            \
+        if (!_heap_->buffer)                                                                \
+        {                                                                                   \
+            free(_heap_);                                                                   \
+            return NULL;                                                                    \
+        }                                                                                   \
+                                                                                            \
+        memset(_heap_->buffer, 0, sizeof(SNAME##_node) * capacity);                         \
+                                                                                            \
+        _heap_->capacity = capacity;                                                        \
+        _heap_->size = 0;                                                                   \
+        _heap_->count = 0;                                                                  \
+        _heap_->cmp = compare;                                                              \
+                                                                                            \
+        _heap_->it_start = PFX##_impl_it_start;                                             \
+        _heap_->it_end = PFX##_impl_it_end;                                                 \
+                                                                                            \
+        return _heap_;                                                                      \
+    }                                                                                       \
+                                                                                            \
+    FMOD void PFX##_clear(SNAME *_heap_)                                                    \
+    {                                                                                       \
+        memset(_heap_->buffer, 0, sizeof(V) * _heap_->capacity);                            \
+                                                                                            \
+        _heap_->size = 0;                                                                   \
+        _heap_->count = 0;                                                                  \
+    }                                                                                       \
+                                                                                            \
+    FMOD void PFX##_free(SNAME *_heap_)                                                     \
+    {                                                                                       \
+        free(_heap_->buffer);                                                               \
+                                                                                            \
+        free(_heap_);                                                                       \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_insert(SNAME *_heap_, V element)                                        \
+    {                                                                                       \
+        if (PFX##_full(_heap_))                                                             \
+        {                                                                                   \
+            if (!PFX##_impl_grow(_heap_))                                                   \
+                return false;                                                               \
+        }                                                                                   \
+                                                                                            \
+        if (PFX##_count(_heap_) % 2 == 0)                                                   \
+        {                                                                                   \
+            /* Occupying a new node */                                                      \
+            _heap_->buffer[_heap_->size].data[0] = element;                                 \
+            _heap_->buffer[_heap_->size].data[1] = PFX##_impl_default_value();              \
+                                                                                            \
+            _heap_->size++;                                                                 \
+        }                                                                                   \
+        else                                                                                \
+        {                                                                                   \
+            SNAME##_node *curr_node = &(_heap_->buffer[_heap_->size - 1]);                  \
+                                                                                            \
+            /* Decide if the new element goes into the MinHeap or MaxHeap */                \
+            if (_heap_->cmp(curr_node->data[0], element) > 0)                               \
+            {                                                                               \
+                /* Swap current value and add new element to the MinHeap */                 \
+                curr_node->data[1] = curr_node->data[0];                                    \
+                curr_node->data[0] = element;                                               \
+            }                                                                               \
+            else                                                                            \
+            {                                                                               \
+                /* No need to swap and add the new element to the MaxHeap */                \
+                curr_node->data[1] = element;                                               \
+            }                                                                               \
+        }                                                                                   \
+                                                                                            \
+        _heap_->count++;                                                                    \
+                                                                                            \
+        if (PFX##_count(_heap_) <= 2)                                                       \
+            return true;                                                                    \
+                                                                                            \
+        /* Determine wheather to do a MaxHeap insert or a MinHeap insert */                 \
+        SNAME##_node *parent = &(_heap_->buffer[(_heap_->size - 1) / 2]);                   \
+                                                                                            \
+        if (_heap_->cmp(parent->data[0], element) > 0)                                      \
+            PFX##_impl_float_up_min(_heap_);                                                \
+        else if (_heap_->cmp(parent->data[1], element) < 0)                                 \
+            PFX##_impl_float_up_max(_heap_);                                                \
+        /* else no float up required */                                                     \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_remove_max(SNAME *_heap_, V *result)                                    \
+    {                                                                                       \
+        if (PFX##_empty(_heap_))                                                            \
+            return false;                                                                   \
+                                                                                            \
+        if (PFX##_count(_heap_) == 1)                                                       \
+        {                                                                                   \
+            *result = _heap_->buffer[0].data[0];                                            \
+                                                                                            \
+            _heap_->buffer[0].data[0] = PFX##_impl_default_value();                         \
+                                                                                            \
+            _heap_->count--;                                                                \
+                                                                                            \
+            return true;                                                                    \
+        }                                                                                   \
+        else                                                                                \
+            *result = _heap_->buffer[0].data[1];                                            \
+                                                                                            \
+        /* Swap the result with the last element in the MaxHeap and float it down */        \
+        SNAME##_node *last_node = &(_heap_->buffer[_heap_->size - 1]);                      \
+                                                                                            \
+        if (PFX##_count(_heap_) % 2 == 1)                                                   \
+        {                                                                                   \
+            /* Grab from MinHeap and discard last node */                                   \
+            _heap_->buffer[0].data[1] = last_node->data[0];                                 \
+                                                                                            \
+            last_node->data[0] = PFX##_impl_default_value();                                \
+                                                                                            \
+            _heap_->size--;                                                                 \
+        }                                                                                   \
+        else                                                                                \
+        {                                                                                   \
+            _heap_->buffer[0].data[1] = last_node->data[1];                                 \
+                                                                                            \
+            last_node->data[1] = PFX##_impl_default_value();                                \
+        }                                                                                   \
+                                                                                            \
+        _heap_->count--;                                                                    \
+                                                                                            \
+        /* FLoat Down on the MaxHeap */                                                     \
+        PFX##_impl_float_down_max(_heap_);                                                  \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_remove_min(SNAME *_heap_, V *result)                                    \
+    {                                                                                       \
+        if (PFX##_empty(_heap_))                                                            \
+            return false;                                                                   \
+                                                                                            \
+        *result = _heap_->buffer[0].data[0];                                                \
+                                                                                            \
+        if (PFX##_count(_heap_) == 1)                                                       \
+        {                                                                                   \
+            _heap_->buffer[0].data[0] = PFX##_impl_default_value();                         \
+                                                                                            \
+            _heap_->count--;                                                                \
+                                                                                            \
+            return true;                                                                    \
+        }                                                                                   \
+                                                                                            \
+        /* Swap the result with the last element in the MinHeap and float it down */        \
+        SNAME##_node *last_node = &(_heap_->buffer[_heap_->size - 1]);                      \
+                                                                                            \
+        _heap_->buffer[0].data[0] = last_node->data[0];                                     \
+                                                                                            \
+        if (PFX##_count(_heap_) % 2 == 1)                                                   \
+        {                                                                                   \
+            /* Discard last node */                                                         \
+            last_node->data[0] = PFX##_impl_default_value();                                \
+                                                                                            \
+            _heap_->size--;                                                                 \
+        }                                                                                   \
+        else                                                                                \
+        {                                                                                   \
+            /* Place the MaxHeap value in the MinHeap value spot */                         \
+            last_node->data[0] = last_node->data[1];                                        \
+            last_node->data[1] = PFX##_impl_default_value();                                \
+        }                                                                                   \
+                                                                                            \
+        _heap_->count--;                                                                    \
+                                                                                            \
+        /* FLoat Down on the MinHeap */                                                     \
+        PFX##_impl_float_down_min(_heap_);                                                  \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_insert_if(SNAME *_heap_, V element, bool condition)                     \
+    {                                                                                       \
+        if (condition)                                                                      \
+            return PFX##_insert(_heap_, element);                                           \
+                                                                                            \
+        return false;                                                                       \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_remove_max_if(SNAME *_heap_, V *result, bool condition)                 \
+    {                                                                                       \
+        if (condition)                                                                      \
+            return PFX##_remove_max(_heap_, result);                                        \
+                                                                                            \
+        return false;                                                                       \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_remove_min_if(SNAME *_heap_, V *result, bool condition)                 \
+    {                                                                                       \
+        if (condition)                                                                      \
+            return PFX##_remove_min(_heap_, result);                                        \
+                                                                                            \
+        return false;                                                                       \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_update_max(SNAME *_heap_, V element)                                    \
+    {                                                                                       \
+        if (PFX##_empty(_heap_))                                                            \
+            return false;                                                                   \
+                                                                                            \
+        if (PFX##_count(_heap_) == 1)                                                       \
+        {                                                                                   \
+            _heap_->buffer[0].data[0] = element;                                            \
+        }                                                                                   \
+        else if (_heap_->cmp(element, _heap_->buffer[0].data[0]) < 0)                       \
+        {                                                                                   \
+            /* Corner case: we are updating the Max value but it is less than */            \
+            /* the Min value */                                                             \
+            _heap_->buffer[0].data[1] = _heap_->buffer[0].data[0];                          \
+            _heap_->buffer[0].data[0] = element;                                            \
+                                                                                            \
+            PFX##_impl_float_down_max(_heap_);                                              \
+        }                                                                                   \
+        else                                                                                \
+        {                                                                                   \
+            /* Update Max element and float it down */                                      \
+            _heap_->buffer[0].data[1] = element;                                            \
+                                                                                            \
+            PFX##_impl_float_down_max(_heap_);                                              \
+        }                                                                                   \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_update_min(SNAME *_heap_, V element)                                    \
+    {                                                                                       \
+        if (PFX##_empty(_heap_))                                                            \
+            return false;                                                                   \
+                                                                                            \
+        if (PFX##_count(_heap_) == 1)                                                       \
+        {                                                                                   \
+            _heap_->buffer[0].data[0] = element;                                            \
+        }                                                                                   \
+        else if (_heap_->cmp(element, _heap_->buffer[0].data[1]) > 0)                       \
+        {                                                                                   \
+            /* Corner case: we are updating the Min value but it is greater */              \
+            /* than the Max value. */                                                       \
+            _heap_->buffer[0].data[0] = _heap_->buffer[0].data[1];                          \
+            _heap_->buffer[0].data[1] = element;                                            \
+                                                                                            \
+            PFX##_impl_float_down_min(_heap_);                                              \
+        }                                                                                   \
+        else                                                                                \
+        {                                                                                   \
+            /* Update Min element and float it down */                                      \
+            _heap_->buffer[0].data[0] = element;                                            \
+                                                                                            \
+            PFX##_impl_float_down_min(_heap_);                                              \
+        }                                                                                   \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_max(SNAME *_heap_, V *value)                                            \
+    {                                                                                       \
+        if (PFX##_empty(_heap_))                                                            \
+            return false;                                                                   \
+                                                                                            \
+        /* If there is only one element, then the maximum element is the same */            \
+        /* as the one in the MinHeap */                                                     \
+        if (PFX##_count(_heap_) == 1)                                                       \
+            *value = _heap_->buffer[0].data[0];                                             \
+        else                                                                                \
+            *value = _heap_->buffer[0].data[1];                                             \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_min(SNAME *_heap_, V *value)                                            \
+    {                                                                                       \
+        if (PFX##_empty(_heap_))                                                            \
+            return false;                                                                   \
+                                                                                            \
+        *value = _heap_->buffer[0].data[0];                                                 \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_contains(SNAME *_heap_, V element)                                      \
+    {                                                                                       \
+        for (size_t i = 0; i < _heap_->count; i++)                                          \
+        {                                                                                   \
+            if (_heap_->cmp(_heap_->buffer[i / 2].data[i % 2], element) == 0)               \
+                return true;                                                                \
+        }                                                                                   \
+                                                                                            \
+        return false;                                                                       \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_empty(SNAME *_heap_)                                                    \
+    {                                                                                       \
+        return _heap_->count == 0;                                                          \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_full(SNAME *_heap_)                                                     \
+    {                                                                                       \
+        /* The heap is full if all nodes are completely filled */                           \
+        return _heap_->size >= _heap_->capacity && _heap_->count % 2 == 0;                  \
+    }                                                                                       \
+                                                                                            \
+    FMOD size_t PFX##_count(SNAME *_heap_)                                                  \
+    {                                                                                       \
+        return _heap_->count;                                                               \
+    }                                                                                       \
+                                                                                            \
+    FMOD size_t PFX##_capacity(SNAME *_heap_)                                               \
+    {                                                                                       \
+        return _heap_->capacity;                                                            \
+    }                                                                                       \
+                                                                                            \
+    FMOD cmc_string PFX##_to_string(SNAME *_heap_)                                          \
+    {                                                                                       \
+        cmc_string str;                                                                     \
+        SNAME *h_ = _heap_;                                                                 \
+        const char *name = #SNAME;                                                          \
+                                                                                            \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_intervalheap,                        \
+                 name, h_, h_->buffer, h_->capacity, h_->size, h_->count, h_->cmp);         \
+                                                                                            \
+        return str;                                                                         \
+    }                                                                                       \
+                                                                                            \
+    FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                                        \
+    {                                                                                       \
+        SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                                  \
+                                                                                            \
+        if (!iter)                                                                          \
+            return NULL;                                                                    \
+                                                                                            \
+        PFX##_iter_init(iter, target);                                                      \
+                                                                                            \
+        return iter;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD void PFX##_iter_free(SNAME##_iter *iter)                                           \
+    {                                                                                       \
+        free(iter);                                                                         \
+    }                                                                                       \
+                                                                                            \
+    FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target)                            \
+    {                                                                                       \
+        iter->target = target;                                                              \
+        iter->cursor = 0;                                                                   \
+        iter->start = true;                                                                 \
+        iter->end = PFX##_empty(target);                                                    \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_iter_start(SNAME##_iter *iter)                                          \
+    {                                                                                       \
+        return PFX##_empty(iter->target) || iter->start;                                    \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_iter_end(SNAME##_iter *iter)                                            \
+    {                                                                                       \
+        return PFX##_empty(iter->target) || iter->end;                                      \
+    }                                                                                       \
+                                                                                            \
+    FMOD void PFX##_iter_to_start(SNAME##_iter *iter)                                       \
+    {                                                                                       \
+        iter->cursor = 0;                                                                   \
+        iter->start = true;                                                                 \
+        iter->end = PFX##_empty(iter->target);                                              \
+    }                                                                                       \
+                                                                                            \
+    FMOD void PFX##_iter_to_end(SNAME##_iter *iter)                                         \
+    {                                                                                       \
+        iter->cursor = iter->target->count - 1;                                             \
+        iter->start = PFX##_empty(iter->target);                                            \
+        iter->end = true;                                                                   \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_iter_next(SNAME##_iter *iter)                                           \
+    {                                                                                       \
+        if (iter->end)                                                                      \
+            return false;                                                                   \
+                                                                                            \
+        iter->start = false;                                                                \
+                                                                                            \
+        if (iter->cursor == iter->target->count - 1)                                        \
+            iter->end = true;                                                               \
+        else                                                                                \
+            iter->cursor++;                                                                 \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD bool PFX##_iter_prev(SNAME##_iter *iter)                                           \
+    {                                                                                       \
+        if (iter->start)                                                                    \
+            return false;                                                                   \
+                                                                                            \
+        iter->end = false;                                                                  \
+                                                                                            \
+        if (iter->cursor == 0)                                                              \
+            iter->start = true;                                                             \
+        else                                                                                \
+            iter->cursor--;                                                                 \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    FMOD V PFX##_iter_value(SNAME##_iter *iter)                                             \
+    {                                                                                       \
+        if (PFX##_empty(iter->target))                                                      \
+            return PFX##_impl_default_value();                                              \
+                                                                                            \
+        return iter->target->buffer[iter->cursor / 2].data[iter->cursor % 2];               \
+    }                                                                                       \
+                                                                                            \
+    FMOD size_t PFX##_iter_index(SNAME##_iter *iter)                                        \
+    {                                                                                       \
+        return iter->cursor;                                                                \
+    }                                                                                       \
+                                                                                            \
+    static bool PFX##_impl_grow(SNAME *_heap_)                                              \
+    {                                                                                       \
+        size_t new_cap = _heap_->capacity * 2;                                              \
+                                                                                            \
+        SNAME##_node *new_buffer = realloc(_heap_->buffer, sizeof(SNAME##_node) * new_cap); \
+                                                                                            \
+        if (!new_buffer)                                                                    \
+            return false;                                                                   \
+                                                                                            \
+        memset(new_buffer + _heap_->capacity, 0, sizeof(SNAME##_node) * _heap_->capacity);  \
+                                                                                            \
+        _heap_->buffer = new_buffer;                                                        \
+        _heap_->capacity = new_cap;                                                         \
+                                                                                            \
+        return true;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    static void PFX##_impl_float_up_max(SNAME *_heap_)                                      \
+    {                                                                                       \
+        size_t index = _heap_->size - 1;                                                    \
+                                                                                            \
+        SNAME##_node *curr_node = &(_heap_->buffer[index]);                                 \
+                                                                                            \
+        /* FLoat Up on the MaxHeap */                                                       \
+        while (index > 0)                                                                   \
+        {                                                                                   \
+            /* Parent index */                                                              \
+            size_t P_index = (index - 1) / 2;                                               \
+                                                                                            \
+            SNAME##_node *parent = &(_heap_->buffer[P_index]);                              \
+                                                                                            \
+            if (index == _heap_->size - 1 && PFX##_count(_heap_) % 2 != 0)                  \
+            {                                                                               \
+                /* In this case, the current node has no MaxHeap value so we */             \
+                /* instead compare with the MinHeap value */                                \
+                if (_heap_->cmp(curr_node->data[0], parent->data[1]) < 0)                   \
+                    break;                                                                  \
+                                                                                            \
+                /* Since the comparison above passed now we need to swap the */             \
+                /* current node with the parent but it will have to be done */              \
+                /* with the node's MinHeap value since the MaxHeap value */                 \
+                /* doesn't exist */                                                         \
+                V tmp = curr_node->data[0];                                                 \
+                curr_node->data[0] = parent->data[1];                                       \
+                parent->data[1] = tmp;                                                      \
+            }                                                                               \
+            else                                                                            \
+            {                                                                               \
+                /* Usual case, just compare both MaxHeap values */                          \
+                if (_heap_->cmp(curr_node->data[1], parent->data[1]) < 0)                   \
+                    break;                                                                  \
+                                                                                            \
+                /* Swap with parent and repeat */                                           \
+                V tmp = curr_node->data[1];                                                 \
+                curr_node->data[1] = parent->data[1];                                       \
+                parent->data[1] = tmp;                                                      \
+            }                                                                               \
+                                                                                            \
+            /* Update indexe and node */                                                    \
+            index = P_index;                                                                \
+            curr_node = parent;                                                             \
+        }                                                                                   \
+    }                                                                                       \
+                                                                                            \
+    static void PFX##_impl_float_up_min(SNAME *_heap_)                                      \
+    {                                                                                       \
+        size_t index = _heap_->size - 1;                                                    \
+                                                                                            \
+        SNAME##_node *curr_node = &(_heap_->buffer[index]);                                 \
+                                                                                            \
+        /* FLoat Up on the MinHeap */                                                       \
+        while (index > 0)                                                                   \
+        {                                                                                   \
+            /* Parent index */                                                              \
+            size_t P_index = (index - 1) / 2;                                               \
+                                                                                            \
+            SNAME##_node *parent = &(_heap_->buffer[P_index]);                              \
+                                                                                            \
+            if (_heap_->cmp(curr_node->data[0], parent->data[0]) >= 0)                      \
+                break;                                                                      \
+                                                                                            \
+            /* Swap with parent and repeat */                                               \
+            V tmp = curr_node->data[0];                                                     \
+            curr_node->data[0] = parent->data[0];                                           \
+            parent->data[0] = tmp;                                                          \
+                                                                                            \
+            /* Update indexe and node */                                                    \
+            index = P_index;                                                                \
+            curr_node = parent;                                                             \
+        }                                                                                   \
+    }                                                                                       \
+                                                                                            \
+    static void PFX##_impl_float_down_max(SNAME *_heap_)                                    \
+    {                                                                                       \
+        /* Floats Down from the MinHeap */                                                  \
+        size_t index = 0;                                                                   \
+                                                                                            \
+        SNAME##_node *curr_node = &(_heap_->buffer[index]);                                 \
+                                                                                            \
+        while (true)                                                                        \
+        {                                                                                   \
+            /* If there are no children it is done */                                       \
+            if (2 * index + 1 >= _heap_->size)                                              \
+                break;                                                                      \
+                                                                                            \
+            /* Child index to be compared with current value */                             \
+            size_t child;                                                                   \
+            size_t L_index = index * 2 + 1;                                                 \
+            size_t R_index = index * 2 + 2;                                                 \
+                                                                                            \
+            /* If there are two children, pick the smallest one */                          \
+            if (R_index < _heap_->size)                                                     \
+            {                                                                               \
+                SNAME##_node *L = &(_heap_->buffer[L_index]);                               \
+                SNAME##_node *R = &(_heap_->buffer[R_index]);                               \
+                                                                                            \
+                /* If the right child is the last node and there is no MaxHeap value */     \
+                /* then do the comparison with the MinHeap value */                         \
+                if (R_index == _heap_->size - 1 && PFX##_count(_heap_) % 2 != 0)            \
+                    child = _heap_->cmp(L->data[1], R->data[0]) > 0 ? L_index : R_index;    \
+                else                                                                        \
+                    child = _heap_->cmp(L->data[1], R->data[1]) > 0 ? L_index : R_index;    \
+            }                                                                               \
+            /* Pick the only one available */                                               \
+            else                                                                            \
+                child = L_index;                                                            \
+                                                                                            \
+            SNAME##_node *child_node = &(_heap_->buffer[child]);                            \
+                                                                                            \
+            /* Again, check if the child node is the last one and has no MaxHeap value */   \
+            if (child == _heap_->size - 1 && PFX##_count(_heap_) % 2 != 0)                  \
+            {                                                                               \
+                /* Odd case, compare with MinHeap value */                                  \
+                /* If current value is not less than the child node's value, it is done */  \
+                if (_heap_->cmp(curr_node->data[1], child_node->data[0]) >= 0)              \
+                    break;                                                                  \
+                                                                                            \
+                /* Otherwise swap and continue */                                           \
+                V tmp = child_node->data[0];                                                \
+                child_node->data[0] = curr_node->data[1];                                   \
+                curr_node->data[1] = tmp;                                                   \
+            }                                                                               \
+            else                                                                            \
+            {                                                                               \
+                /* If current value is not less than the child node's value, it is done */  \
+                if (_heap_->cmp(curr_node->data[1], child_node->data[1]) >= 0)              \
+                    break;                                                                  \
+                                                                                            \
+                /* Otherwise swap and continue */                                           \
+                V tmp = child_node->data[1];                                                \
+                child_node->data[1] = curr_node->data[1];                                   \
+                curr_node->data[1] = tmp;                                                   \
+                                                                                            \
+                /* Check if the MinHeap and MaxHeap values need to be swapped */            \
+                if (_heap_->cmp(child_node->data[0], child_node->data[1]) > 0)              \
+                {                                                                           \
+                    /* Swap because the MinHeap value is greater than the MaxHeap value */  \
+                    tmp = child_node->data[0];                                              \
+                    child_node->data[0] = child_node->data[1];                              \
+                    child_node->data[1] = tmp;                                              \
+                }                                                                           \
+            }                                                                               \
+                                                                                            \
+            /* Update index and node */                                                     \
+            index = child;                                                                  \
+            curr_node = child_node;                                                         \
+        }                                                                                   \
+    }                                                                                       \
+                                                                                            \
+    static void PFX##_impl_float_down_min(SNAME *_heap_)                                    \
+    {                                                                                       \
+        /* Floats Down from the MinHeap */                                                  \
+        size_t index = 0;                                                                   \
+                                                                                            \
+        SNAME##_node *curr_node = &(_heap_->buffer[index]);                                 \
+                                                                                            \
+        while (true)                                                                        \
+        {                                                                                   \
+            /* If there are no children it is done */                                       \
+            if (2 * index + 1 >= _heap_->size)                                              \
+                break;                                                                      \
+                                                                                            \
+            /* Child index to be compared with current value */                             \
+            size_t child;                                                                   \
+            size_t L_index = index * 2 + 1;                                                 \
+            size_t R_index = index * 2 + 2;                                                 \
+                                                                                            \
+            /* If there are two children, pick the smallest one */                          \
+            if (R_index < _heap_->size)                                                     \
+            {                                                                               \
+                SNAME##_node *L = &(_heap_->buffer[L_index]);                               \
+                SNAME##_node *R = &(_heap_->buffer[R_index]);                               \
+                                                                                            \
+                child = _heap_->cmp(L->data[0], R->data[0]) < 0 ? L_index : R_index;        \
+            }                                                                               \
+            /* Pick the only one available */                                               \
+            else                                                                            \
+                child = L_index;                                                            \
+                                                                                            \
+            SNAME##_node *child_node = &(_heap_->buffer[child]);                            \
+                                                                                            \
+            /* If current value is smaller than the child node's value, it is done */       \
+            if (_heap_->cmp(curr_node->data[0], child_node->data[0]) < 0)                   \
+                break;                                                                      \
+                                                                                            \
+            /* Otherwise swap and continue */                                               \
+            V tmp = child_node->data[0];                                                    \
+            child_node->data[0] = curr_node->data[0];                                       \
+            curr_node->data[0] = tmp;                                                       \
+                                                                                            \
+            /* If the child node is the last node check if the MinHeap and */               \
+            /* MaxHeap values need to be swapped */                                         \
+            if (child != _heap_->size - 1 || PFX##_count(_heap_) % 2 == 0)                  \
+            {                                                                               \
+                if (_heap_->cmp(child_node->data[0], child_node->data[1]) > 0)              \
+                {                                                                           \
+                    /* Swap because the MinHeap value is greater than the MaxHeap value */  \
+                    tmp = child_node->data[0];                                              \
+                    child_node->data[0] = child_node->data[1];                              \
+                    child_node->data[1] = tmp;                                              \
+                }                                                                           \
+            }                                                                               \
+                                                                                            \
+            /* Update index and node */                                                     \
+            index = child;                                                                  \
+            curr_node = child_node;                                                         \
+        }                                                                                   \
+    }                                                                                       \
+                                                                                            \
+    static SNAME##_iter PFX##_impl_it_start(SNAME *_heap_)                                  \
+    {                                                                                       \
+        SNAME##_iter iter;                                                                  \
+                                                                                            \
+        PFX##_iter_init(&iter, _heap_);                                                     \
+        PFX##_iter_to_start(&iter);                                                         \
+                                                                                            \
+        return iter;                                                                        \
+    }                                                                                       \
+                                                                                            \
+    static SNAME##_iter PFX##_impl_it_end(SNAME *_heap_)                                    \
+    {                                                                                       \
+        SNAME##_iter iter;                                                                  \
+                                                                                            \
+        PFX##_iter_init(&iter, _heap_);                                                     \
+        PFX##_iter_to_end(&iter);                                                           \
+                                                                                            \
+        return iter;                                                                        \
+    }
+
+#endif /* CMC_INTERVALHEAP_H */

src/ext/linkedqueue.h

@@ -12,7 +12,7 @@
  * A node-based Queue using a Singly Linked List
  *
  * enqueue : is equivalent to a push_back from a LinkedList
- * dequeue : is equivalent to a pop_peek from a LinkedList
+ * dequeue : is equivalent to a pop_front from a LinkedList
  *
  * This Queue has a one-way iterator
  */

src/ext/multimap.h

@@ -0,0 +1,922 @@
+/**
+ * multimap.h
+ *
+ * Creation Date: 26/04/2019
+ *
+ * Authors:
+ * Leonardo Vencovsky (https://github.com/LeoVen)
+ *
+ */
+
+/**
+ * MultiMap
+ *
+ * The MultiMap is a Map that allows for multiple keys. This is a data structure
+ * that has a very narrow usage. A Map (either TreeMap or HashMap) can also work
+ * like a MultiMap if a certain key is mapped to another collection.
+ *
+ * Map<K = int, V = List<int>> maps an integer to a list of integer.
+ * MultiMap<K = int, V = int> maps many integer keys to integer values.
+ *
+ * The difference is that in a MultiMap you can store keys that are the same but
+ * might be different instances of the same value. This is also relevant if your
+ * data type is more complex like a struct where its ID is the same but some
+ * other members of this data type are different.
+ *
+ * Implementation
+ *
+ * The map uses separate chaining and robin hood hashing. Its internal buffer
+ * is made of a pair of pointers to entries that represent a linked list. So
+ * accessing map->buffer[0] would give the first pair of pointers. Each entry
+ * has both a pointer to a previous entry and a next entry. This design choice
+ * was made so that every collection in this library has a two-way iterator
+ * with a very few exceptions.
+ *
+ * Each entry is composed of a Key and a Value. Entries with the same key should
+ * always hash to the same linked list. Also, keys that hash to the same bucket
+ * will also be in the same linked list.
+ *
+ * The order of inserting and removing the same keys will behave like a FIFO. So
+ * the first key added will be the first to be removed.
+ */
+
+#ifndef CMC_MULTIMAP_H
+#define CMC_MULTIMAP_H
+
+#include <stdbool.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include "../utl/cmc_string.h"
+
+#ifndef CMC_HASH_TABLE_SETUP
+#define CMC_HASH_TABLE_SETUP
+
+static const size_t cmc_hashtable_primes[] = {53, 97, 191, 383, 769, 1531,
+                                              3067, 6143, 12289, 24571, 49157,
+                                              98299, 196613, 393209, 786431,
+                                              1572869, 3145721, 6291449,
+                                              12582917, 25165813, 50331653,
+                                              100663291, 201326611, 402653189,
+                                              805306357, 1610612741,
+                                              3221225473, 6442450939,
+                                              12884901893, 25769803799,
+                                              51539607551, 103079215111,
+                                              206158430209, 412316860441,
+                                              824633720831, 1649267441651,
+                                              3298534883309, 6597069766657,
+                                              13194139533299, 26388279066623,
+                                              52776558133303, 105553116266489,
+                                              211106232532969, 422212465066001,
+                                              844424930131963,
+                                              1688849860263953,
+                                              3377699720527861,
+                                              6755399441055731,
+                                              13510798882111483,
+                                              27021597764222939,
+                                              54043195528445957,
+                                              108086391056891903,
+                                              216172782113783773,
+                                              432345564227567621,
+                                              864691128455135207,
+                                              1729382256910270481,
+                                              3458764513820540933,
+                                              6917529027641081903,
+                                              13835058055282163729llu};
+
+#endif /* CMC_HASH_TABLE_SETUP */
+
+#define MULTIMAP_GENERATE(PFX, SNAME, FMOD, K, V)    \
+    MULTIMAP_GENERATE_HEADER(PFX, SNAME, FMOD, K, V) \
+    MULTIMAP_GENERATE_SOURCE(PFX, SNAME, FMOD, K, V)
+
+#define MULTIMAP_WRAPGEN_HEADER(PFX, SNAME, FMOD, K, V) \
+    MULTIMAP_GENERATE_HEADER(PFX, SNAME, FMOD, K, V)
+
+#define MULTIMAP_WRAPGEN_SOURCE(PFX, SNAME, FMOD, K, V) \
+    MULTIMAP_GENERATE_SOURCE(PFX, SNAME, FMOD, K, V)
+
+/* HEADER ********************************************************************/
+#define MULTIMAP_GENERATE_HEADER(PFX, SNAME, FMOD, K, V)                                          \
+                                                                                                  \
+    /* Multimap Structure */                                                                      \
+    typedef struct SNAME##_s                                                                      \
+    {                                                                                             \
+        /* Array of linked list to entries */                                                     \
+        struct SNAME##_entry_s *(*buffer)[2];                                                     \
+                                                                                                  \
+        /* Current array capacity */                                                              \
+        size_t capacity;                                                                          \
+                                                                                                  \
+        /* Current amount of keys */                                                              \
+        size_t count;                                                                             \
+                                                                                                  \
+        /* Load factor in range (0.0, infinity) */                                                \
+        double load;                                                                              \
+                                                                                                  \
+        /* Key comparison functions */                                                            \
+        int (*cmp)(K, K);                                                                         \
+                                                                                                  \
+        /* Key hash function */                                                                   \
+        size_t (*hash)(K);                                                                        \
+                                                                                                  \
+        /* Function that returns an iterator to the start of the multimap */                      \
+        struct SNAME##_iter_s (*it_start)(struct SNAME##_s *);                                    \
+                                                                                                  \
+        /* Function that returns an iterator to the end of the multimap */                        \
+        struct SNAME##_iter_s (*it_end)(struct SNAME##_s *);                                      \
+                                                                                                  \
+    } SNAME, *SNAME##_ptr;                                                                        \
+                                                                                                  \
+    /* Multimap Entry */                                                                          \
+    typedef struct SNAME##_entry_s                                                                \
+    {                                                                                             \
+        /* Entry Key */                                                                           \
+        K key;                                                                                    \
+                                                                                                  \
+        /* Entry Value */                                                                         \
+        V value;                                                                                  \
+                                                                                                  \
+        /* Next entry on the linked list */                                                       \
+        struct SNAME##_entry_s *next;                                                             \
+                                                                                                  \
+        /* Previous entry on the linked list */                                                   \
+        struct SNAME##_entry_s *prev;                                                             \
+                                                                                                  \
+    } SNAME##_entry, *SNAME##_entry_ptr;                                                          \
+                                                                                                  \
+    typedef struct SNAME##_iter_s                                                                 \
+    {                                                                                             \
+        /* Target multimap */                                                                     \
+        struct SNAME##_s *target;                                                                 \
+                                                                                                  \
+        /* Current entry */                                                                       \
+        struct SNAME##_entry_s *curr_entry;                                                       \
+                                                                                                  \
+        /* Cursor`s position (index) */                                                           \
+        size_t cursor;                                                                            \
+                                                                                                  \
+        /* Keeps track of relative index to the iteration of elements */                          \
+        size_t index;                                                                             \
+                                                                                                  \
+        /* The index of the first element */                                                      \
+        size_t first;                                                                             \
+                                                                                                  \
+        /* The index of the last element */                                                       \
+        size_t last;                                                                              \
+                                                                                                  \
+        /* If the iterator has reached the start of the iteration */                              \
+        bool start;                                                                               \
+                                                                                                  \
+        /* If the iterator has reached the end of the iteration */                                \
+        bool end;                                                                                 \
+    } SNAME##_iter, *SNAME##_iter_ptr;                                                            \
+                                                                                                  \
+    /* Collection Functions */                                                                    \
+    /* Collection Allocation and Deallocation */                                                  \
+    FMOD SNAME *PFX##_new(size_t capacity, double load, int (*compare)(K, K), size_t (*hash)(K)); \
+    FMOD void PFX##_clear(SNAME *_map_);                                                          \
+    FMOD void PFX##_free(SNAME *_map_);                                                           \
+    /* Collection Input and Output */                                                             \
+    FMOD bool PFX##_insert(SNAME *_map_, K key, V value);                                         \
+    FMOD bool PFX##_update(SNAME *_map_, K key, V new_value);                                     \
+    FMOD size_t PFX##_update_all(SNAME *_map_, K key, V new_value);                               \
+    FMOD bool PFX##_remove(SNAME *_map_, K key, V *value);                                        \
+    FMOD size_t PFX##_remove_all(SNAME *_map_, K key);                                            \
+    /* Conditional Input and Output */                                                            \
+    FMOD bool PFX##_insert_if(SNAME *_map_, K key, V value, bool condition);                      \
+    FMOD bool PFX##_remove_if(SNAME *_map_, K key, V *value, bool condition);                     \
+    /* Element Access */                                                                          \
+    FMOD bool PFX##_max(SNAME *_map_, K *key, V *value);                                          \
+    FMOD bool PFX##_min(SNAME *_map_, K *key, V *value);                                          \
+    FMOD V PFX##_get(SNAME *_map_, K key);                                                        \
+    FMOD V *PFX##_get_ref(SNAME *_map_, K key);                                                   \
+    /* Collection State */                                                                        \
+    FMOD bool PFX##_contains(SNAME *_map_, K key);                                                \
+    FMOD bool PFX##_empty(SNAME *_map_);                                                          \
+    FMOD size_t PFX##_count(SNAME *_map_);                                                        \
+    FMOD size_t PFX##_capacity(SNAME *_map_);                                                     \
+    /* Collection Utility */                                                                      \
+    FMOD cmc_string PFX##_to_string(SNAME *_map_);                                                \
+                                                                                                  \
+    /* Iterator Functions */                                                                      \
+    /* Iterator Allocation and Deallocation */                                                    \
+    FMOD SNAME##_iter *PFX##_iter_new(SNAME *target);                                             \
+    FMOD void PFX##_iter_free(SNAME##_iter *iter);                                                \
+    /* Iterator Initialization */                                                                 \
+    FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target);                                 \
+    /* Iterator State */                                                                          \
+    FMOD bool PFX##_iter_start(SNAME##_iter *iter);                                               \
+    FMOD bool PFX##_iter_end(SNAME##_iter *iter);                                                 \
+    /* Iterator Movement */                                                                       \
+    FMOD void PFX##_iter_to_start(SNAME##_iter *iter);                                            \
+    FMOD void PFX##_iter_to_end(SNAME##_iter *iter);                                              \
+    FMOD bool PFX##_iter_next(SNAME##_iter *iter);                                                \
+    FMOD bool PFX##_iter_prev(SNAME##_iter *iter);                                                \
+    /* Iterator Access */                                                                         \
+    FMOD K PFX##_iter_key(SNAME##_iter *iter);                                                    \
+    FMOD V PFX##_iter_value(SNAME##_iter *iter);                                                  \
+    FMOD V *PFX##_iter_rvalue(SNAME##_iter *iter);                                                \
+    FMOD size_t PFX##_iter_index(SNAME##_iter *iter);                                             \
+                                                                                                  \
+    /* Default Key */                                                                             \
+    static inline K PFX##_impl_default_key(void)                                                  \
+    {                                                                                             \
+        K _empty_key_;                                                                            \
+                                                                                                  \
+        memset(&_empty_key_, 0, sizeof(K));                                                       \
+                                                                                                  \
+        return _empty_key_;                                                                       \
+    }                                                                                             \
+                                                                                                  \
+    /* Default Value */                                                                           \
+    static inline V PFX##_impl_default_value(void)                                                \
+    {                                                                                             \
+        V _empty_value_;                                                                          \
+                                                                                                  \
+        memset(&_empty_value_, 0, sizeof(V));                                                     \
+                                                                                                  \
+        return _empty_value_;                                                                     \
+    }                                                                                             \
+/* SOURCE ********************************************************************/
+#define MULTIMAP_GENERATE_SOURCE(PFX, SNAME, FMOD, K, V)                                         \
+                                                                                                 \
+    /* Implementation Detail Functions */                                                        \
+    FMOD bool PFX##_impl_grow(SNAME *_map_);                                                     \
+    FMOD SNAME##_entry *PFX##_impl_new_entry(K key, V value);                                    \
+    FMOD SNAME##_entry *PFX##_impl_get_entry(SNAME *_map_, K key);                               \
+    FMOD size_t PFX##_impl_calculate_size(size_t required);                                      \
+    static SNAME##_iter PFX##_impl_it_start(SNAME *_map_);                                       \
+    static SNAME##_iter PFX##_impl_it_end(SNAME *_map_);                                         \
+                                                                                                 \
+    FMOD SNAME *PFX##_new(size_t capacity, double load, int (*compare)(K, K), size_t (*hash)(K)) \
+    {                                                                                            \
+        if (capacity == 0 || load <= 0)                                                          \
+            return NULL;                                                                         \
+                                                                                                 \
+        /* Prevent integer overflow */                                                           \
+        if (capacity >= UINTMAX_MAX * load)                                                      \
+            return NULL;                                                                         \
+                                                                                                 \
+        size_t real_capacity = PFX##_impl_calculate_size(capacity / load);                       \
+                                                                                                 \
+        SNAME *_map_ = malloc(sizeof(SNAME));                                                    \
+                                                                                                 \
+        if (!_map_)                                                                              \
+            return NULL;                                                                         \
+                                                                                                 \
+        _map_->buffer = malloc(sizeof(SNAME##_entry_ptr[2]) * real_capacity);                    \
+                                                                                                 \
+        if (!_map_->buffer)                                                                      \
+        {                                                                                        \
+            free(_map_);                                                                         \
+            return NULL;                                                                         \
+        }                                                                                        \
+                                                                                                 \
+        memset(_map_->buffer, 0, sizeof(SNAME##_entry_ptr[2]) * real_capacity);                  \
+                                                                                                 \
+        _map_->count = 0;                                                                        \
+        _map_->capacity = real_capacity;                                                         \
+        _map_->load = load;                                                                      \
+        _map_->cmp = compare;                                                                    \
+        _map_->hash = hash;                                                                      \
+                                                                                                 \
+        return _map_;                                                                            \
+    }                                                                                            \
+                                                                                                 \
+    FMOD void PFX##_clear(SNAME *_map_)                                                          \
+    {                                                                                            \
+        size_t index = 0;                                                                        \
+        SNAME##_entry *scan;                                                                     \
+                                                                                                 \
+        while (index < _map_->capacity)                                                          \
+        {                                                                                        \
+            scan = _map_->buffer[index][0];                                                      \
+                                                                                                 \
+            if (scan != NULL)                                                                    \
+            {                                                                                    \
+                if (scan->next == NULL && scan->prev == NULL)                                    \
+                    free(scan);                                                                  \
+                else                                                                             \
+                {                                                                                \
+                    while (scan != NULL)                                                         \
+                    {                                                                            \
+                        SNAME##_entry *tmp = scan;                                               \
+                                                                                                 \
+                        scan = scan->next;                                                       \
+                                                                                                 \
+                        free(tmp);                                                               \
+                    }                                                                            \
+                }                                                                                \
+            }                                                                                    \
+                                                                                                 \
+            index++;                                                                             \
+        }                                                                                        \
+                                                                                                 \
+        memset(_map_->buffer, 0, sizeof(SNAME##_entry_ptr[2]) * _map_->capacity);                \
+                                                                                                 \
+        _map_->count = 0;                                                                        \
+    }                                                                                            \
+                                                                                                 \
+    FMOD void PFX##_free(SNAME *_map_)                                                           \
+    {                                                                                            \
+        PFX##_clear(_map_);                                                                      \
+        free(_map_->buffer);                                                                     \
+        free(_map_);                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_insert(SNAME *_map_, K key, V value)                                         \
+    {                                                                                            \
+        if ((double)_map_->capacity * _map_->load <= (double)_map_->count)                       \
+        {                                                                                        \
+            if (!PFX##_impl_grow(_map_))                                                         \
+                return false;                                                                    \
+        }                                                                                        \
+                                                                                                 \
+        size_t hash = _map_->hash(key);                                                          \
+        size_t pos = hash % _map_->capacity;                                                     \
+                                                                                                 \
+        SNAME##_entry *entry = PFX##_impl_new_entry(key, value);                                 \
+                                                                                                 \
+        if (_map_->buffer[pos][0] == NULL)                                                       \
+        {                                                                                        \
+            _map_->buffer[pos][0] = entry;                                                       \
+            _map_->buffer[pos][1] = entry;                                                       \
+        }                                                                                        \
+        else                                                                                     \
+        {                                                                                        \
+            entry->prev = _map_->buffer[pos][1];                                                 \
+                                                                                                 \
+            _map_->buffer[pos][1]->next = entry;                                                 \
+            _map_->buffer[pos][1] = entry;                                                       \
+        }                                                                                        \
+                                                                                                 \
+        _map_->count++;                                                                          \
+                                                                                                 \
+        return true;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_update(SNAME *_map_, K key, V new_value)                                     \
+    {                                                                                            \
+        size_t hash = _map_->hash(key);                                                          \
+                                                                                                 \
+        SNAME##_entry *entry = _map_->buffer[hash % _map_->capacity][0];                         \
+                                                                                                 \
+        while (entry != NULL)                                                                    \
+        {                                                                                        \
+            if (_map_->cmp(entry->key, key) == 0)                                                \
+            {                                                                                    \
+                entry->value = new_value;                                                        \
+                                                                                                 \
+                return true;                                                                     \
+            }                                                                                    \
+                                                                                                 \
+            entry = entry->next;                                                                 \
+        }                                                                                        \
+                                                                                                 \
+        return false;                                                                            \
+    }                                                                                            \
+                                                                                                 \
+    FMOD size_t PFX##_update_all(SNAME *_map_, K key, V new_value)                               \
+    {                                                                                            \
+        size_t hash = _map_->hash(key);                                                          \
+                                                                                                 \
+        SNAME##_entry *entry = _map_->buffer[hash % _map_->capacity][0];                         \
+                                                                                                 \
+        size_t total = 0;                                                                        \
+                                                                                                 \
+        while (entry != NULL)                                                                    \
+        {                                                                                        \
+            if (_map_->cmp(entry->key, key) == 0)                                                \
+            {                                                                                    \
+                entry->value = new_value;                                                        \
+                                                                                                 \
+                total++;                                                                         \
+            }                                                                                    \
+        }                                                                                        \
+                                                                                                 \
+        return total;                                                                            \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_remove(SNAME *_map_, K key, V *value)                                        \
+    {                                                                                            \
+        size_t hash = _map_->hash(key);                                                          \
+                                                                                                 \
+        SNAME##_entry **head = &(_map_->buffer[hash % _map_->capacity][0]);                      \
+        SNAME##_entry **tail = &(_map_->buffer[hash % _map_->capacity][1]);                      \
+                                                                                                 \
+        if (*head == NULL)                                                                       \
+            return false;                                                                        \
+                                                                                                 \
+        SNAME##_entry *entry = *head;                                                            \
+                                                                                                 \
+        if (entry->next == NULL && entry->prev == NULL)                                          \
+        {                                                                                        \
+            if (_map_->cmp(entry->key, key) == 0)                                                \
+            {                                                                                    \
+                *head = NULL;                                                                    \
+                *tail = NULL;                                                                    \
+                                                                                                 \
+                *value = entry->value;                                                           \
+            }                                                                                    \
+            else                                                                                 \
+                return false;                                                                    \
+        }                                                                                        \
+        else                                                                                     \
+        {                                                                                        \
+            bool found = false;                                                                  \
+                                                                                                 \
+            while (entry != NULL)                                                                \
+            {                                                                                    \
+                if (_map_->cmp(entry->key, key) == 0)                                            \
+                {                                                                                \
+                    if (*head == entry)                                                          \
+                        *head = entry->next;                                                     \
+                    if (*tail == entry)                                                          \
+                        *tail = entry->prev;                                                     \
+                                                                                                 \
+                    if (entry->prev != NULL)                                                     \
+                        entry->prev->next = entry->next;                                         \
+                    if (entry->next != NULL)                                                     \
+                        entry->next->prev = entry->prev;                                         \
+                                                                                                 \
+                    *value = entry->value;                                                       \
+                    found = true;                                                                \
+                                                                                                 \
+                    break;                                                                       \
+                }                                                                                \
+                else                                                                             \
+                    entry = entry->next;                                                         \
+            }                                                                                    \
+                                                                                                 \
+            if (!found)                                                                          \
+                return false;                                                                    \
+        }                                                                                        \
+                                                                                                 \
+        free(entry);                                                                             \
+                                                                                                 \
+        _map_->count--;                                                                          \
+                                                                                                 \
+        return true;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD size_t PFX##_remove_all(SNAME *_map_, K key)                                            \
+    {                                                                                            \
+        size_t total = 0;                                                                        \
+        size_t hash = _map_->hash(key);                                                          \
+                                                                                                 \
+        SNAME##_entry **head = &(_map_->buffer[hash % _map_->capacity][0]);                      \
+        SNAME##_entry **tail = &(_map_->buffer[hash % _map_->capacity][1]);                      \
+                                                                                                 \
+        if (*head == NULL)                                                                       \
+            return total;                                                                        \
+                                                                                                 \
+        SNAME##_entry *entry = *head;                                                            \
+                                                                                                 \
+        if (entry->next == NULL)                                                                 \
+        {                                                                                        \
+            *head = NULL;                                                                        \
+            *tail = NULL;                                                                        \
+                                                                                                 \
+            free(entry);                                                                         \
+                                                                                                 \
+            total++;                                                                             \
+        }                                                                                        \
+        else                                                                                     \
+        {                                                                                        \
+            while (entry != NULL)                                                                \
+            {                                                                                    \
+                if (_map_->cmp(entry->key, key) == 0)                                            \
+                {                                                                                \
+                    if (*head == entry)                                                          \
+                        *head = entry->next;                                                     \
+                    if (*tail == entry)                                                          \
+                        *tail = entry->prev;                                                     \
+                                                                                                 \
+                    SNAME##_entry *temp = entry->next;                                           \
+                                                                                                 \
+                    if (entry->prev != NULL)                                                     \
+                        entry->prev->next = entry->next;                                         \
+                    if (entry->next != NULL)                                                     \
+                        entry->next->prev = entry->prev;                                         \
+                                                                                                 \
+                    free(entry);                                                                 \
+                    entry = temp;                                                                \
+                                                                                                 \
+                    total++;                                                                     \
+                }                                                                                \
+                else                                                                             \
+                    entry = entry->next;                                                         \
+            }                                                                                    \
+        }                                                                                        \
+                                                                                                 \
+        _map_->count -= total;                                                                   \
+                                                                                                 \
+        return total;                                                                            \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_insert_if(SNAME *_map_, K key, V value, bool condition)                      \
+    {                                                                                            \
+        if (condition)                                                                           \
+            return PFX##_insert(_map_, key, value);                                              \
+                                                                                                 \
+        return false;                                                                            \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_remove_if(SNAME *_map_, K key, V *value, bool condition)                     \
+    {                                                                                            \
+        if (condition)                                                                           \
+            return PFX##_remove(_map_, key, value);                                              \
+                                                                                                 \
+        return false;                                                                            \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_max(SNAME *_map_, K *key, V *value)                                          \
+    {                                                                                            \
+        if (PFX##_empty(_map_))                                                                  \
+            return false;                                                                        \
+                                                                                                 \
+        SNAME##_iter iter;                                                                       \
+                                                                                                 \
+        for (PFX##_iter_init(&iter, _map_); !PFX##_iter_end(&iter); PFX##_iter_next(&iter))      \
+        {                                                                                        \
+            K result_key = PFX##_iter_key(&iter);                                                \
+            V result_value = PFX##_iter_value(&iter);                                            \
+            size_t index = PFX##_iter_index(&iter);                                              \
+                                                                                                 \
+            if (index == 0)                                                                      \
+            {                                                                                    \
+                *key = result_key;                                                               \
+                *value = result_value;                                                           \
+            }                                                                                    \
+            else if (_map_->cmp(result_key, *key) > 0)                                           \
+            {                                                                                    \
+                *key = result_key;                                                               \
+                *value = result_value;                                                           \
+            }                                                                                    \
+        }                                                                                        \
+                                                                                                 \
+        return true;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_min(SNAME *_map_, K *key, V *value)                                          \
+    {                                                                                            \
+        if (PFX##_empty(_map_))                                                                  \
+            return false;                                                                        \
+                                                                                                 \
+        SNAME##_iter iter;                                                                       \
+                                                                                                 \
+        for (PFX##_iter_init(&iter, _map_); !PFX##_iter_end(&iter); PFX##_iter_next(&iter))      \
+        {                                                                                        \
+            K result_key = PFX##_iter_key(&iter);                                                \
+            V result_value = PFX##_iter_value(&iter);                                            \
+            size_t index = PFX##_iter_index(&iter);                                              \
+                                                                                                 \
+            if (index == 0)                                                                      \
+            {                                                                                    \
+                *key = result_key;                                                               \
+                *value = result_value;                                                           \
+            }                                                                                    \
+            else if (_map_->cmp(result_key, *key) < 0)                                           \
+            {                                                                                    \
+                *key = result_key;                                                               \
+                *value = result_value;                                                           \
+            }                                                                                    \
+        }                                                                                        \
+                                                                                                 \
+        return true;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD V PFX##_get(SNAME *_map_, K key)                                                        \
+    {                                                                                            \
+        SNAME##_entry *entry = PFX##_impl_get_entry(_map_, key);                                 \
+                                                                                                 \
+        if (!entry)                                                                              \
+            return PFX##_impl_default_value();                                                   \
+                                                                                                 \
+        return entry->value;                                                                     \
+    }                                                                                            \
+                                                                                                 \
+    FMOD V *PFX##_get_ref(SNAME *_map_, K key)                                                   \
+    {                                                                                            \
+        SNAME##_entry *entry = PFX##_impl_get_entry(_map_, key);                                 \
+                                                                                                 \
+        if (!entry)                                                                              \
+            return NULL;                                                                         \
+                                                                                                 \
+        return &(entry->value);                                                                  \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_contains(SNAME *_map_, K key)                                                \
+    {                                                                                            \
+        return PFX##_impl_get_entry(_map_, key) != NULL;                                         \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_empty(SNAME *_map_)                                                          \
+    {                                                                                            \
+        return _map_->count == 0;                                                                \
+    }                                                                                            \
+                                                                                                 \
+    FMOD size_t PFX##_count(SNAME *_map_)                                                        \
+    {                                                                                            \
+        return _map_->count;                                                                     \
+    }                                                                                            \
+                                                                                                 \
+    FMOD size_t PFX##_capacity(SNAME *_map_)                                                     \
+    {                                                                                            \
+        return _map_->capacity;                                                                  \
+    }                                                                                            \
+                                                                                                 \
+    FMOD cmc_string PFX##_to_string(SNAME *_map_)                                                \
+    {                                                                                            \
+        cmc_string str;                                                                          \
+        SNAME *m_ = _map_;                                                                       \
+        const char *name = #SNAME;                                                               \
+                                                                                                 \
+        snprintf(str.s, cmc_string_len, cmc_string_fmt_hashmap,                                  \
+                 name, m_, m_->buffer, m_->capacity, m_->count, m_->load, m_->cmp, m_->hash);    \
+                                                                                                 \
+        return str;                                                                              \
+    }                                                                                            \
+                                                                                                 \
+    FMOD SNAME##_iter *PFX##_iter_new(SNAME *target)                                             \
+    {                                                                                            \
+        SNAME##_iter *iter = malloc(sizeof(SNAME##_iter));                                       \
+                                                                                                 \
+        if (!iter)                                                                               \
+            return NULL;                                                                         \
+                                                                                                 \
+        PFX##_iter_init(iter, target);                                                           \
+                                                                                                 \
+        return iter;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD void PFX##_iter_free(SNAME##_iter *iter)                                                \
+    {                                                                                            \
+        free(iter);                                                                              \
+    }                                                                                            \
+                                                                                                 \
+    FMOD void PFX##_iter_init(SNAME##_iter *iter, SNAME *target)                                 \
+    {                                                                                            \
+        iter->target = target;                                                                   \
+        iter->cursor = 0;                                                                        \
+        iter->index = 0;                                                                         \
+        iter->start = true;                                                                      \
+        iter->end = PFX##_empty(target);                                                         \
+                                                                                                 \
+        if (!PFX##_empty(target))                                                                \
+        {                                                                                        \
+            for (size_t i = 0; i < target->capacity; i++)                                        \
+            {                                                                                    \
+                if (target->buffer[i][0] != NULL)                                                \
+                {                                                                                \
+                    iter->curr_entry = target->buffer[i][0];                                     \
+                    iter->first = i;                                                             \
+                    break;                                                                       \
+                }                                                                                \
+            }                                                                                    \
+                                                                                                 \
+            iter->cursor = iter->first;                                                          \
+                                                                                                 \
+            for (size_t i = target->capacity; i > 0; i--)                                        \
+            {                                                                                    \
+                if (target->buffer[i - 1][0] != NULL)                                            \
+                {                                                                                \
+                    iter->last = i - 1;                                                          \
+                    break;                                                                       \
+                }                                                                                \
+            }                                                                                    \
+        }                                                                                        \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_iter_start(SNAME##_iter *iter)                                               \
+    {                                                                                            \
+        return PFX##_empty(iter->target) || iter->start;                                         \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_iter_end(SNAME##_iter *iter)                                                 \
+    {                                                                                            \
+        return PFX##_empty(iter->target) || iter->end;                                           \
+    }                                                                                            \
+                                                                                                 \
+    FMOD void PFX##_iter_to_start(SNAME##_iter *iter)                                            \
+    {                                                                                            \
+        iter->cursor = iter->first;                                                              \
+        iter->index = 0;                                                                         \
+        iter->start = true;                                                                      \
+        iter->end = PFX##_empty(iter->target);                                                   \
+        iter->curr_entry = iter->target->buffer[iter->first][0];                                 \
+    }                                                                                            \
+                                                                                                 \
+    FMOD void PFX##_iter_to_end(SNAME##_iter *iter)                                              \
+    {                                                                                            \
+        iter->cursor = iter->last;                                                               \
+        iter->index = iter->target->count - 1;                                                   \
+        iter->start = PFX##_empty(iter->target);                                                 \
+        iter->end = true;                                                                        \
+        iter->curr_entry = iter->target->buffer[iter->last][1];                                  \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_iter_next(SNAME##_iter *iter)                                                \
+    {                                                                                            \
+        if (iter->end)                                                                           \
+            return false;                                                                        \
+                                                                                                 \
+        if (iter->curr_entry->next != NULL)                                                      \
+        {                                                                                        \
+            iter->curr_entry = iter->curr_entry->next;                                           \
+            iter->index++;                                                                       \
+        }                                                                                        \
+        else                                                                                     \
+        {                                                                                        \
+            if (iter->cursor == iter->last)                                                      \
+            {                                                                                    \
+                iter->end = true;                                                                \
+                return false;                                                                    \
+            }                                                                                    \
+            else                                                                                 \
+            {                                                                                    \
+                iter->cursor++;                                                                  \
+                                                                                                 \
+                while (iter->target->buffer[iter->cursor][0] == NULL)                            \
+                    iter->cursor++;                                                              \
+                                                                                                 \
+                iter->curr_entry = iter->target->buffer[iter->cursor][0];                        \
+                                                                                                 \
+                iter->index++;                                                                   \
+            }                                                                                    \
+        }                                                                                        \
+                                                                                                 \
+        iter->start = PFX##_empty(iter->target);                                                 \
+                                                                                                 \
+        return true;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_iter_prev(SNAME##_iter *iter)                                                \
+    {                                                                                            \
+        if (iter->start)                                                                         \
+            return false;                                                                        \
+                                                                                                 \
+        if (iter->curr_entry->prev != NULL)                                                      \
+        {                                                                                        \
+            iter->curr_entry = iter->curr_entry->prev;                                           \
+            iter->index--;                                                                       \
+        }                                                                                        \
+        else                                                                                     \
+        {                                                                                        \
+            if (iter->cursor == iter->first)                                                     \
+            {                                                                                    \
+                iter->start = true;                                                              \
+                return false;                                                                    \
+            }                                                                                    \
+            else                                                                                 \
+            {                                                                                    \
+                iter->cursor--;                                                                  \
+                                                                                                 \
+                while (iter->target->buffer[iter->cursor][1] == NULL)                            \
+                    iter->cursor--;                                                              \
+                                                                                                 \
+                iter->curr_entry = iter->target->buffer[iter->cursor][1];                        \
+                                                                                                 \
+                iter->index--;                                                                   \
+            }                                                                                    \
+        }                                                                                        \
+                                                                                                 \
+        iter->end = PFX##_empty(iter->target);                                                   \
+                                                                                                 \
+        return true;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD K PFX##_iter_key(SNAME##_iter *iter)                                                    \
+    {                                                                                            \
+        if (PFX##_empty(iter->target))                                                           \
+            return PFX##_impl_default_key();                                                     \
+                                                                                                 \
+        return iter->curr_entry->key;                                                            \
+    }                                                                                            \
+                                                                                                 \
+    FMOD V PFX##_iter_value(SNAME##_iter *iter)                                                  \
+    {                                                                                            \
+        if (PFX##_empty(iter->target))                                                           \
+            return PFX##_impl_default_value();                                                   \
+                                                                                                 \
+        return iter->curr_entry->value;                                                          \
+    }                                                                                            \
+                                                                                                 \
+    FMOD V *PFX##_iter_rvalue(SNAME##_iter *iter)                                                \
+    {                                                                                            \
+        if (PFX##_empty(iter->target))                                                           \
+            return NULL;                                                                         \
+                                                                                                 \
+        return &(iter->curr_entry->value);                                                       \
+    }                                                                                            \
+                                                                                                 \
+    FMOD size_t PFX##_iter_index(SNAME##_iter *iter)                                             \
+    {                                                                                            \
+        return iter->index;                                                                      \
+    }                                                                                            \
+                                                                                                 \
+    FMOD bool PFX##_impl_grow(SNAME *_map_)                                                      \
+    {                                                                                            \
+        size_t new_capacity = PFX##_impl_calculate_size(_map_->capacity * 1.5);                  \
+                                                                                                 \
+        SNAME *_new_map_ = PFX##_new(new_capacity, _map_->load, _map_->cmp, _map_->hash);        \
+                                                                                                 \
+        if (!_new_map_)                                                                          \
+            return false;                                                                        \
+                                                                                                 \
+        SNAME##_iter iter;                                                                       \
+                                                                                                 \
+        for (PFX##_iter_init(&iter, _map_); !PFX##_iter_end(&iter); PFX##_iter_next(&iter))      \
+        {                                                                                        \
+            K key = PFX##_iter_key(&iter);                                                       \
+            V value = PFX##_iter_value(&iter);                                                   \
+                                                                                                 \
+            PFX##_insert(_new_map_, key, value);                                                 \
+        }                                                                                        \
+                                                                                                 \
+        if (_map_->count != _new_map_->count)                                                    \
+        {                                                                                        \
+            PFX##_free(_new_map_);                                                               \
+            return false;                                                                        \
+        }                                                                                        \
+                                                                                                 \
+        SNAME##_entry *(*tmp_b)[2] = _map_->buffer;                                              \
+        _map_->buffer = _new_map_->buffer;                                                       \
+        _new_map_->buffer = tmp_b;                                                               \
+                                                                                                 \
+        size_t tmp_c = _map_->capacity;                                                          \
+        _map_->capacity = _new_map_->capacity;                                                   \
+        _new_map_->capacity = tmp_c;                                                             \
+                                                                                                 \
+        PFX##_free(_new_map_);                                                                   \
+                                                                                                 \
+        return true;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD SNAME##_entry *PFX##_impl_new_entry(K key, V value)                                     \
+    {                                                                                            \
+        SNAME##_entry *entry = malloc(sizeof(SNAME##_entry));                                    \
+                                                                                                 \
+        if (!entry)                                                                              \
+            return NULL;                                                                         \
+                                                                                                 \
+        entry->key = key;                                                                        \
+        entry->value = value;                                                                    \
+        entry->next = NULL;                                                                      \
+        entry->prev = NULL;                                                                      \
+                                                                                                 \
+        return entry;                                                                            \
+    }                                                                                            \
+                                                                                                 \
+    FMOD SNAME##_entry *PFX##_impl_get_entry(SNAME *_map_, K key)                                \
+    {                                                                                            \
+        size_t hash = _map_->hash(key);                                                          \
+                                                                                                 \
+        SNAME##_entry *entry = _map_->buffer[hash % _map_->capacity][0];                         \
+                                                                                                 \
+        while (entry != NULL)                                                                    \
+        {                                                                                        \
+            if (_map_->cmp(entry->key, key) == 0)                                                \
+                return entry;                                                                    \
+                                                                                                 \
+            entry = entry->next;                                                                 \
+        }                                                                                        \
+                                                                                                 \
+        return NULL;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    FMOD size_t PFX##_impl_calculate_size(size_t required)                                       \
+    {                                                                                            \
+        const size_t count = sizeof(cmc_hashtable_primes) / sizeof(cmc_hashtable_primes[0]);     \
+                                                                                                 \
+        if (cmc_hashtable_primes[count - 1] < required)                                          \
+            return required;                                                                     \
+                                                                                                 \
+        size_t i = 0;                                                                            \
+        while (cmc_hashtable_primes[i] < required)                                               \
+            i++;                                                                                 \
+                                                                                                 \
+        return cmc_hashtable_primes[i];                                                          \
+    }                                                                                            \
+                                                                                                 \
+    static SNAME##_iter PFX##_impl_it_start(SNAME *_map_)                                        \
+    {                                                                                            \
+        SNAME##_iter iter;                                                                       \
+                                                                                                 \
+        PFX##_iter_init(&iter, _map_);                                                           \
+                                                                                                 \
+        return iter;                                                                             \
+    }                                                                                            \
+                                                                                                 \
+    static SNAME##_iter PFX##_impl_it_end(SNAME *_map_)                                          \
+    {                                                                                            \
+        SNAME##_iter iter;                                                                       \
+                                                                                                 \
+        PFX##_iter_init(&iter, _map_);                                                           \
+        PFX##_iter_to_end(&iter);                                                                \
+                                                                                                 \
+        return iter;                                                                             \
+    }
+
+#endif /* CMC_MULTIMAP_H */

src/macro_collections.h

@@ -40,7 +40,10 @@
 #include "cmc/treemap.h"
 #include "cmc/treeset.h"
 
+#include "ext/intervalheap.h"
 #include "ext/linkedqueue.h"
+#include "ext/multimap.h"
+#include "ext/multiset.h"
 
 #include "sac/queue.h"
 #include "sac/stack.h"

src/utl/assert.h

@@ -38,6 +38,7 @@
  * - float
  * - double
  * - ptr
+ * - bool (only for equals and not_equals)
  *
  */
 
@@ -369,6 +370,22 @@
                                                                                           \
     } while (0)
 
+#define cmc_assert_equals__Bool(expected, actual)                                          \
+    do                                                                                    \
+    {                                                                                     \
+        const char *str = #actual;                                                        \
+        bool expected_ = (expected);                                                      \
+        bool actual_ = (actual);                                                          \
+                                                                                          \
+        if ((expected_) != (actual_))                                                     \
+        {                                                                                 \
+            fprintf(stderr,                                                               \
+                    "Assertion Failed at %s:%s:%u for { %s }: Expected: %d Actual: %d\n", \
+                    __FILE__, __func__, __LINE__, str, expected_, actual_);               \
+        }                                                                                 \
+                                                                                          \
+    } while (0)
+
 #define cmc_assert_not_equals_int8_t(not_expected, actual)                                                    \
     do                                                                                                        \
     {                                                                                                         \
@@ -593,6 +610,22 @@
                                                                                               \
     } while (0)
 
+#define cmc_assert_not_equals__Bool(expected, actual)                                          \
+    do                                                                                        \
+    {                                                                                         \
+        const char *str = #actual;                                                            \
+        bool expected_ = (expected);                                                          \
+        bool actual_ = (actual);                                                              \
+                                                                                              \
+        if ((expected_) != (actual_))                                                         \
+        {                                                                                     \
+            fprintf(stderr,                                                                   \
+                    "Assertion Failed at %s:%s:%u for { %s }: Not Expected: %d Actual: %d\n", \
+                    __FILE__, __func__, __LINE__, str, expected_, actual_);                   \
+        }                                                                                     \
+                                                                                              \
+    } while (0)
+
 #define cmc_assert_greater_int8_t(boundary, actual)                                                                          \
     do                                                                                                                       \
     {                                                                                                                        \

src/utl/cmc_string.h

@@ -0,0 +1,42 @@
+/**
+ * cmc_string.h
+ *
+ * Creation Date: 17/07/2019
+ *
+ * Authors:
+ * Leonardo Vencovsky (https://github.com/LeoVen)
+ *
+ */
+
+/* A very simple fixed size string used by all collections' method to_string */
+
+#ifndef CMC_STRING_H
+#define CMC_STRING_H
+
+#include <stddef.h>
+#include <inttypes.h>
+
+static const size_t cmc_string_len = 200;
+
+typedef struct cmc_string_s
+{
+    char s[200];
+} cmc_string;
+
+/* to_string formats */
+static const char *cmc_string_fmt_deque = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX ", front:%" PRIuMAX ", back:%" PRIuMAX " }";
+static const char *cmc_string_fmt_hashmap = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX ", load:%lf, cmp:%p, hash:%p }";
+static const char *cmc_string_fmt_hashset = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX ", load:%lf, cmp:%p, hash:%p }";
+static const char *cmc_string_fmt_heap = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX ", type:%s, cmp:%p }";
+static const char *cmc_string_fmt_linkedlist = "%s at %p { count:%" PRIuMAX ", head:%p, tail:%p }";
+static const char *cmc_string_fmt_list = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX " }";
+static const char *cmc_string_fmt_queue = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX ", front:%" PRIuMAX ", back:%" PRIuMAX " }";
+static const char *cmc_string_fmt_stack = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX " }";
+static const char *cmc_string_fmt_treemap = "%s at %p { root:%p, count:%" PRIuMAX ", cmp:%p }";
+static const char *cmc_string_fmt_treeset = "%s at %p { root:%p, count:%" PRIuMAX ", cmp:%p }";
+
+static const char *cmc_string_fmt_intervalheap = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", size:%" PRIuMAX ", count:%" PRIuMAX ", cmp:%p }";
+static const char *cmc_string_fmt_multimap = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX ", load:%lf, cmp:%p, hash:%p }";
+static const char *cmc_string_fmt_multiset = "%s at %p { buffer:%p, capacity:%" PRIuMAX ", count:%" PRIuMAX ", cardinality:%" PRIuMAX ", load:%lf, cmp:%p, hash:%p }";;
+
+#endif /* CMC_STRING_H */

src/utl/test.h

@@ -98,7 +98,7 @@ static void cmc_test_log(const char *unit_name, const char *current_test, bool a
         const char *current_test = NULL;                                                    \
                                                                                             \
         cmc_test_info tinfo = {0};                                                          \
-        timer_t timer = {0};                                                                \
+        cmc_timer timer = {0};                                                              \
                                                                                             \
         tinfo.verbose = VERBOSE;                                                            \
                                                                                             \

src/utl/timer.h

@@ -15,31 +15,33 @@
 
 #include <time.h>
 
-typedef struct timer_s
+typedef struct cmc_timer_s
 {
     clock_t start;
     clock_t stop;
     double result;
-} timer_t;
+} cmc_timer;
 
 #define timer_start(timer)       \
     do                           \
     {                            \
-        (timer).start = clock(); \
+        cmc_timer *t = &(timer); \
+        t->start = clock();      \
                                  \
     } while (0)
 
 #define timer_stop(timer)       \
     do                          \
     {                           \
-        (timer).stop = clock(); \
+        cmc_timer *t = &(timer);\
+        t->stop = clock();      \
                                 \
     } while (0)
 
 #define timer_calc(timer)                                                   \
     do                                                                      \
     {                                                                       \
-        timer_t *t = &(timer);                                              \
+        cmc_timer *t = &(timer);                                            \
         t->result = (double)(t->stop - t->start) * 1000.0 / CLOCKS_PER_SEC; \
                                                                             \
     } while (0)

tests/contains.c

@@ -38,7 +38,7 @@ int main(void)
     queue *q = q_new(1000);
     deque *d = d_new(1000);
     linked *ll = ll_new();
-    heap *h = h_new(1000, MaxHeap, intcmp);
+    heap *h = h_new(1000, cmc_max_heap, intcmp);
     tset *ts = ts_new(intcmp);
     tmap *tm = tm_new(intcmp);
     hset *hs = hs_new(1000, 0.9, intcmp, inthash);

tests/foreach.c

@@ -37,7 +37,7 @@ int main(void)
     queue *q = q_new(1000);
     deque *d = d_new(1000);
     linked *ll = ll_new();
-    heap *h = h_new(1000, MaxHeap, intcmp);
+    heap *h = h_new(1000, cmc_max_heap, intcmp);
     tset *ts = ts_new(intcmp);
     tmap *tm = tm_new(intcmp);
     hset *hs = hs_new(1000, 0.9, intcmp, inthash);

tests/iterators.c

@@ -80,7 +80,7 @@ COLLECTION_GENERATE(HASHMAP, hm, hmap, /* FMOD */, int, double)
 ITERATOR_TEST(DEQUE, d, deque, d_new(20), d_push_front(coll, i), sum1 += d_iter_value(&iter), sum1 == 450, 1)
 ITERATOR_TEST(HASHMAP, hm, hmap, hm_new(50, 0.6, intcmp, inthash), hm_insert(coll, i, (double)i / 10.0), sum1 += hm_iter_key(&iter); sum2 += hm_iter_value(&iter), sum1 == 450, sum2 == 45.0)
 ITERATOR_TEST(HASHSET, hs, hset, hs_new(50, 0.6, intcmp, inthash), hs_insert(coll, i), sum1 += hs_iter_value(&iter), sum1 == 450, 1)
-ITERATOR_TEST(HEAP, h, heap, h_new(20, MaxHeap, intcmp), h_insert(coll, i), sum1 += h_iter_value(&iter), sum1 == 450, 1)
+ITERATOR_TEST(HEAP, h, heap, h_new(20, cmc_max_heap, intcmp), h_insert(coll, i), sum1 += h_iter_value(&iter), sum1 == 450, 1)
 ITERATOR_TEST(LINKEDLIST, ll, linked, ll_new(), ll_push_back(coll, i), sum1 += ll_iter_value(&iter), sum1 == 450, 1)
 ITERATOR_TEST(LIST, l, list, l_new(20), l_push_back(coll, i), sum1 += l_iter_value(&iter), sum1 == 450, 1)
 ITERATOR_TEST(QUEUE, q, queue, q_new(20), q_enqueue(coll, i), sum1 += q_iter_value(&iter), sum1 == 450, 1)

tests/main/main.c

@@ -9,6 +9,10 @@
 #include "unt/treemap.c"
 #include "unt/treeset.c"
 
+#include "unt/linkedqueue.c"
+#include "unt/multimap.c"
+#include "unt/multiset.c"
+
 int main(void)
 {
     deque_test();
@@ -22,5 +26,10 @@ int main(void)
     treemap_test();
     treeset_test();
 
+    /* ext */
+    linkedqueue_test();
+    multimap_test();
+    multiset_test();
+
     return 0;
 }

tests/main/src/deque.c

@@ -1,5 +1,7 @@
 #include "cmc/deque.h"
 
+//DEQUE_GENERATE(d, deque, , size_t)
+
 typedef struct deque_s
 {
     size_t *buffer;

tests/main/src/hashmap.c

@@ -1,5 +1,7 @@
 #include "cmc/hashmap.h"
 
+//HASHMAP_GENERATE(hm, hashmap, , size_t, size_t)
+
 typedef struct hashmap_s
 {
     struct hashmap_entry_s *buffer;
@@ -16,7 +18,7 @@ typedef struct hashmap_entry_s
     size_t key;
     size_t value;
     size_t dist;
-    enum EntryState_e state;
+    enum cmc_entry_state_e state;
 } hashmap_entry, *hashmap_entry_ptr;
 typedef struct hashmap_iter_s
 {
@@ -43,6 +45,7 @@ bool hm_contains(hashmap *_map_, size_t key);
 bool hm_empty(hashmap *_map_);
 size_t hm_count(hashmap *_map_);
 size_t hm_capacity(hashmap *_map_);
+cmc_string hm_to_string(hashmap *_map_);
 hashmap_iter *hm_iter_new(hashmap *target);
 void hm_iter_free(hashmap_iter *iter);
 void hm_iter_init(hashmap_iter *iter, hashmap *target);
@@ -77,6 +80,8 @@ hashmap *hm_new(size_t capacity, double load, int (*compare)(size_t, size_t), si
 {
     if (capacity == 0 || load <= 0 || load >= 1)
         return NULL;
+    if (capacity >= UINTMAX_MAX * load)
+        return NULL;
     size_t real_capacity = hm_impl_calculate_size(capacity / load);
     hashmap *_map_ = malloc(sizeof(hashmap));
     if (!_map_)
@@ -120,12 +125,12 @@ bool hm_insert(hashmap *_map_, size_t key, size_t value)
     hashmap_entry *target = &(_map_->buffer[pos]);
     if (hm_impl_get_entry(_map_, key) != NULL)
         return false;
-    if (target->state == ES_EMPTY || target->state == ES_DELETED)
+    if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)
     {
         target->key = key;
         target->value = value;
         target->dist = original_pos - pos;
-        target->state = ES_FILLED;
+        target->state = CMC_ES_FILLED;
     }
     else
     {
@@ -133,12 +138,12 @@ bool hm_insert(hashmap *_map_, size_t key, size_t value)
         {
             pos++;
             target = &(_map_->buffer[pos % _map_->capacity]);
-            if (target->state == ES_EMPTY || target->state == ES_DELETED)
+            if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)
             {
                 target->key = key;
                 target->value = value;
                 target->dist = pos - original_pos;
-                target->state = ES_FILLED;
+                target->state = CMC_ES_FILLED;
                 break;
             }
             else if (target->dist < original_pos - pos)
@@ -167,7 +172,7 @@ bool hm_remove(hashmap *_map_, size_t key, size_t *value)
     result->key = hm_impl_default_key();
     result->value = hm_impl_default_value();
     result->dist = 0;
-    result->state = ES_DELETED;
+    result->state = CMC_ES_DELETED;
     _map_->count--;
     return true;
 }
@@ -247,6 +252,14 @@ bool hm_contains(hashmap *_map_, size_t key) { return hm_impl_get_entry(_map_, k
 bool hm_empty(hashmap *_map_) { return _map_->count == 0; }
 size_t hm_count(hashmap *_map_) { return _map_->count; }
 size_t hm_capacity(hashmap *_map_) { return _map_->capacity; }
+cmc_string hm_to_string(hashmap *_map_)
+{
+    cmc_string str;
+    hashmap *m_ = _map_;
+    const char *name = "hashmap";
+    snprintf(str.s, cmc_string_len, cmc_string_fmt_hashmap, name, m_, m_->buffer, m_->capacity, m_->count, m_->load, m_->cmp, m_->hash);
+    return str;
+}
 hashmap_iter *hm_iter_new(hashmap *target)
 {
     hashmap_iter *iter = malloc(sizeof(hashmap_iter));
@@ -267,7 +280,7 @@ void hm_iter_init(hashmap_iter *iter, hashmap *target)
     {
         for (size_t i = 0; i < target->capacity; i++)
         {
-            if (target->buffer[i].state == ES_FILLED)
+            if (target->buffer[i].state == CMC_ES_FILLED)
             {
                 iter->first = i;
                 break;
@@ -276,7 +289,7 @@ void hm_iter_init(hashmap_iter *iter, hashmap *target)
         iter->cursor = iter->first;
         for (size_t i = target->capacity; i > 0; i--)
         {
-            if (target->buffer[i - 1].state == ES_FILLED)
+            if (target->buffer[i - 1].state == CMC_ES_FILLED)
             {
                 iter->last = i - 1;
                 break;
@@ -315,7 +328,7 @@ bool hm_iter_next(hashmap_iter *iter)
     {
         iter->cursor++;
         scan = &(iter->target->buffer[iter->cursor]);
-        if (scan->state == ES_FILLED)
+        if (scan->state == CMC_ES_FILLED)
             break;
     }
     iter->start = hm_empty(iter->target);
@@ -336,7 +349,7 @@ bool hm_iter_prev(hashmap_iter *iter)
     {
         iter->cursor--;
         scan = &(iter->target->buffer[iter->cursor]);
-        if (scan->state == ES_FILLED)
+        if (scan->state == CMC_ES_FILLED)
             break;
     }
     iter->end = hm_empty(iter->target);
@@ -391,7 +404,7 @@ static hashmap_entry *hm_impl_get_entry(hashmap *_map_, size_t key)
     size_t hash = _map_->hash(key);
     size_t pos = hash % _map_->capacity;
     hashmap_entry *target = &(_map_->buffer[pos]);
-    while (target->state == ES_FILLED || target->state == ES_DELETED)
+    while (target->state == CMC_ES_FILLED || target->state == CMC_ES_DELETED)
     {
         if (_map_->cmp(target->key, key) == 0)
             return target;

tests/main/src/hashset.c

@@ -1,5 +1,7 @@
 #include "cmc/hashset.h"
 
+//HASHSET_GENERATE(hs, hashset, , size_t)
+
 typedef struct hashset_s
 {
     struct hashset_entry_s *buffer;
@@ -15,7 +17,7 @@ typedef struct hashset_entry_s
 {
     size_t value;
     size_t dist;
-    enum EntryState_e state;
+    enum cmc_entry_state_e state;
 } hashset_entry, *hashset_entry_ptr;
 typedef struct hashset_iter_s
 {
@@ -40,6 +42,7 @@ bool hs_contains(hashset *_set_, size_t element);
 bool hs_empty(hashset *_set_);
 size_t hs_count(hashset *_set_);
 size_t hs_capacity(hashset *_set_);
+cmc_string hs_to_string(hashset *_set_);
 hashset *hs_union(hashset *_set1_, hashset *_set2_);
 hashset *hs_intersection(hashset *_set1_, hashset *_set2_);
 hashset *hs_difference(hashset *_set1_, hashset *_set2_);
@@ -75,6 +78,8 @@ hashset *hs_new(size_t capacity, double load, int (*compare)(size_t, size_t), si
 {
     if (capacity == 0 || load <= 0 || load >= 1)
         return NULL;
+    if (capacity >= UINTMAX_MAX * load)
+        return NULL;
     size_t real_capacity = hs_impl_calculate_size(capacity / load);
     hashset *_set_ = malloc(sizeof(hashset));
     if (!_set_)
@@ -118,11 +123,11 @@ bool hs_insert(hashset *_set_, size_t element)
     hashset_entry *target = &(_set_->buffer[pos]);
     if (hs_impl_get_entry(_set_, element) != NULL)
         return false;
-    if (target->state == ES_EMPTY || target->state == ES_DELETED)
+    if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)
     {
         target->value = element;
         target->dist = pos - original_pos;
-        target->state = ES_FILLED;
+        target->state = CMC_ES_FILLED;
     }
     else
     {
@@ -130,11 +135,11 @@ bool hs_insert(hashset *_set_, size_t element)
         {
             pos++;
             target = &(_set_->buffer[pos % _set_->capacity]);
-            if (target->state == ES_EMPTY || target->state == ES_DELETED)
+            if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)
             {
                 target->value = element;
                 target->dist = pos - original_pos;
-                target->state = ES_FILLED;
+                target->state = CMC_ES_FILLED;
                 break;
             }
             else if (target->dist < pos - original_pos)
@@ -158,7 +163,7 @@ bool hs_remove(hashset *_set_, size_t element)
         return false;
     result->value = hs_impl_default_value();
     result->dist = 0;
-    result->state = ES_DELETED;
+    result->state = CMC_ES_DELETED;
     _set_->count--;
     return true;
 }
@@ -210,11 +215,19 @@ bool hs_contains(hashset *_set_, size_t element) { return hs_impl_get_entry(_set
 bool hs_empty(hashset *_set_) { return _set_->count == 0; }
 size_t hs_count(hashset *_set_) { return _set_->count; }
 size_t hs_capacity(hashset *_set_) { return _set_->capacity; }
+cmc_string hs_to_string(hashset *_set_)
+{
+    cmc_string str;
+    hashset *s_ = _set_;
+    const char *name = "hashset";
+    snprintf(str.s, cmc_string_len, cmc_string_fmt_hashset, name, s_, s_->buffer, s_->capacity, s_->count, s_->load, s_->cmp, s_->hash);
+    return str;
+}
 hashset *hs_union(hashset *_set1_, hashset *_set2_)
 {
     hashset *_set_r_ = hs_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
     if (!_set_r_)
-        return false;
+        return NULL;
     hashset_iter iter1, iter2;
     hs_iter_init(&iter1, _set1_);
     hs_iter_init(&iter2, _set2_);
@@ -232,7 +245,7 @@ hashset *hs_intersection(hashset *_set1_, hashset *_set2_)
 {
     hashset *_set_r_ = hs_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
     if (!_set_r_)
-        return false;
+        return NULL;
     hashset *_set_A_ = _set1_->count < _set2_->count ? _set1_ : _set2_;
     hashset *_set_B_ = _set_A_ == _set1_ ? _set2_ : _set1_;
     hashset_iter iter;
@@ -249,7 +262,7 @@ hashset *hs_difference(hashset *_set1_, hashset *_set2_)
 {
     hashset *_set_r_ = hs_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
     if (!_set_r_)
-        return false;
+        return NULL;
     hashset_iter iter;
     hs_iter_init(&iter, _set1_);
     for (hs_iter_to_start(&iter); !hs_iter_end(&iter); hs_iter_next(&iter))
@@ -265,7 +278,7 @@ hashset *hs_symmetric_difference(hashset *_set1_, hashset *_set2_)
     hashset_iter iter1, iter2;
     hashset *_set_r_ = hs_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
     if (!_set_r_)
-        return false;
+        return NULL;
     hs_iter_init(&iter1, _set1_);
     hs_iter_init(&iter2, _set2_);
     for (hs_iter_to_start(&iter1); !hs_iter_end(&iter1); hs_iter_next(&iter1))
@@ -355,7 +368,7 @@ void hs_iter_init(hashset_iter *iter, hashset *target)
     {
         for (size_t i = 0; i < target->capacity; i++)
         {
-            if (target->buffer[i].state == ES_FILLED)
+            if (target->buffer[i].state == CMC_ES_FILLED)
             {
                 iter->first = i;
                 break;
@@ -364,7 +377,7 @@ void hs_iter_init(hashset_iter *iter, hashset *target)
         iter->cursor = iter->first;
         for (size_t i = target->capacity; i > 0; i--)
         {
-            if (target->buffer[i - 1].state == ES_FILLED)
+            if (target->buffer[i - 1].state == CMC_ES_FILLED)
             {
                 iter->last = i - 1;
                 break;
@@ -402,7 +415,7 @@ bool hs_iter_next(hashset_iter *iter)
         {
             iter->cursor++;
             scan = &(iter->target->buffer[iter->cursor]);
-            if (scan->state == ES_FILLED)
+            if (scan->state == CMC_ES_FILLED)
                 break;
         }
     }
@@ -423,7 +436,7 @@ bool hs_iter_prev(hashset_iter *iter)
         {
             iter->cursor--;
             scan = &(iter->target->buffer[iter->cursor]);
-            if (scan->state == ES_FILLED)
+            if (scan->state == CMC_ES_FILLED)
                 break;
         }
     }
@@ -465,7 +478,7 @@ static hashset_entry *hs_impl_get_entry(hashset *_set_, size_t element)
     size_t hash = _set_->hash(element);
     size_t pos = hash % _set_->capacity;
     hashset_entry *target = &(_set_->buffer[pos]);
-    while (target->state == ES_FILLED || target->state == ES_DELETED)
+    while (target->state == CMC_ES_FILLED || target->state == CMC_ES_DELETED)
     {
         if (_set_->cmp(target->value, element) == 0)
             return target;

tests/main/src/heap.c

@@ -1,11 +1,13 @@
 #include "cmc/heap.h"
 
+//HEAP_GENERATE(h, heap, , size_t)
+
 typedef struct heap_s
 {
     size_t *buffer;
     size_t capacity;
     size_t count;
-    enum HeapOrder HO;
+    enum cmc_heap_order_e HO;
     int (*cmp)(size_t, size_t);
     struct heap_iter_s (*it_start)(struct heap_s *);
     struct heap_iter_s (*it_end)(struct heap_s *);
@@ -17,7 +19,7 @@ typedef struct heap_iter_s
     bool start;
     bool end;
 } heap_iter, *heap_iter_ptr;
-heap *h_new(size_t capacity, HeapOrder HO, int (*compare)(size_t, size_t));
+heap *h_new(size_t capacity, cmc_heap_order HO, int (*compare)(size_t, size_t));
 void h_clear(heap *_heap_);
 void h_free(heap *_heap_);
 bool h_insert(heap *_heap_, size_t element);
@@ -49,18 +51,15 @@ static inline size_t h_impl_default_value(void)
     return _empty_value_;
 }
 static bool h_impl_grow(heap *_heap_);
-static size_t h_impl_p(size_t index);
-static size_t h_impl_l(size_t index);
-static size_t h_impl_r(size_t index);
 static bool h_impl_float_up(heap *_heap_, size_t index);
 static bool h_impl_float_down(heap *_heap_, size_t index);
 static heap_iter h_impl_it_start(heap *_heap_);
 static heap_iter h_impl_it_end(heap *_heap_);
-heap *h_new(size_t capacity, HeapOrder HO, int (*compare)(size_t, size_t))
+heap *h_new(size_t capacity, cmc_heap_order HO, int (*compare)(size_t, size_t))
 {
     if (capacity < 1)
         return NULL;
-    if (HO != MinHeap && HO != MaxHeap)
+    if (HO != cmc_min_heap && HO != cmc_max_heap)
         return NULL;
     heap *_heap_ = malloc(sizeof(heap));
     if (!_heap_)
@@ -225,28 +224,20 @@ static bool h_impl_grow(heap *_heap_)
     _heap_->capacity = new_capacity;
     return true;
 }
-static size_t h_impl_p(size_t index)
-{
-    if (index == 0)
-        return 0;
-    return (index - 1) / 2;
-}
-static size_t h_impl_l(size_t index) { return 2 * index + 1; }
-static size_t h_impl_r(size_t index) { return 2 * index + 2; }
 static bool h_impl_float_up(heap *_heap_, size_t index)
 {
     size_t C = index;
     size_t child = _heap_->buffer[C];
-    size_t parent = _heap_->buffer[h_impl_p(C)];
+    size_t parent = _heap_->buffer[(index - 1) / 2];
     int mod = _heap_->HO;
     while (C > 0 && _heap_->cmp(child, parent) * mod > 0)
     {
         size_t tmp = _heap_->buffer[C];
-        _heap_->buffer[C] = _heap_->buffer[h_impl_p(C)];
-        _heap_->buffer[h_impl_p(C)] = tmp;
-        C = h_impl_p(C);
+        _heap_->buffer[C] = _heap_->buffer[(index - 1) / 2];
+        _heap_->buffer[(index - 1) / 2] = tmp;
+        C = (index - 1) / 2;
         child = _heap_->buffer[C];
-        parent = _heap_->buffer[h_impl_p(C)];
+        parent = _heap_->buffer[(index - 1) / 2];
     }
     return true;
 }
@@ -255,8 +246,8 @@ static bool h_impl_float_down(heap *_heap_, size_t index)
     int mod = _heap_->HO;
     while (index < _heap_->count)
     {
-        size_t L = h_impl_l(index);
-        size_t R = h_impl_r(index);
+        size_t L = 2 * index + 1;
+        size_t R = 2 * index + 2;
         size_t C = index;
         if (L < _heap_->count && _heap_->cmp(_heap_->buffer[L], _heap_->buffer[C]) * mod > 0)
         {

tests/main/src/linkedlist.c

@@ -1,5 +1,7 @@
 #include "cmc/linkedlist.h"
 
+//LINKEDLIST_GENERATE(ll, linkedlist, , size_t)
+
 typedef struct linkedlist_s
 {
     struct linkedlist_node_s *head;

tests/main/src/linkedqueue.c

@@ -0,0 +1,220 @@
+#include "ext/linkedqueue.h"
+
+//LINKEDQUEUE_GENERATE(lq, linkedqueue, , size_t)
+
+typedef struct linkedqueue_s
+{
+    struct linkedqueue_node_s *head;
+    struct linkedqueue_node_s *tail;
+    size_t count;
+    struct linkedqueue_iter_s (*it_start)(struct linkedqueue_s *);
+} linkedqueue, *linkedqueue_ptr;
+typedef struct linkedqueue_node_s
+{
+    size_t data;
+    struct linkedqueue_node_s *next;
+} linkedqueue_node, *linkedqueue_node_ptr;
+typedef struct linkedqueue_iter_s
+{
+    struct linkedqueue_s *target;
+    struct linkedqueue_node_s *cursor;
+    size_t index;
+    bool start;
+    bool end;
+} linkedqueue_iter, *linkedqueue_iter_ptr;
+linkedqueue *lq_new(void);
+void lq_clear(linkedqueue *_lqueue_);
+void lq_free(linkedqueue *_lqueue_);
+bool lq_enqueue(linkedqueue *_lqueue_, size_t element);
+bool lq_dequeue(linkedqueue *_lqueue_);
+bool lq_enqueue_if(linkedqueue *_lqueue_, size_t element, bool condition);
+bool lq_dequeue_if(linkedqueue *_lqueue_, bool condition);
+size_t lq_peek(linkedqueue *_lqueue_);
+bool lq_contains(linkedqueue *_lqueue_, size_t element, int (*comparator)(size_t, size_t));
+bool lq_empty(linkedqueue *_lqueue_);
+size_t lq_count(linkedqueue *_lqueue_);
+linkedqueue_iter *lq_iter_new(linkedqueue *target);
+void lq_iter_free(linkedqueue_iter *iter);
+void lq_iter_init(linkedqueue_iter *iter, linkedqueue *target);
+bool lq_iter_start(linkedqueue_iter *iter);
+bool lq_iter_end(linkedqueue_iter *iter);
+void lq_iter_to_start(linkedqueue_iter *iter);
+void lq_iter_to_end(linkedqueue_iter *iter);
+bool lq_iter_next(linkedqueue_iter *iter);
+size_t lq_iter_value(linkedqueue_iter *iter);
+size_t *lq_iter_rvalue(linkedqueue_iter *iter);
+size_t lq_iter_index(linkedqueue_iter *iter);
+static inline size_t lq_impl_default_value(void)
+{
+    size_t _empty_value_;
+    memset(&_empty_value_, 0, sizeof(size_t));
+    return _empty_value_;
+}
+linkedqueue_node *lq_impl_new_node(size_t element);
+static linkedqueue_iter lq_impl_it_start(linkedqueue *_lqueue_);
+linkedqueue *lq_new(void)
+{
+    linkedqueue *_lqueue_ = malloc(sizeof(linkedqueue));
+    if (!_lqueue_)
+        return NULL;
+    _lqueue_->count = 0;
+    _lqueue_->head = NULL;
+    _lqueue_->tail = NULL;
+    _lqueue_->it_start = lq_impl_it_start;
+    return _lqueue_;
+}
+void lq_clear(linkedqueue *_lqueue_)
+{
+    linkedqueue_node *scan = _lqueue_->head;
+    while (_lqueue_->head != NULL)
+    {
+        _lqueue_->head = _lqueue_->head->next;
+        free(scan);
+        scan = _lqueue_->head;
+    }
+    _lqueue_->count = 0;
+    _lqueue_->head = NULL;
+    _lqueue_->tail = NULL;
+}
+void lq_free(linkedqueue *_lqueue_)
+{
+    lq_clear(_lqueue_);
+    free(_lqueue_);
+}
+bool lq_enqueue(linkedqueue *_lqueue_, size_t element)
+{
+    linkedqueue_node *_node_ = lq_impl_new_node(element);
+    if (!_node_)
+        return false;
+    if (lq_empty(_lqueue_))
+    {
+        _lqueue_->head = _node_;
+        _lqueue_->tail = _node_;
+    }
+    else
+    {
+        _lqueue_->tail->next = _node_;
+        _lqueue_->tail = _node_;
+    }
+    _lqueue_->count++;
+    return true;
+}
+bool lq_dequeue(linkedqueue *_lqueue_)
+{
+    if (lq_empty(_lqueue_))
+        return false;
+    linkedqueue_node *_node_ = _lqueue_->head;
+    _lqueue_->head = _lqueue_->head->next;
+    free(_node_);
+    if (_lqueue_->head == NULL)
+        _lqueue_->tail = NULL;
+    _lqueue_->count--;
+    return true;
+}
+bool lq_enqueue_if(linkedqueue *_lqueue_, size_t element, bool condition)
+{
+    if (condition)
+        return lq_enqueue(_lqueue_, element);
+    return false;
+}
+bool lq_dequeue_if(linkedqueue *_lqueue_, bool condition)
+{
+    if (condition)
+        return lq_dequeue(_lqueue_);
+    return false;
+}
+size_t lq_peek(linkedqueue *_lqueue_)
+{
+    if (lq_empty(_lqueue_))
+        return lq_impl_default_value();
+    return _lqueue_->head->data;
+}
+bool lq_contains(linkedqueue *_lqueue_, size_t element, int (*comparator)(size_t, size_t))
+{
+    linkedqueue_node *scan = _lqueue_->head;
+    while (scan != NULL)
+    {
+        if (comparator(scan->data, element) == 0)
+            return true;
+        scan = scan->next;
+    }
+    return false;
+}
+bool lq_empty(linkedqueue *_lqueue_) { return _lqueue_->count == 0; }
+size_t lq_count(linkedqueue *_lqueue_) { return _lqueue_->count; }
+linkedqueue_iter *lq_iter_new(linkedqueue *target)
+{
+    linkedqueue_iter *iter = malloc(sizeof(linkedqueue_iter));
+    if (!iter)
+        return NULL;
+    lq_iter_init(iter, target);
+    return iter;
+}
+void lq_iter_free(linkedqueue_iter *iter) { free(iter); }
+void lq_iter_init(linkedqueue_iter *iter, linkedqueue *target)
+{
+    iter->target = target;
+    iter->cursor = target->head;
+    iter->index = 0;
+    iter->start = true;
+    iter->end = lq_empty(target);
+}
+bool lq_iter_start(linkedqueue_iter *iter) { return lq_empty(iter->target) || iter->start; }
+bool lq_iter_end(linkedqueue_iter *iter) { return lq_empty(iter->target) || iter->end; }
+void lq_iter_to_start(linkedqueue_iter *iter)
+{
+    iter->cursor = iter->target->head;
+    iter->index = 0;
+    iter->start = true;
+    iter->end = lq_empty(iter->target);
+}
+void lq_iter_to_end(linkedqueue_iter *iter)
+{
+    iter->cursor = iter->target->tail;
+    iter->index = iter->target->count - 1;
+    iter->start = lq_empty(iter->target);
+    iter->end = true;
+}
+bool lq_iter_next(linkedqueue_iter *iter)
+{
+    if (iter->end)
+        return false;
+    iter->start = lq_empty(iter->target);
+    if (iter->cursor->next == NULL)
+        iter->end = true;
+    else
+    {
+        iter->cursor = iter->cursor->next;
+        iter->index++;
+    }
+    return true;
+}
+size_t lq_iter_value(linkedqueue_iter *iter)
+{
+    if (lq_empty(iter->target))
+        return lq_impl_default_value();
+    return iter->cursor->data;
+}
+size_t *lq_iter_rvalue(linkedqueue_iter *iter)
+{
+    if (lq_empty(iter->target))
+        return NULL;
+    return &(iter->cursor->data);
+}
+size_t lq_iter_index(linkedqueue_iter *iter) { return iter->index; }
+linkedqueue_node *lq_impl_new_node(size_t element)
+{
+    linkedqueue_node *_node_ = malloc(sizeof(linkedqueue_node));
+    if (!_node_)
+        return NULL;
+    _node_->data = element;
+    _node_->next = NULL;
+    return _node_;
+}
+static linkedqueue_iter lq_impl_it_start(linkedqueue *_lqueue_)
+{
+    linkedqueue_iter iter;
+    lq_iter_init(&iter, _lqueue_);
+    lq_iter_to_start(&iter);
+    return iter;
+}

tests/main/src/list.c

@@ -1,5 +1,7 @@
 #include "cmc/list.h"
 
+//LIST_GENERATE(l, list, , size_t)
+
 typedef struct list_s
 {
     size_t *buffer;

tests/main/src/multimap.c

@@ -0,0 +1,539 @@
+#include "ext/multimap.h"
+
+//MULTIMAP_GENERATE(mm, multimap, , size_t, size_t)
+
+typedef struct multimap_s
+{
+    struct multimap_entry_s *(*buffer)[2];
+    size_t capacity;
+    size_t count;
+    double load;
+    int (*cmp)(size_t, size_t);
+    size_t (*hash)(size_t);
+    struct multimap_iter_s (*it_start)(struct multimap_s *);
+    struct multimap_iter_s (*it_end)(struct multimap_s *);
+} multimap, *multimap_ptr;
+typedef struct multimap_entry_s
+{
+    size_t key;
+    size_t value;
+    struct multimap_entry_s *next;
+    struct multimap_entry_s *prev;
+} multimap_entry, *multimap_entry_ptr;
+typedef struct multimap_iter_s
+{
+    struct multimap_s *target;
+    struct multimap_entry_s *curr_entry;
+    size_t cursor;
+    size_t index;
+    size_t first;
+    size_t last;
+    bool start;
+    bool end;
+} multimap_iter, *multimap_iter_ptr;
+multimap *mm_new(size_t capacity, double load, int (*compare)(size_t, size_t), size_t (*hash)(size_t));
+void mm_clear(multimap *_map_);
+void mm_free(multimap *_map_);
+bool mm_insert(multimap *_map_, size_t key, size_t value);
+bool mm_remove(multimap *_map_, size_t key, size_t *value);
+size_t mm_remove_all(multimap *_map_, size_t key);
+bool mm_insert_if(multimap *_map_, size_t key, size_t value, bool condition);
+bool mm_remove_if(multimap *_map_, size_t key, size_t *value, bool condition);
+bool mm_max(multimap *_map_, size_t *key, size_t *value);
+bool mm_min(multimap *_map_, size_t *key, size_t *value);
+size_t mm_get(multimap *_map_, size_t key);
+size_t *mm_get_ref(multimap *_map_, size_t key);
+bool mm_contains(multimap *_map_, size_t key);
+bool mm_empty(multimap *_map_);
+size_t mm_count(multimap *_map_);
+size_t mm_capacity(multimap *_map_);
+multimap_iter *mm_iter_new(multimap *target);
+void mm_iter_free(multimap_iter *iter);
+void mm_iter_init(multimap_iter *iter, multimap *target);
+bool mm_iter_start(multimap_iter *iter);
+bool mm_iter_end(multimap_iter *iter);
+void mm_iter_to_start(multimap_iter *iter);
+void mm_iter_to_end(multimap_iter *iter);
+bool mm_iter_next(multimap_iter *iter);
+bool mm_iter_prev(multimap_iter *iter);
+size_t mm_iter_key(multimap_iter *iter);
+size_t mm_iter_value(multimap_iter *iter);
+size_t *mm_iter_rvalue(multimap_iter *iter);
+size_t mm_iter_index(multimap_iter *iter);
+static inline size_t mm_impl_default_key(void)
+{
+    size_t _empty_key_;
+    memset(&_empty_key_, 0, sizeof(size_t));
+    return _empty_key_;
+}
+static inline size_t mm_impl_default_value(void)
+{
+    size_t _empty_value_;
+    memset(&_empty_value_, 0, sizeof(size_t));
+    return _empty_value_;
+}
+bool mm_impl_grow(multimap *_map_);
+multimap_entry *mm_impl_new_entry(size_t key, size_t value);
+multimap_entry *mm_impl_get_entry(multimap *_map_, size_t key);
+size_t mm_impl_calculate_size(size_t required);
+static multimap_iter mm_impl_it_start(multimap *_map_);
+static multimap_iter mm_impl_it_end(multimap *_map_);
+multimap *mm_new(size_t capacity, double load, int (*compare)(size_t, size_t), size_t (*hash)(size_t))
+{
+    if (capacity == 0 || load <= 0)
+        return NULL;
+    if (capacity >= UINTMAX_MAX * load)
+        return NULL;
+    size_t real_capacity = mm_impl_calculate_size(capacity / load);
+    multimap *_map_ = malloc(sizeof(multimap));
+    if (!_map_)
+        return NULL;
+    _map_->buffer = malloc(sizeof(multimap_entry_ptr[2]) * real_capacity);
+    if (!_map_->buffer)
+    {
+        free(_map_);
+        return NULL;
+    }
+    memset(_map_->buffer, 0, sizeof(multimap_entry_ptr[2]) * real_capacity);
+    _map_->count = 0;
+    _map_->capacity = real_capacity;
+    _map_->load = load;
+    _map_->cmp = compare;
+    _map_->hash = hash;
+    return _map_;
+}
+void mm_clear(multimap *_map_)
+{
+    size_t index = 0;
+    multimap_entry *scan;
+    while (index < _map_->capacity)
+    {
+        scan = _map_->buffer[index][0];
+        if (scan != NULL)
+        {
+            if (scan->next == NULL && scan->prev == NULL)
+                free(scan);
+            else
+            {
+                while (scan != NULL)
+                {
+                    multimap_entry *tmp = scan;
+                    scan = scan->next;
+                    free(tmp);
+                }
+            }
+        }
+        index++;
+    }
+    memset(_map_->buffer, 0, sizeof(multimap_entry_ptr[2]) * _map_->capacity);
+    _map_->count = 0;
+}
+void mm_free(multimap *_map_)
+{
+    mm_clear(_map_);
+    free(_map_->buffer);
+    free(_map_);
+}
+bool mm_insert(multimap *_map_, size_t key, size_t value)
+{
+    if ((double)_map_->capacity * _map_->load <= (double)_map_->count)
+    {
+        if (!mm_impl_grow(_map_))
+            return false;
+    }
+    size_t hash = _map_->hash(key);
+    size_t pos = hash % _map_->capacity;
+    multimap_entry *entry = mm_impl_new_entry(key, value);
+    if (_map_->buffer[pos][0] == NULL)
+    {
+        _map_->buffer[pos][0] = entry;
+        _map_->buffer[pos][1] = entry;
+    }
+    else
+    {
+        entry->prev = _map_->buffer[pos][1];
+        _map_->buffer[pos][1]->next = entry;
+        _map_->buffer[pos][1] = entry;
+    }
+    _map_->count++;
+    return true;
+}
+bool mm_remove(multimap *_map_, size_t key, size_t *value)
+{
+    size_t hash = _map_->hash(key);
+    multimap_entry **head = &(_map_->buffer[hash % _map_->capacity][0]);
+    multimap_entry **tail = &(_map_->buffer[hash % _map_->capacity][1]);
+    if (*head == NULL)
+        return false;
+    multimap_entry *entry = *head;
+    if (entry->next == NULL && entry->prev == NULL)
+    {
+        if (_map_->cmp(entry->key, key) == 0)
+        {
+            *head = NULL;
+            *tail = NULL;
+            *value = entry->value;
+        }
+        else
+            return false;
+    }
+    else
+    {
+        bool found = false;
+        while (entry != NULL)
+        {
+            if (_map_->cmp(entry->key, key) == 0)
+            {
+                if (*head == entry)
+                    *head = entry->next;
+                if (*tail == entry)
+                    *tail = entry->prev;
+                if (entry->prev != NULL)
+                    entry->prev->next = entry->next;
+                if (entry->next != NULL)
+                    entry->next->prev = entry->prev;
+                *value = entry->value;
+                found = true;
+                break;
+            }
+            else
+                entry = entry->next;
+        }
+        if (!found)
+            return false;
+    }
+    free(entry);
+    _map_->count--;
+    return true;
+}
+size_t mm_remove_all(multimap *_map_, size_t key)
+{
+    size_t total = 0;
+    size_t hash = _map_->hash(key);
+    multimap_entry **head = &(_map_->buffer[hash % _map_->capacity][0]);
+    multimap_entry **tail = &(_map_->buffer[hash % _map_->capacity][1]);
+    if (*head == NULL)
+        return total;
+    multimap_entry *entry = *head;
+    if (entry->next == NULL)
+    {
+        *head = NULL;
+        *tail = NULL;
+        free(entry);
+        total++;
+    }
+    else
+    {
+        while (entry != NULL)
+        {
+            if (_map_->cmp(entry->key, key) == 0)
+            {
+                if (*head == entry)
+                    *head = entry->next;
+                if (*tail == entry)
+                    *tail = entry->prev;
+                multimap_entry *temp = entry->next;
+                if (entry->prev != NULL)
+                    entry->prev->next = entry->next;
+                if (entry->next != NULL)
+                    entry->next->prev = entry->prev;
+                free(entry);
+                entry = temp;
+                total++;
+            }
+            else
+                entry = entry->next;
+        }
+    }
+    _map_->count -= total;
+    return total;
+}
+bool mm_insert_if(multimap *_map_, size_t key, size_t value, bool condition)
+{
+    if (condition)
+        return mm_insert(_map_, key, value);
+    return false;
+}
+bool mm_remove_if(multimap *_map_, size_t key, size_t *value, bool condition)
+{
+    if (condition)
+        return mm_remove(_map_, key, value);
+    return false;
+}
+bool mm_max(multimap *_map_, size_t *key, size_t *value)
+{
+    if (mm_empty(_map_))
+        return false;
+    multimap_iter iter;
+    for (mm_iter_init(&iter, _map_); !mm_iter_end(&iter); mm_iter_next(&iter))
+    {
+        size_t result_key = mm_iter_key(&iter);
+        size_t result_value = mm_iter_value(&iter);
+        size_t index = mm_iter_index(&iter);
+        if (index == 0)
+        {
+            *key = result_key;
+            *value = result_value;
+        }
+        else if (_map_->cmp(result_key, *key) > 0)
+        {
+            *key = result_key;
+            *value = result_value;
+        }
+    }
+    return true;
+}
+bool mm_min(multimap *_map_, size_t *key, size_t *value)
+{
+    if (mm_empty(_map_))
+        return false;
+    multimap_iter iter;
+    for (mm_iter_init(&iter, _map_); !mm_iter_end(&iter); mm_iter_next(&iter))
+    {
+        size_t result_key = mm_iter_key(&iter);
+        size_t result_value = mm_iter_value(&iter);
+        size_t index = mm_iter_index(&iter);
+        if (index == 0)
+        {
+            *key = result_key;
+            *value = result_value;
+        }
+        else if (_map_->cmp(result_key, *key) < 0)
+        {
+            *key = result_key;
+            *value = result_value;
+        }
+    }
+    return true;
+}
+size_t mm_get(multimap *_map_, size_t key)
+{
+    multimap_entry *entry = mm_impl_get_entry(_map_, key);
+    if (!entry)
+        return mm_impl_default_value();
+    return entry->value;
+}
+size_t *mm_get_ref(multimap *_map_, size_t key)
+{
+    multimap_entry *entry = mm_impl_get_entry(_map_, key);
+    if (!entry)
+        return NULL;
+    return &(entry->value);
+}
+bool mm_contains(multimap *_map_, size_t key) { return mm_impl_get_entry(_map_, key) != NULL; }
+bool mm_empty(multimap *_map_) { return _map_->count == 0; }
+size_t mm_count(multimap *_map_) { return _map_->count; }
+size_t mm_capacity(multimap *_map_) { return _map_->capacity; }
+multimap_iter *mm_iter_new(multimap *target)
+{
+    multimap_iter *iter = malloc(sizeof(multimap_iter));
+    if (!iter)
+        return NULL;
+    mm_iter_init(iter, target);
+    return iter;
+}
+void mm_iter_free(multimap_iter *iter) { free(iter); }
+void mm_iter_init(multimap_iter *iter, multimap *target)
+{
+    iter->target = target;
+    iter->cursor = 0;
+    iter->index = 0;
+    iter->start = true;
+    iter->end = mm_empty(target);
+    if (!mm_empty(target))
+    {
+        for (size_t i = 0; i < target->capacity; i++)
+        {
+            if (target->buffer[i][0] != NULL)
+            {
+                iter->curr_entry = target->buffer[i][0];
+                iter->first = i;
+                break;
+            }
+        }
+        iter->cursor = iter->first;
+        for (size_t i = target->capacity; i > 0; i--)
+        {
+            if (target->buffer[i - 1][0] != NULL)
+            {
+                iter->last = i - 1;
+                break;
+            }
+        }
+    }
+}
+bool mm_iter_start(multimap_iter *iter) { return mm_empty(iter->target) || iter->start; }
+bool mm_iter_end(multimap_iter *iter) { return mm_empty(iter->target) || iter->end; }
+void mm_iter_to_start(multimap_iter *iter)
+{
+    iter->cursor = iter->first;
+    iter->index = 0;
+    iter->start = true;
+    iter->end = mm_empty(iter->target);
+    iter->curr_entry = iter->target->buffer[iter->first][0];
+}
+void mm_iter_to_end(multimap_iter *iter)
+{
+    iter->cursor = iter->last;
+    iter->index = iter->target->count - 1;
+    iter->start = mm_empty(iter->target);
+    iter->end = true;
+    iter->curr_entry = iter->target->buffer[iter->last][1];
+}
+bool mm_iter_next(multimap_iter *iter)
+{
+    if (iter->end)
+        return false;
+    if (iter->curr_entry->next != NULL)
+    {
+        iter->curr_entry = iter->curr_entry->next;
+        iter->index++;
+    }
+    else
+    {
+        if (iter->cursor == iter->last)
+        {
+            iter->end = true;
+            return false;
+        }
+        else
+        {
+            iter->cursor++;
+            while (iter->target->buffer[iter->cursor][0] == NULL)
+                iter->cursor++;
+            iter->curr_entry = iter->target->buffer[iter->cursor][0];
+            iter->index++;
+        }
+    }
+    iter->start = mm_empty(iter->target);
+    return true;
+}
+bool mm_iter_prev(multimap_iter *iter)
+{
+    if (iter->start)
+        return false;
+    if (iter->curr_entry->prev != NULL)
+    {
+        iter->curr_entry = iter->curr_entry->prev;
+        iter->index--;
+    }
+    else
+    {
+        if (iter->cursor == iter->first)
+        {
+            iter->start = true;
+            return false;
+        }
+        else
+        {
+            iter->cursor--;
+            while (iter->target->buffer[iter->cursor][1] == NULL)
+                iter->cursor--;
+            iter->curr_entry = iter->target->buffer[iter->cursor][1];
+            iter->index--;
+        }
+    }
+    iter->end = mm_empty(iter->target);
+    return true;
+}
+size_t mm_iter_key(multimap_iter *iter)
+{
+    if (mm_empty(iter->target))
+        return mm_impl_default_key();
+    return iter->curr_entry->key;
+}
+size_t mm_iter_value(multimap_iter *iter)
+{
+    if (mm_empty(iter->target))
+        return mm_impl_default_value();
+    return iter->curr_entry->value;
+}
+size_t *mm_iter_rvalue(multimap_iter *iter)
+{
+    if (mm_empty(iter->target))
+        return NULL;
+    return &(iter->curr_entry->value);
+}
+size_t mm_iter_index(multimap_iter *iter) { return iter->index; }
+bool mm_impl_grow(multimap *_map_)
+{
+    size_t new_capacity = mm_impl_calculate_size(_map_->capacity * 1.5);
+    multimap *_new_map_ = mm_new(new_capacity, _map_->load, _map_->cmp, _map_->hash);
+    if (!_new_map_)
+        return false;
+    multimap_iter iter;
+    for (mm_iter_init(&iter, _map_); !mm_iter_end(&iter); mm_iter_next(&iter))
+    {
+        size_t key = mm_iter_key(&iter);
+        size_t value = mm_iter_value(&iter);
+        mm_insert(_new_map_, key, value);
+    }
+    if (_map_->count != _new_map_->count)
+    {
+        mm_free(_new_map_);
+        return false;
+    }
+    multimap_entry *(*tmp_b)[2] = _map_->buffer;
+    _map_->buffer = _new_map_->buffer;
+    _new_map_->buffer = tmp_b;
+    size_t tmp_c = _map_->capacity;
+    _map_->capacity = _new_map_->capacity;
+    _new_map_->capacity = tmp_c;
+    mm_free(_new_map_);
+    return true;
+}
+multimap_entry *mm_impl_new_entry(size_t key, size_t value)
+{
+    multimap_entry *entry = malloc(sizeof(multimap_entry));
+    if (!entry)
+        return NULL;
+    entry->key = key;
+    entry->value = value;
+    entry->next = NULL;
+    entry->prev = NULL;
+    return entry;
+}
+multimap_entry *mm_impl_get_entry(multimap *_map_, size_t key)
+{
+    size_t hash = _map_->hash(key);
+    multimap_entry *entry = _map_->buffer[hash % _map_->capacity][0];
+    if (entry == NULL)
+        return NULL;
+    if (entry->next == NULL && entry->prev == NULL)
+    {
+        if (_map_->cmp(entry->key, key) == 0)
+            return entry;
+        else
+            return NULL;
+    }
+    while (entry != NULL)
+    {
+        if (_map_->cmp(entry->key, key) == 0)
+            return entry;
+        entry = entry->next;
+    }
+    return NULL;
+}
+size_t mm_impl_calculate_size(size_t required)
+{
+    const size_t count = sizeof(cmc_hashtable_primes) / sizeof(cmc_hashtable_primes[0]);
+    if (cmc_hashtable_primes[count - 1] < required)
+        return required;
+    size_t i = 0;
+    while (cmc_hashtable_primes[i] < required)
+        i++;
+    return cmc_hashtable_primes[i];
+}
+static multimap_iter mm_impl_it_start(multimap *_map_)
+{
+    multimap_iter iter;
+    mm_iter_init(&iter, _map_);
+    return iter;
+}
+static multimap_iter mm_impl_it_end(multimap *_map_)
+{
+    multimap_iter iter;
+    mm_iter_init(&iter, _map_);
+    mm_iter_to_end(&iter);
+    return iter;
+}

tests/main/src/multiset.c

@@ -0,0 +1,655 @@
+#include "ext/multiset.h"
+
+//MULTISET_GENERATE(ms, multiset, , size_t)
+
+typedef struct multiset_s
+{
+    struct multiset_entry_s *buffer;
+    size_t capacity;
+    size_t count;
+    size_t cardinality;
+    double load;
+    int (*cmp)(size_t, size_t);
+    size_t (*hash)(size_t);
+    struct multiset_iter_s (*it_start)(struct multiset_s *);
+    struct multiset_iter_s (*it_end)(struct multiset_s *);
+} multiset, *multiset_ptr;
+typedef struct multiset_entry_s
+{
+    size_t value;
+    size_t multiplicity;
+    size_t dist;
+    enum cmc_entry_state_e state;
+} multiset_entry, *multiset_entry_ptr;
+typedef struct multiset_iter_s
+{
+    struct multiset_s *target;
+    size_t cursor;
+    size_t index;
+    size_t first;
+    size_t last;
+    bool start;
+    bool end;
+} multiset_iter, *multiset_iter_ptr;
+multiset *ms_new(size_t capacity, double load, int (*compare)(size_t, size_t), size_t (*hash)(size_t));
+void ms_clear(multiset *_set_);
+void ms_free(multiset *_set_);
+bool ms_insert(multiset *_set_, size_t element);
+bool ms_insert_many(multiset *_set_, size_t element, size_t count);
+bool ms_update(multiset *_set_, size_t element, size_t multiplicity);
+bool ms_remove(multiset *_set_, size_t element);
+size_t ms_remove_all(multiset *_set_, size_t element);
+bool ms_insert_if(multiset *_set_, size_t element, bool condition);
+bool ms_remove_if(multiset *_set_, size_t element, bool condition);
+bool ms_max(multiset *_set_, size_t *value);
+bool ms_min(multiset *_set_, size_t *value);
+size_t ms_multiplicity_of(multiset *_set_, size_t element);
+bool ms_contains(multiset *_set_, size_t element);
+bool ms_empty(multiset *_set_);
+size_t ms_count(multiset *_set_);
+size_t ms_cardinality(multiset *_set_);
+size_t ms_capacity(multiset *_set_);
+cmc_string ms_to_string(multiset *_set_);
+multiset *ms_union(multiset *_set1_, multiset *_set2_);
+multiset *ms_intersection(multiset *_set1_, multiset *_set2_);
+multiset *ms_difference(multiset *_set1_, multiset *_set2_);
+multiset *ms_summation(multiset *_set1_, multiset *_set2_);
+multiset *ms_symmetric_difference(multiset *_set1_, multiset *_set2_);
+bool ms_is_subset(multiset *_set1_, multiset *_set2_);
+bool ms_is_superset(multiset *_set1_, multiset *_set2_);
+bool ms_is_proper_subset(multiset *_set1_, multiset *_set2_);
+bool ms_is_proper_superset(multiset *_set1_, multiset *_set2_);
+bool ms_is_disjointset(multiset *_set1_, multiset *_set2_);
+multiset_iter *ms_iter_new(multiset *target);
+void ms_iter_free(multiset_iter *iter);
+void ms_iter_init(multiset_iter *iter, multiset *target);
+bool ms_iter_start(multiset_iter *iter);
+bool ms_iter_end(multiset_iter *iter);
+void ms_iter_to_start(multiset_iter *iter);
+void ms_iter_to_end(multiset_iter *iter);
+bool ms_iter_next(multiset_iter *iter);
+bool ms_iter_prev(multiset_iter *iter);
+size_t ms_iter_value(multiset_iter *iter);
+size_t ms_iter_multiplicity(multiset_iter *iter);
+size_t ms_iter_index(multiset_iter *iter);
+static inline size_t ms_impl_default_value(void)
+{
+    size_t _empty_value_;
+    memset(&_empty_value_, 0, sizeof(size_t));
+    return _empty_value_;
+}
+static multiset_entry *ms_impl_insert_and_return(multiset *_set_, size_t element, bool *new_node);
+static bool ms_impl_grow(multiset *_set_);
+static multiset_entry *ms_impl_get_entry(multiset *_set_, size_t element);
+static size_t ms_impl_calculate_size(size_t required);
+static multiset_iter ms_impl_it_start(multiset *_set_);
+static multiset_iter ms_impl_it_end(multiset *_set_);
+multiset *ms_new(size_t capacity, double load, int (*compare)(size_t, size_t), size_t (*hash)(size_t))
+{
+    if (capacity == 0 || load <= 0 || load >= 1)
+        return NULL;
+    if (capacity >= UINTMAX_MAX * load)
+        return NULL;
+    size_t real_capacity = ms_impl_calculate_size(capacity / load);
+    multiset *_set_ = malloc(sizeof(multiset));
+    if (!_set_)
+        return NULL;
+    _set_->buffer = malloc(sizeof(multiset_entry) * real_capacity);
+    if (!_set_->buffer)
+    {
+        free(_set_);
+        return NULL;
+    }
+    memset(_set_->buffer, 0, sizeof(multiset_entry) * real_capacity);
+    _set_->count = 0;
+    _set_->cardinality = 0;
+    _set_->capacity = real_capacity;
+    _set_->load = load;
+    _set_->cmp = compare;
+    _set_->hash = hash;
+    _set_->it_start = ms_impl_it_start;
+    _set_->it_end = ms_impl_it_end;
+    return _set_;
+}
+void ms_clear(multiset *_set_)
+{
+    memset(_set_->buffer, 0, sizeof(multiset_entry) * _set_->capacity);
+    _set_->count = 0;
+}
+void ms_free(multiset *_set_)
+{
+    free(_set_->buffer);
+    free(_set_);
+}
+bool ms_insert(multiset *_set_, size_t element)
+{
+    bool new_node;
+    multiset_entry *entry = ms_impl_insert_and_return(_set_, element, &new_node);
+    if (!entry)
+        return false;
+    if (!new_node)
+        entry->multiplicity++;
+    _set_->cardinality++;
+    return true;
+}
+bool ms_insert_many(multiset *_set_, size_t element, size_t count)
+{
+    if (count == 0)
+        return true;
+    bool new_node;
+    multiset_entry *entry = ms_impl_insert_and_return(_set_, element, &new_node);
+    if (!entry)
+        return false;
+    if (new_node)
+        entry->multiplicity = count;
+    else
+        entry->multiplicity += count;
+    _set_->cardinality += count;
+    return true;
+}
+bool ms_update(multiset *_set_, size_t element, size_t multiplicity)
+{
+    if (multiplicity == 0)
+        return ms_remove_all(_set_, element);
+    bool new_node;
+    multiset_entry *entry = ms_impl_insert_and_return(_set_, element, &new_node);
+    if (!entry)
+        return false;
+    if (new_node)
+        _set_->cardinality++;
+    _set_->cardinality = (_set_->cardinality - entry->multiplicity) + multiplicity;
+    entry->multiplicity = multiplicity;
+    return true;
+}
+bool ms_remove(multiset *_set_, size_t element)
+{
+    multiset_entry *result = ms_impl_get_entry(_set_, element);
+    if (result == NULL)
+        return false;
+    if (result->multiplicity > 1)
+        result->multiplicity--;
+    else
+    {
+        result->value = ms_impl_default_value();
+        result->multiplicity = 0;
+        result->dist = 0;
+        result->state = CMC_ES_DELETED;
+        _set_->count--;
+    }
+    _set_->cardinality--;
+    return true;
+}
+size_t ms_remove_all(multiset *_set_, size_t element)
+{
+    multiset_entry *result = ms_impl_get_entry(_set_, element);
+    if (result == NULL)
+        return 0;
+    size_t removed = result->multiplicity;
+    result->value = ms_impl_default_value();
+    result->multiplicity = 0;
+    result->dist = 0;
+    result->state = CMC_ES_DELETED;
+    _set_->count--;
+    _set_->cardinality -= removed;
+    return removed;
+}
+bool ms_insert_if(multiset *_set_, size_t element, bool condition)
+{
+    if (condition)
+        return ms_insert(_set_, element);
+    return false;
+}
+bool ms_remove_if(multiset *_set_, size_t element, bool condition)
+{
+    if (condition)
+        return ms_remove(_set_, element);
+    return false;
+}
+bool ms_max(multiset *_set_, size_t *value)
+{
+    if (ms_empty(_set_))
+        return false;
+    multiset_iter iter;
+    for (ms_iter_init(&iter, _set_); !ms_iter_end(&iter); ms_iter_next(&iter))
+    {
+        size_t result = ms_iter_value(&iter);
+        size_t index = ms_iter_index(&iter);
+        if (index == 0)
+            *value = result;
+        else if (_set_->cmp(result, *value) > 0)
+            *value = result;
+    }
+    return true;
+}
+bool ms_min(multiset *_set_, size_t *value)
+{
+    if (ms_empty(_set_))
+        return false;
+    multiset_iter iter;
+    for (ms_iter_init(&iter, _set_); !ms_iter_end(&iter); ms_iter_next(&iter))
+    {
+        size_t result = ms_iter_value(&iter);
+        size_t index = ms_iter_index(&iter);
+        if (index == 0)
+            *value = result;
+        else if (_set_->cmp(result, *value) < 0)
+            *value = result;
+    }
+    return true;
+}
+size_t ms_multiplicity_of(multiset *_set_, size_t element)
+{
+    multiset_entry *entry = ms_impl_get_entry(_set_, element);
+    if (!entry)
+        return 0;
+    return entry->multiplicity;
+}
+bool ms_contains(multiset *_set_, size_t element) { return ms_impl_get_entry(_set_, element) != NULL; }
+bool ms_empty(multiset *_set_) { return _set_->count == 0; }
+size_t ms_count(multiset *_set_) { return _set_->count; }
+size_t ms_cardinality(multiset *_set_) { return _set_->cardinality; }
+size_t ms_capacity(multiset *_set_) { return _set_->capacity; }
+cmc_string ms_to_string(multiset *_set_)
+{
+    cmc_string str;
+    multiset *s_ = _set_;
+    const char *name = "multiset";
+    snprintf(str.s, cmc_string_len, cmc_string_fmt_multiset, name, s_, s_->buffer, s_->capacity, s_->count, s_->cardinality, s_->load, s_->cmp, s_->hash);
+    return str;
+}
+multiset *ms_union(multiset *_set1_, multiset *_set2_)
+{
+    multiset *_set_r_ = ms_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
+    if (!_set_r_)
+        return NULL;
+    multiset_iter iter1, iter2;
+    ms_iter_init(&iter1, _set1_);
+    ms_iter_init(&iter2, _set2_);
+    for (ms_iter_to_start(&iter1); !ms_iter_end(&iter1); ms_iter_next(&iter1))
+    {
+        size_t value = ms_iter_value(&iter1);
+        size_t m1 = ms_iter_multiplicity(&iter1);
+        size_t m2 = ms_multiplicity_of(_set2_, value);
+        size_t max_ = m1 > m2 ? m1 : m2;
+        ms_update(_set_r_, value, max_);
+    }
+    for (ms_iter_to_start(&iter2); !ms_iter_end(&iter2); ms_iter_next(&iter2))
+    {
+        size_t value = ms_iter_value(&iter2);
+        size_t m1 = ms_multiplicity_of(_set1_, value);
+        size_t m2 = ms_iter_multiplicity(&iter2);
+        size_t max_ = m1 > m2 ? m1 : m2;
+        ms_update(_set_r_, value, max_);
+    }
+    return _set_r_;
+}
+multiset *ms_intersection(multiset *_set1_, multiset *_set2_)
+{
+    multiset *_set_r_ = ms_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
+    if (!_set_r_)
+        return NULL;
+    multiset *_set_A_ = _set1_->count < _set2_->count ? _set1_ : _set2_;
+    multiset *_set_B_ = _set_A_ == _set1_ ? _set2_ : _set1_;
+    multiset_iter iter;
+    ms_iter_init(&iter, _set_A_);
+    for (ms_iter_to_start(&iter); !ms_iter_end(&iter); ms_iter_next(&iter))
+    {
+        size_t value = ms_iter_value(&iter);
+        size_t m1 = ms_iter_multiplicity(&iter);
+        size_t m2 = ms_multiplicity_of(_set_B_, value);
+        size_t max_ = m1 < m2 ? m1 : m2;
+        ms_update(_set_r_, value, max_);
+    }
+    return _set_r_;
+}
+multiset *ms_difference(multiset *_set1_, multiset *_set2_)
+{
+    multiset *_set_r_ = ms_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
+    if (!_set_r_)
+        return NULL;
+    multiset_iter iter;
+    ms_iter_init(&iter, _set1_);
+    for (ms_iter_to_start(&iter); !ms_iter_end(&iter); ms_iter_next(&iter))
+    {
+        size_t value = ms_iter_value(&iter);
+        size_t m1 = ms_iter_multiplicity(&iter);
+        size_t m2 = ms_multiplicity_of(_set2_, value);
+        if (m1 > m2)
+            ms_update(_set_r_, value, m1 - m2);
+    }
+    return _set_r_;
+}
+multiset *ms_summation(multiset *_set1_, multiset *_set2_)
+{
+    multiset *_set_r_ = ms_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
+    if (!_set_r_)
+        return NULL;
+    multiset_iter iter1, iter2;
+    ms_iter_init(&iter1, _set1_);
+    ms_iter_init(&iter2, _set2_);
+    for (ms_iter_to_start(&iter1); !ms_iter_end(&iter1); ms_iter_next(&iter1))
+    {
+        ms_insert_many(_set_r_, ms_iter_value(&iter1), ms_iter_multiplicity(&iter1));
+    }
+    for (ms_iter_to_start(&iter2); !ms_iter_end(&iter2); ms_iter_next(&iter2))
+    {
+        ms_insert_many(_set_r_, ms_iter_value(&iter2), ms_iter_multiplicity(&iter2));
+    }
+    return _set_r_;
+}
+multiset *ms_symmetric_difference(multiset *_set1_, multiset *_set2_)
+{
+    multiset_iter iter1, iter2;
+    multiset *_set_r_ = ms_new(_set1_->capacity, _set1_->load, _set1_->cmp, _set1_->hash);
+    if (!_set_r_)
+        return NULL;
+    ms_iter_init(&iter1, _set1_);
+    ms_iter_init(&iter2, _set2_);
+    for (ms_iter_to_start(&iter1); !ms_iter_end(&iter1); ms_iter_next(&iter1))
+    {
+        size_t value = ms_iter_value(&iter1);
+        size_t m1 = ms_iter_multiplicity(&iter1);
+        size_t m2 = ms_multiplicity_of(_set2_, value);
+        if (m1 != m2)
+        {
+            if (m1 > m2)
+                ms_update(_set_r_, value, m1 - m2);
+            else
+                ms_update(_set_r_, value, m2 - m1);
+        }
+    }
+    for (ms_iter_to_start(&iter2); !ms_iter_end(&iter2); ms_iter_next(&iter2))
+    {
+        size_t value = ms_iter_value(&iter2);
+        size_t m1 = ms_multiplicity_of(_set1_, value);
+        size_t m2 = ms_iter_multiplicity(&iter2);
+        if (m1 != m2)
+        {
+            if (m1 > m2)
+                ms_update(_set_r_, value, m1 - m2);
+            else
+                ms_update(_set_r_, value, m2 - m1);
+        }
+    }
+    return _set_r_;
+}
+bool ms_is_subset(multiset *_set1_, multiset *_set2_)
+{
+    if (ms_count(_set1_) > ms_count(_set2_))
+        return false;
+    if (ms_empty(_set1_))
+        return true;
+    multiset_iter iter;
+    ms_iter_init(&iter, _set1_);
+    for (ms_iter_to_start(&iter); !ms_iter_end(&iter); ms_iter_next(&iter))
+    {
+        size_t value = ms_iter_value(&iter);
+        size_t m1 = ms_iter_multiplicity(&iter);
+        size_t m2 = ms_multiplicity_of(_set2_, value);
+        if (m1 > m2)
+            return false;
+    }
+    return true;
+}
+bool ms_is_superset(multiset *_set1_, multiset *_set2_) { return ms_is_subset(_set2_, _set1_); }
+bool ms_is_proper_subset(multiset *_set1_, multiset *_set2_)
+{
+    if (ms_count(_set1_) >= ms_count(_set2_))
+        return false;
+    if (ms_empty(_set1_))
+    {
+        if (!ms_empty(_set2_))
+            return true;
+        else
+            return false;
+    }
+    multiset_iter iter;
+    ms_iter_init(&iter, _set1_);
+    for (ms_iter_to_start(&iter); !ms_iter_end(&iter); ms_iter_next(&iter))
+    {
+        size_t value = ms_iter_value(&iter);
+        size_t m1 = ms_iter_multiplicity(&iter);
+        size_t m2 = ms_multiplicity_of(_set2_, value);
+        if (m1 >= m2)
+            return false;
+    }
+    return true;
+}
+bool ms_is_proper_superset(multiset *_set1_, multiset *_set2_) { return ms_is_proper_subset(_set2_, _set1_); }
+bool ms_is_disjointset(multiset *_set1_, multiset *_set2_)
+{
+    if (ms_empty(_set1_))
+        return true;
+    multiset_iter iter;
+    ms_iter_init(&iter, _set1_);
+    for (ms_iter_to_start(&iter); !ms_iter_end(&iter); ms_iter_next(&iter))
+    {
+        size_t value = ms_iter_value(&iter);
+        if (ms_contains(_set2_, value))
+            return false;
+    }
+    return true;
+}
+multiset_iter *ms_iter_new(multiset *target)
+{
+    multiset_iter *iter = malloc(sizeof(multiset_iter));
+    if (!iter)
+        return NULL;
+    ms_iter_init(iter, target);
+    return iter;
+}
+void ms_iter_free(multiset_iter *iter) { free(iter); }
+void ms_iter_init(multiset_iter *iter, multiset *target)
+{
+    iter->target = target;
+    iter->cursor = 0;
+    iter->index = 0;
+    iter->start = true;
+    iter->end = ms_empty(target);
+    if (!ms_empty(target))
+    {
+        for (size_t i = 0; i < target->capacity; i++)
+        {
+            if (target->buffer[i].state == CMC_ES_FILLED)
+            {
+                iter->first = i;
+                break;
+            }
+        }
+        iter->cursor = iter->first;
+        for (size_t i = target->capacity; i > 0; i--)
+        {
+            if (target->buffer[i - 1].state == CMC_ES_FILLED)
+            {
+                iter->last = i - 1;
+                break;
+            }
+        }
+    }
+}
+bool ms_iter_start(multiset_iter *iter) { return ms_empty(iter->target) || iter->start; }
+bool ms_iter_end(multiset_iter *iter) { return ms_empty(iter->target) || iter->end; }
+void ms_iter_to_start(multiset_iter *iter)
+{
+    iter->cursor = iter->first;
+    iter->index = 0;
+    iter->start = true;
+    iter->end = ms_empty(iter->target);
+}
+void ms_iter_to_end(multiset_iter *iter)
+{
+    iter->cursor = iter->last;
+    iter->index = iter->target->count - 1;
+    iter->start = ms_empty(iter->target);
+    iter->end = true;
+}
+bool ms_iter_next(multiset_iter *iter)
+{
+    if (iter->end)
+        return false;
+    multiset_entry *scan = &(iter->target->buffer[iter->cursor]);
+    if (iter->cursor == iter->last)
+        iter->end = true;
+    else
+    {
+        iter->index++;
+        while (1)
+        {
+            iter->cursor++;
+            scan = &(iter->target->buffer[iter->cursor]);
+            if (scan->state == CMC_ES_FILLED)
+                break;
+        }
+    }
+    iter->start = ms_empty(iter->target);
+    return true;
+}
+bool ms_iter_prev(multiset_iter *iter)
+{
+    if (iter->start)
+        return false;
+    multiset_entry *scan = &(iter->target->buffer[iter->cursor]);
+    if (iter->cursor == iter->first)
+        iter->start = true;
+    else
+    {
+        iter->index--;
+        while (1)
+        {
+            iter->cursor--;
+            scan = &(iter->target->buffer[iter->cursor]);
+            if (scan->state == CMC_ES_FILLED)
+                break;
+        }
+    }
+    iter->end = ms_empty(iter->target);
+    return true;
+}
+size_t ms_iter_value(multiset_iter *iter)
+{
+    if (ms_empty(iter->target))
+        return ms_impl_default_value();
+    return iter->target->buffer[iter->cursor].value;
+}
+size_t ms_iter_multiplicity(multiset_iter *iter)
+{
+    if (ms_empty(iter->target))
+        return 0;
+    return iter->target->buffer[iter->cursor].multiplicity;
+}
+size_t ms_iter_index(multiset_iter *iter) { return iter->index; }
+static multiset_entry *ms_impl_insert_and_return(multiset *_set_, size_t element, bool *new_node)
+{
+    *new_node = false;
+    multiset_entry *entry = ms_impl_get_entry(_set_, element);
+    if (entry != NULL)
+        return entry;
+    *new_node = true;
+    if ((double)_set_->capacity * _set_->load <= (double)_set_->count)
+    {
+        if (!ms_impl_grow(_set_))
+            return NULL;
+    }
+    size_t hash = _set_->hash(element);
+    size_t original_pos = hash % _set_->capacity;
+    size_t pos = original_pos;
+    size_t curr_mul = 1;
+    multiset_entry *target = &(_set_->buffer[pos]);
+    if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)
+    {
+        target->value = element;
+        target->multiplicity = curr_mul;
+        target->dist = pos - original_pos;
+        target->state = CMC_ES_FILLED;
+    }
+    else
+    {
+        while (true)
+        {
+            pos++;
+            target = &(_set_->buffer[pos % _set_->capacity]);
+            if (target->state == CMC_ES_EMPTY || target->state == CMC_ES_DELETED)
+            {
+                target->value = element;
+                target->multiplicity = curr_mul;
+                target->dist = pos - original_pos;
+                target->state = CMC_ES_FILLED;
+                break;
+            }
+            else if (target->dist < pos - original_pos)
+            {
+                size_t tmp = target->value;
+                size_t tmp_dist = target->dist;
+                size_t tmp_mul = target->multiplicity;
+                target->value = element;
+                target->dist = pos - original_pos;
+                target->multiplicity = curr_mul;
+                element = tmp;
+                original_pos = pos - tmp_dist;
+                curr_mul = tmp_mul;
+            }
+        }
+    }
+    _set_->count++;
+    return target;
+}
+static bool ms_impl_grow(multiset *_set_)
+{
+    size_t new_size = ms_impl_calculate_size(_set_->capacity + _set_->capacity / 2);
+    multiset *_new_set_ = ms_new(new_size, _set_->load, _set_->cmp, _set_->hash);
+    if (!_new_set_)
+        return false;
+    multiset_iter iter;
+    for (ms_iter_init(&iter, _set_); !ms_iter_end(&iter); ms_iter_next(&iter))
+    {
+        ms_insert_many(_new_set_, ms_iter_value(&iter), ms_iter_multiplicity(&iter));
+    }
+    if (_set_->count != _new_set_->count)
+    {
+        ms_free(_new_set_);
+        return false;
+    }
+    multiset_entry *tmp = _set_->buffer;
+    _set_->buffer = _new_set_->buffer;
+    _new_set_->buffer = tmp;
+    _set_->capacity = _new_set_->capacity;
+    ms_free(_new_set_);
+    return true;
+}
+static multiset_entry *ms_impl_get_entry(multiset *_set_, size_t element)
+{
+    size_t hash = _set_->hash(element);
+    size_t pos = hash % _set_->capacity;
+    multiset_entry *target = &(_set_->buffer[pos]);
+    while (target->state == CMC_ES_FILLED || target->state == CMC_ES_DELETED)
+    {
+        if (_set_->cmp(target->value, element) == 0)
+            return target;
+        pos++;
+        target = &(_set_->buffer[pos % _set_->capacity]);
+    }
+    return NULL;
+}
+static size_t ms_impl_calculate_size(size_t required)
+{
+    const size_t count = sizeof(cmc_hashtable_primes) / sizeof(cmc_hashtable_primes[0]);
+    if (cmc_hashtable_primes[count - 1] < required)
+        return required;
+    size_t i = 0;
+    while (cmc_hashtable_primes[i] < required)
+        i++;
+    return cmc_hashtable_primes[i];
+}
+static multiset_iter ms_impl_it_start(multiset *_set_)
+{
+    multiset_iter iter;
+    ms_iter_init(&iter, _set_);
+    return iter;
+}
+static multiset_iter ms_impl_it_end(multiset *_set_)
+{
+    multiset_iter iter;
+    ms_iter_init(&iter, _set_);
+    ms_iter_to_end(&iter);
+    return iter;
+}

tests/main/src/queue.c

@@ -1,5 +1,7 @@
 #include "cmc/queue.h"
 
+//QUEUE_GENERATE(q, queue, , size_t)
+
 typedef struct queue_s
 {
     size_t *buffer;

tests/main/src/stack.c

@@ -1,5 +1,7 @@
 #include "cmc/stack.h"
 
+//STACK_GENERATE(s, stack, , size_t)
+
 typedef struct stack_s
 {
     size_t *buffer;
@@ -139,7 +141,10 @@ void s_iter_free(stack_iter *iter) { free(iter); }
 void s_iter_init(stack_iter *iter, stack *target)
 {
     iter->target = target;
-    iter->cursor = iter->target->count - 1;
+    if (s_empty(target))
+        iter->cursor = 0;
+    else
+        iter->cursor = iter->target->count - 1;
     iter->start = true;
     iter->end = s_empty(target);
 }
@@ -163,7 +168,10 @@ bool s_iter_next(stack_iter *iter)
         return false;
     iter->start = s_empty(iter->target);
     if (iter->cursor == 0)
+    {
         iter->end = true;
+        return false;
+    }
     else
         iter->cursor--;
     return true;
@@ -174,7 +182,10 @@ bool s_iter_prev(stack_iter *iter)
         return false;
     iter->end = s_empty(iter->target);
     if (iter->cursor == iter->target->count - 1)
+    {
         iter->start = true;
+        return false;
+    }
     else
         iter->cursor++;
     return true;
@@ -191,7 +202,12 @@ size_t *s_iter_rvalue(stack_iter *iter)
         return NULL;
     return &(iter->target->buffer[iter->cursor]);
 }
-size_t s_iter_index(stack_iter *iter) { return iter->target->count - 1 - iter->cursor; }
+size_t s_iter_index(stack_iter *iter)
+{
+    if (s_empty(iter->target))
+        return 0;
+    return iter->target->count - 1 - iter->cursor;
+}
 static bool s_impl_grow(stack *_stack_)
 {
     size_t new_capacity = _stack_->capacity * 2;

tests/main/src/treemap.c

@@ -1,5 +1,7 @@
 #include "cmc/treemap.h"
 
+//TREEMAP_GENERATE(tm, treemap, , size_t, size_t)
+
 typedef struct treemap_s
 {
     struct treemap_node_s *root;

tests/main/src/treeset.c

@@ -1,5 +1,7 @@
 #include "cmc/treeset.h"
 
+//TREESET_GENERATE(ts, treeset, , size_t)
+
 typedef struct treeset_s
 {
     struct treeset_node_s *root;
@@ -331,7 +333,7 @@ treeset *ts_union(treeset *_set1_, treeset *_set2_)
 {
     treeset *_set_r_ = ts_new(_set1_->cmp);
     if (!_set_r_)
-        return false;
+        return NULL;
     treeset_iter iter1, iter2;
     ts_iter_init(&iter1, _set1_);
     ts_iter_init(&iter2, _set2_);
@@ -349,7 +351,7 @@ treeset *ts_intersection(treeset *_set1_, treeset *_set2_)
 {
     treeset *_set_r_ = ts_new(_set1_->cmp);
     if (!_set_r_)
-        return false;
+        return NULL;
     treeset *_set_A_ = _set1_->count < _set2_->count ? _set1_ : _set2_;
     treeset *_set_B_ = _set_A_ == _set1_ ? _set2_ : _set1_;
     treeset_iter iter;
@@ -366,7 +368,7 @@ treeset *ts_difference(treeset *_set1_, treeset *_set2_)
 {
     treeset *_set_r_ = ts_new(_set1_->cmp);
     if (!_set_r_)
-        return false;
+        return NULL;
     treeset_iter iter;
     ts_iter_init(&iter, _set1_);
     for (ts_iter_to_start(&iter); !ts_iter_end(&iter); ts_iter_next(&iter))
@@ -381,7 +383,7 @@ treeset *ts_symmetric_difference(treeset *_set1_, treeset *_set2_)
 {
     treeset *_set_r_ = ts_new(_set1_->cmp);
     if (!_set_r_)
-        return false;
+        return NULL;
     treeset_iter iter1, iter2;
     ts_iter_init(&iter1, _set1_);
     ts_iter_init(&iter2, _set2_);

tests/main/unt/heap.c

@@ -6,7 +6,7 @@
 
 CMC_CREATE_UNIT(heap_test, true, {
     CMC_CREATE_TEST(new, {
-        heap *h = h_new(1000000, MaxHeap, cmp);
+        heap *h = h_new(1000000, cmc_max_heap, cmp);
 
         cmc_assert_not_equals(ptr, NULL, h);
 
@@ -22,7 +22,7 @@ CMC_CREATE_UNIT(heap_test, true, {
     });
 
     CMC_CREATE_TEST(new[edge_case:capacity = 0], {
-        heap *h = h_new(0, MaxHeap, cmp);
+        heap *h = h_new(0, cmc_max_heap, cmp);
 
         cmc_assert_equals(ptr, NULL, h);
 
@@ -30,7 +30,7 @@ CMC_CREATE_UNIT(heap_test, true, {
     });
 
     CMC_CREATE_TEST(new[edge_case:capacity = UINT64_MAX], {
-        heap *h = h_new(UINT64_MAX, MaxHeap, cmp);
+        heap *h = h_new(UINT64_MAX, cmc_max_heap, cmp);
 
         cmc_assert_equals(ptr, NULL, h);
 
@@ -38,7 +38,7 @@ CMC_CREATE_UNIT(heap_test, true, {
     });
 
     CMC_CREATE_TEST(clear[count capacity], {
-        heap *h = h_new(100, MaxHeap, cmp);
+        heap *h = h_new(100, cmc_max_heap, cmp);
 
         cmc_assert_not_equals(ptr, NULL, h);
 
@@ -58,7 +58,7 @@ CMC_CREATE_UNIT(heap_test, true, {
     });
 
     CMC_CREATE_TEST(buffer_growth[edge_case:capacity = 1], {
-        heap *h = h_new(1, MaxHeap, cmp);
+        heap *h = h_new(1, cmc_max_heap, cmp);
 
         cmc_assert_not_equals(ptr, NULL, h);
 

tests/main/unt/linkedqueue.c

@@ -0,0 +1,41 @@
+#include "utl/assert.h"
+#include "utl/test.h"
+#include "../src/linkedqueue.c"
+
+CMC_CREATE_UNIT(linkedqueue_test, true, {
+    CMC_CREATE_TEST(new, {
+        linkedqueue *q = lq_new();
+
+        cmc_assert_not_equals(ptr, NULL, q);
+
+        bool passed = q->count == 0 && !q->head && !q->tail;
+
+        cmc_assert_equals(size_t, 0, lq_count(q));
+        cmc_assert_equals(ptr, NULL, q->head);
+        cmc_assert_equals(ptr, NULL, q->tail);
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        lq_free(q);
+    });
+
+    CMC_CREATE_TEST(clear[count], {
+        linkedqueue *q = lq_new();
+
+        cmc_assert_not_equals(ptr, NULL, q);
+
+        for (size_t i = 0; i < 50; i++)
+            lq_enqueue(q, i);
+
+        cmc_assert_equals(size_t, 50, lq_count(q));
+
+        lq_clear(q);
+
+        cmc_assert_equals(size_t, 0, lq_count(q));
+
+        CMC_TEST_PASS_ELSE_FAIL(lq_count(q) == 0);
+
+        lq_free(q);
+    });
+
+});

tests/main/unt/multimap.c

@@ -0,0 +1,173 @@
+#include "utl/assert.h"
+#include "utl/test.h"
+#include "../src/multimap.c"
+
+#include "utl.c"
+
+CMC_CREATE_UNIT(multimap_test, true, {
+    CMC_CREATE_TEST(new, {
+        multimap *map = mm_new(943722, 0.8, cmp, hash);
+
+        bool passed = (map->capacity >= (943722 / 0.8)) && map->count == 0 && map->buffer;
+
+        cmc_assert_not_equals(ptr, NULL, map);
+        cmc_assert_greater_equals(size_t, (943722 / 0.8), mm_capacity(map));
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        mm_free(map);
+    });
+
+    CMC_CREATE_TEST(new[edge_case:capacity = 0], {
+        multimap *map = mm_new(0, 0.8, cmp, hash);
+
+        cmc_assert_equals(ptr, NULL, map);
+
+        CMC_TEST_PASS_ELSE_FAIL(map == NULL);
+    });
+
+    CMC_CREATE_TEST(new[edge_case:capacity = UINT64_MAX], {
+        multimap *map = mm_new(UINT64_MAX, 0.8, cmp, hash);
+
+        cmc_assert_equals(ptr, NULL, map);
+
+        CMC_TEST_PASS_ELSE_FAIL(map == NULL);
+    });
+
+    CMC_CREATE_TEST(clear[count capacity], {
+        multimap *map = mm_new(100, 0.8, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, map);
+
+        for (size_t i = 0; i < 50; i++)
+            cmc_assert(mm_insert(map, i, i));
+
+        cmc_assert_equals(size_t, 50, mm_count(map));
+
+        mm_clear(map);
+
+        cmc_assert_equals(size_t, 0, mm_count(map));
+
+        CMC_TEST_PASS_ELSE_FAIL(mm_count(map) == 0);
+
+        mm_free(map);
+    });
+
+    CMC_CREATE_TEST(insert[count], {
+        multimap *map = mm_new(100, 0.8, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, map);
+
+        for (size_t i = 0; i < 200; i++)
+            cmc_assert(mm_insert(map, i % 20, i % 20));
+
+        cmc_assert_equals(size_t, 200, mm_count(map));
+
+        CMC_TEST_PASS_ELSE_FAIL(mm_count(map) == 200);
+
+        mm_free(map);
+    });
+
+    CMC_CREATE_TEST(remove[count], {
+        multimap *map = mm_new(100, 0.8, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, map);
+
+        for (size_t i = 0; i < 200; i++)
+            cmc_assert(mm_insert(map, i % 20, i % 20));
+
+        size_t r;
+
+        for (size_t i = 0; i < 60; i++)
+            cmc_assert(mm_remove(map, i % 20, &r));
+
+        cmc_assert_equals(size_t, 140, mm_count(map));
+
+        CMC_TEST_PASS_ELSE_FAIL(mm_count(map) == 140);
+
+        mm_free(map);
+    });
+
+    CMC_CREATE_TEST(remove[edge_case:count = 0], {
+        multimap *map = mm_new(100, 0.8, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, map);
+
+        size_t r;
+
+        cmc_assert(!mm_remove(map, 10, &r));
+
+        CMC_TEST_PASS_ELSE_FAIL(!mm_remove(map, 10, &r));
+
+        mm_free(map);
+    });
+
+    CMC_CREATE_TEST(remove[edge_case:count = 1], {
+        multimap *map = mm_new(100, 0.8, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, map);
+
+        size_t r;
+
+        cmc_assert(mm_insert(map, 10, 11));
+        cmc_assert(mm_remove(map, 10, &r));
+
+        CMC_TEST_PASS_ELSE_FAIL(mm_count(map) == 0);
+
+        mm_free(map);
+    });
+
+    CMC_CREATE_TEST(insert_if, {
+        multimap *map = mm_new(100, 0.8, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, map);
+
+        for (size_t i = 1; i <= 100; i++)
+            cmc_assert(mm_insert_if(map, i % 20, i, i % 2 == 0) || i % 2 != 0);
+
+        cmc_assert_equals(size_t, 50, mm_count(map));
+
+        CMC_TEST_PASS_ELSE_FAIL(mm_count(map) == 50);
+
+        mm_free(map);
+    });
+
+    CMC_CREATE_TEST(remove_if, {
+        multimap *map = mm_new(100, 0.8, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, map);
+
+        for (size_t i = 1; i <= 100; i++)
+            cmc_assert(mm_insert(map, i % 20, i));
+
+        size_t r;
+
+        for (size_t i = 1; i <= 100; i++)
+            cmc_assert(mm_remove_if(map, i % 20, &r, i % 2 == 0) || i % 2 != 0);
+
+        cmc_assert_equals(size_t, 50, mm_count(map));
+
+        CMC_TEST_PASS_ELSE_FAIL(mm_count(map) == 50);
+
+        mm_free(map);
+    });
+
+    CMC_CREATE_TEST(get[key_ordering], {
+        multimap *map = mm_new(100, 0.8, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, map);
+
+        /* Assert that the value 100 is accessed before the value 101 for the
+         * same key */
+        cmc_assert(mm_insert(map, 10, 100));
+        cmc_assert(mm_insert(map, 20, 102));
+        cmc_assert(mm_insert(map, 10, 101));
+
+        cmc_assert_equals(size_t, 100, mm_get(map, 10));
+
+        CMC_TEST_PASS_ELSE_FAIL(mm_get(map, 10) == 100);
+
+        mm_free(map);
+    });
+
+});

tests/main/unt/multiset.c

@@ -0,0 +1,102 @@
+#include "utl/assert.h"
+#include "utl/test.h"
+#include "../src/multiset.c"
+
+#include "utl.c"
+
+CMC_CREATE_UNIT(multiset_test, true, {
+    CMC_CREATE_TEST(new, {
+        multiset *set = ms_new(943722, 0.6, cmp, hash);
+
+        bool passed = (set->capacity >= (943722 / 0.6)) && set->count == 0 && set->buffer;
+
+        cmc_assert_not_equals(ptr, NULL, set);
+        cmc_assert(ms_capacity(set) > (943722 / 0.6));
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        ms_free(set);
+    });
+
+    CMC_CREATE_TEST(new[edge_case:capacity = 0], {
+        multiset *set = ms_new(0, 0.6, cmp, hash);
+
+        cmc_assert_equals(ptr, NULL, set);
+
+        CMC_TEST_PASS_ELSE_FAIL(set == NULL);
+    });
+
+    CMC_CREATE_TEST(new[edge_case:capacity = UINTMAX_MAX], {
+        multiset *set = ms_new(UINTMAX_MAX, 0.99, cmp, hash);
+
+        cmc_assert_equals(ptr, NULL, set);
+
+        CMC_TEST_PASS_ELSE_FAIL(set == NULL);
+    });
+
+    CMC_CREATE_TEST(clear[count capacity], {
+        multiset *set = ms_new(100, 0.6, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, set);
+
+        for (size_t i = 0; i < 50; i++)
+            cmc_assert(ms_insert(set, i));
+
+        cmc_assert_equals(size_t, 50, ms_count(set));
+
+        ms_clear(set);
+
+        cmc_assert_equals(size_t, 0, ms_count(set));
+
+        CMC_TEST_PASS_ELSE_FAIL(ms_count(set) == 0);
+
+        ms_free(set);
+    });
+
+    CMC_CREATE_TEST(insert[count cardinality multiplicity], {
+        multiset *set = ms_new(100, 0.6, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, set);
+
+        cmc_assert(ms_insert(set, 1));
+        cmc_assert(ms_insert(set, 2));
+        cmc_assert(ms_insert(set, 2));
+        cmc_assert(ms_insert(set, 3));
+        cmc_assert(ms_insert(set, 3));
+        cmc_assert(ms_insert(set, 3));
+
+        cmc_assert_equals(size_t, 3, ms_count(set));
+        cmc_assert_equals(size_t, 6, ms_cardinality(set));
+
+        bool passed = ms_count(set) == 3 && ms_cardinality(set) == 6;
+
+        for (size_t i = 0; i <= 3; i++)
+            passed = passed && ms_multiplicity_of(set, i) == i;
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        ms_free(set);
+    });
+
+    CMC_CREATE_TEST(multiplicity, {
+        multiset *set = ms_new(100, 0.6, cmp, hash);
+
+        cmc_assert_not_equals(ptr, NULL, set);
+
+        for (size_t i = 0; i < 100; i++)
+            cmc_assert(ms_insert(set, i % 20));
+
+        cmc_assert_equals(size_t, 20, ms_count(set));
+        cmc_assert_equals(size_t, 100, ms_cardinality(set));
+
+        bool passed = ms_count(set) == 20 && ms_cardinality(set) == 100;
+
+        for (size_t i = 0; i < 20; i++)
+            passed = passed && ms_multiplicity_of(set, i) == 5;
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        ms_free(set);
+    });
+
+});

tests/main/unt/stack.c

@@ -2,6 +2,8 @@
 #include "utl/test.h"
 #include "../src/stack.c"
 
+#include "utl.c"
+
 CMC_CREATE_UNIT(stack_test, true, {
     CMC_CREATE_TEST(new, {
         stack *s = s_new(1000000);
@@ -182,6 +184,18 @@ CMC_CREATE_UNIT(stack_test, true, {
         s_free(s);
     });
 
+    CMC_CREATE_TEST(pop[edge_case:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        cmc_assert_equals(bool, false, s_pop(s));
+
+        CMC_TEST_PASS_ELSE_FAIL(!s_pop(s));
+
+        s_free(s);
+    });
+
     CMC_CREATE_TEST(push_if, {
         stack *s = s_new(100);
 
@@ -277,6 +291,36 @@ CMC_CREATE_UNIT(stack_test, true, {
         s_free(s);
     });
 
+    CMC_CREATE_TEST(contains, {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        for (size_t i = 0; i < 150; i++)
+            cmc_assert(s_push(s, i));
+
+        bool passed = true;
+
+        for (size_t i = 0; i < 150; i++)
+            passed = passed && s_contains(s, i, cmp);
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(contains[edge_case:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        cmc_assert_equals(bool, false, s_contains(s, 10, cmp));
+
+        CMC_TEST_PASS_ELSE_FAIL(!s_contains(s, 10, cmp));
+
+        s_free(s);
+    });
+
     CMC_CREATE_TEST(empty, {
         stack *s = s_new(100);
 
@@ -332,4 +376,365 @@ CMC_CREATE_UNIT(stack_test, true, {
         s_free(s);
     });
 
+    CMC_CREATE_TEST(iter_alloc, {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        stack_iter *iter = s_iter_new(s);
+
+        cmc_assert_not_equals(ptr, NULL, iter);
+
+        CMC_TEST_PASS_ELSE_FAIL(s && iter);
+
+        s_iter_free(iter);
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iter_init[edge_case:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        stack_iter iter;
+
+        s_iter_init(&iter, s);
+
+        cmc_assert_equals(ptr, iter.target, s);
+        cmc_assert_equals(size_t, iter.cursor, 0);
+        cmc_assert(iter.start);
+        cmc_assert(iter.end);
+
+        bool passed = iter.target == s && iter.cursor == 0 && iter.start && iter.end;
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iter_start[edge_case:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        stack_iter iter;
+
+        s_iter_init(&iter, s);
+
+        CMC_TEST_PASS_ELSE_FAIL(s_iter_start(&iter));
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iter_end[edge_case:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        stack_iter iter;
+
+        s_iter_init(&iter, s);
+
+        CMC_TEST_PASS_ELSE_FAIL(s_iter_end(&iter));
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iteration, {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        for (size_t i = 1; i <= 200; i++)
+            cmc_assert(s_push(s, i));
+
+        size_t total = 0;
+
+        for (stack_iter it = s->it_start(s); !s_iter_end(&it); s_iter_next(&it))
+        {
+            total += s_iter_value(&it);
+        }
+
+        cmc_assert_equals(size_t, 20100, total);
+
+        for (stack_iter it = s->it_end(s); !s_iter_start(&it); s_iter_prev(&it))
+        {
+            total += s_iter_value(&it);
+        }
+
+        cmc_assert_equals(size_t, 40200, total);
+
+        CMC_TEST_PASS_ELSE_FAIL(total == 40200);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iteration[while loop], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        for (size_t i = 1; i <= 200; i++)
+            cmc_assert(s_push(s, i));
+
+        size_t total = 0;
+        stack_iter it = s->it_start(s);
+
+        do
+        {
+            total += s_iter_value(&it);
+        } while (s_iter_next(&it));
+
+        cmc_assert_equals(size_t, 20100, total);
+
+        it = s->it_end(s);
+
+        do
+        {
+            total += s_iter_value(&it);
+        } while (s_iter_prev(&it));
+
+        cmc_assert_equals(size_t, 40200, total);
+
+        CMC_TEST_PASS_ELSE_FAIL(total == 40200);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iteration[edge_case:count = 1], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+        cmc_assert(s_push(s, 10));
+
+        size_t total = 0;
+
+        for (stack_iter it = s->it_start(s); !s_iter_end(&it); s_iter_next(&it))
+        {
+            total += s_iter_value(&it);
+        }
+
+        for (stack_iter it = s->it_end(s); !s_iter_start(&it); s_iter_prev(&it))
+        {
+            total += s_iter_value(&it);
+        }
+
+        cmc_assert_equals(size_t, 20, total);
+
+        CMC_TEST_PASS_ELSE_FAIL(total == 20);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iteration[edge_case:count = capacity], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        while (!s_full(s))
+            cmc_assert(s_push(s, 10));
+
+        cmc_assert_equals(size_t, s_capacity(s), s_count(s));
+
+        size_t total = 0;
+
+        for (stack_iter it = s->it_start(s); !s_iter_end(&it); s_iter_next(&it))
+        {
+            total += s_iter_value(&it);
+        }
+
+        cmc_assert_equals(size_t, 1000, total);
+
+        for (stack_iter it = s->it_end(s); !s_iter_start(&it); s_iter_prev(&it))
+        {
+            total += *s_iter_rvalue(&it);
+        }
+
+        cmc_assert_equals(size_t, 2000, total);
+
+        CMC_TEST_PASS_ELSE_FAIL(total == 2000);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iteration[to_start = it_start and to_end = it_end], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        for (size_t i = 0; i < 50; i++)
+            cmc_assert(s_push(s, i));
+
+        bool passed = true;
+        stack_iter it1;
+        stack_iter it2;
+
+        memset(&it1, 0, sizeof(stack_iter));
+        memset(&it2, 0, sizeof(stack_iter));
+
+        s_iter_init(&it2, s);
+
+        it1 = s->it_start(s);
+        s_iter_to_start(&it2);
+
+        cmc_assert_equals(ptr, it1.target, it2.target);
+        cmc_assert_equals(size_t, it1.cursor, it2.cursor);
+        cmc_assert_equals(bool, it1.start, it2.start);
+        cmc_assert_equals(bool, it1.end, it2.end);
+        passed = passed && it1.target == it2.target && it1.cursor == it2.cursor && it1.start == it2.start && it1.end == it2.end;
+
+        it1 = s->it_end(s);
+        s_iter_to_end(&it2);
+
+        cmc_assert_equals(ptr, it1.target, it2.target);
+        cmc_assert_equals(size_t, it1.cursor, it2.cursor);
+        cmc_assert_equals(bool, it1.start, it2.start);
+        cmc_assert_equals(bool, it1.end, it2.end);
+        passed = passed && it1.target == it2.target && it1.cursor == it2.cursor && it1.start == it2.start && it1.end == it2.end;
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iteration[boundaries:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        stack_iter iter;
+        s_iter_init(&iter, s);
+
+        s_iter_to_end(&iter);
+
+        cmc_assert_equals(bool, false, s_iter_next(&iter));
+        bool passed = !s_iter_next(&iter);
+
+        s_iter_to_start(&iter);
+
+        cmc_assert_equals(bool, false, s_iter_prev(&iter));
+        passed = !s_iter_prev(&iter);
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iteration[boundaries:count > 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        for (size_t i = 0; i < 200; i++)
+            cmc_assert(s_push(s, i));
+
+        stack_iter iter;
+        s_iter_init(&iter, s);
+
+        s_iter_to_end(&iter);
+
+        cmc_assert_equals(bool, false, s_iter_next(&iter));
+        bool passed = !s_iter_next(&iter);
+
+        s_iter_to_start(&iter);
+
+        cmc_assert_equals(bool, false, s_iter_prev(&iter));
+        passed = !s_iter_prev(&iter);
+
+        CMC_TEST_PASS_ELSE_FAIL(passed);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iter_value[edge_case:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        stack_iter iter;
+
+        s_iter_init(&iter, s);
+
+        cmc_assert_equals(size_t, s_impl_default_value(), s_iter_value(&iter));
+
+        CMC_TEST_PASS_ELSE_FAIL(s_impl_default_value() == s_iter_value(&iter));
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(iter_rvalue[edge_case:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        stack_iter iter;
+
+        s_iter_init(&iter, s);
+
+        cmc_assert_equals(ptr, NULL, s_iter_rvalue(&iter));
+
+        CMC_TEST_PASS_ELSE_FAIL(NULL == s_iter_rvalue(&iter));
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(index, {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        for (size_t i = 0; i < 10; i++)
+            cmc_assert(s_push(s, i));
+
+        cmc_assert_equals(size_t, 10, s_count(s));
+
+        bool passed = true;
+        size_t total = 0;
+
+        for (stack_iter it = s->it_start(s); false; )
+        {
+            passed = passed && s_iter_index(&it) == 0;
+            cmc_assert_equals(size_t, 0, s_iter_index(&it));
+        }
+
+        for (stack_iter it = s->it_start(s); false; )
+        {
+            passed = passed && s_iter_index(&it) == s_count(s) - 1;
+            cmc_assert_equals(size_t, s_count(s) - 1, s_iter_index(&it));
+        }
+
+        for (stack_iter it = s->it_start(s); !s_iter_end(&it); s_iter_next(&it))
+        {
+            total += s_iter_index(&it);
+        }
+
+        cmc_assert_equals(size_t, 45, total);
+
+        for (stack_iter it = s->it_end(s); !s_iter_start(&it); s_iter_prev(&it))
+        {
+            total += s_iter_index(&it);
+        }
+
+        cmc_assert_equals(size_t, 90, total);
+
+        CMC_TEST_PASS_ELSE_FAIL(passed && total == 90);
+
+        s_free(s);
+    });
+
+    CMC_CREATE_TEST(index[edge_case:count = 0], {
+        stack *s = s_new(100);
+
+        cmc_assert_not_equals(ptr, NULL, s);
+
+        stack_iter iter;
+        s_iter_init(&iter, s);
+
+        cmc_assert_equals(size_t, 0, s_iter_index(&iter));
+
+        CMC_TEST_PASS_ELSE_FAIL(0 == s_iter_index(&iter));
+
+        s_free(s);
+    });
+
 });

tests/sep/main.c

@@ -25,7 +25,7 @@ int main(void)
     queue *q = q_new(1000);
     deque *d = d_new(1000);
     linked *ll = ll_new();
-    heap *h = h_new(1000, MaxHeap, intcmp);
+    heap *h = h_new(1000, cmc_max_heap, intcmp);
     tset *ts = ts_new(intcmp);
     tmap *tm = tm_new(intcmp);
     hset *hs = hs_new(1000, 0.9, intcmp, inthash);