ee is a header-only C library that provides common data structures and utilities. It is designed to be self-contained and easily integrated into any C99 project, as it has no external dependencies.

The library provides the following modules:

• Memory management

  • ee_arena.h: A fast, linear arena allocator.
  • ee_core.h: Support for optional custom allocators.

• Dynamic containers

  • ee_array.h: Dynamic arrays (also known as resizable vectors).
  • ee_dict.h: Hash maps with open addressing.
  • ee_heap.h: Binary heaps, often used for priority queues.
  • ee_set.h: Hash sets for efficient item lookup.
  • ee_grid.h: 2D grids, useful for spatial data or games.

• String utilities

  • ee_string.h: Utilities for dynamic strings, fixed-length buffers, and lightweight string views.

• System utilities

  • ee_fs.h: Filesystem traversal and file utilities (Windows-only).
  • ee_random.h: Random number generation (uniform and normal distributions).

• Minimum C Standard: C99
• Tested Compilers: MSVC, GCC

As ee is a header-only library, you do not need to build it separately. You can use it in your project in two ways.

1. Clone the repository:

git clone https://github.com/eesuck1/eelib.git

2. Add the utils/ directory to your project's include path.

3. Include the headers you need in your C source files:

#include "ee_array.h"
#include "ee_dict.h"
#include "ee_string.h.h"
// ...and so on

You can also copy individual header files directly into your project.

You can configure the library's behavior by defining specific macros before including its headers.

By default, the library uses EE_ASSERT() to validate conditions at runtime (e.g., checking for null pointers). You can disable these checks for performance in a release build.

Define EE_NO_ASSERT before including any ee headers to remove all assertion checks at compile time.

Usage example:

// Disable all assertions for this build
#define EE_NO_ASSERT

#include "ee_core.h"
#include "ee_array.h"

The library includes support for SIMD (Single Instruction, Multiple Data) optimizations. The available levels are:

Work is currently in progress for:

• Dynamic Heap (ee_heap)
• File System Utilities (ee_fs)
• Double-Ended Queue (ee_deq)
• ...and more.

These modules will be added to the documentation as they become stable.