KyleStructs

This is a C library I wrote to satisfy my own curiosity as to how simple data structures like tree sets and hash maps might be implemented. My goal has been to design and write everything as clearly and logically as possible while maintaining effiency.

The documentation for each data structure is located in its respective header file in src/include/.

Demo

Here is a quick example of how KyleStructs might be used:

/* gcc main.c -lkylestructs */

#include <stdio.h>
#include <string.h>
#include <kylestructs.h>


int main()
{
  ks_hashmap* phonebook = ks_hashmap_new(KS_CHARP, 10);
  const ks_datacont* number_dc;
  const ks_datacont* name_dc;

  char number[30] = {0};
  char name[30] = {0};

  printf("Enter a name followed by a 10-digit phone number:\n");

  while (scanf("%s %s", name, number) != -1)
  {
    number_dc = ks_datacont_new(number, KS_CHARP, strlen(number));
    name_dc = ks_datacont_new(name, KS_CHARP, strlen(name));

    if (ks_hashmap_add(phonebook, number_dc, name_dc) == 1)
      printf("Replaced existing number %s.\n", number);

    memset(number, 0, 30);
    memset(name, 0, 30);
  }

  int count = ks_hashmap_count(phonebook);

  for (int i = 0; i < count; i++)
  {
    number_dc = ks_hashmap_get_key(phonebook, i);
    name_dc = ks_hashmap_get(phonebook, number_dc);

    printf("%s => %s\n", number_dc->cp, name_dc->cp);
  }

  ks_hashmap_delete(phonebook);
}

Library Overview

At the center of all of these different data structures is the ks_datacont struct. It is a container that can hold pretty much any primitive data type, and comes with a library for comparison, duplication, hashing, and more. All other structures are built on top of the ks_datacont struct so that they in turn can handle most kinds of data. As the design for each structure grows more complex, functionality is borrowed from one or more of those that are less complex. Here is a graph to illustrate the order of "inheritance":

Build and Install

$ git clone https://github.com/krglaws/KyleStructs
$ cd KyleStructs
$ make
$ sudo make install

Contributing

If you would like to contribute, feel free to fork this repository and submit a pull request. Be sure to add to or change the existing tests to reflect your changes.

Images generated using Graphviz

To Do:

write toString functions for each structure
write toDotFile functions for each structure
write set operation functions (e.g. union, intersection, difference, comparison, etc.)

krglaws / KyleStructs