Add benchmarks

Author: habedi

.github/workflows/benches.yml

@@ -0,0 +1,36 @@
+name: Run Benchmarks
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  benchmarks:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+
+      - name: Install Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          version: '0.15.1'
+
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y make
+
+      - name: Run the Benchmarks
+        run: make bench

.github/workflows/docs.yml

@@ -1,12 +1,11 @@
 name: Publish API Documentation
 
 on:
+  workflow_dispatch:
   push:
     tags:
       - 'v*'
 
-  workflow_dispatch:
-
 permissions:
   contents: write
 

.github/workflows/lints.yml

@@ -1,18 +1,14 @@
 name: Run Linter Checks
 
 on:
+  workflow_dispatch:
   push:
-    branches:
-      - main
     tags:
       - 'v*'
-
   pull_request:
     branches:
       - main
 
-  workflow_dispatch:
-
 permissions:
   contents: read
 

.github/workflows/tests.yml

@@ -1,18 +1,16 @@
 name: Run Tests
 
 on:
+  workflow_dispatch:
   push:
     branches:
       - main
     tags:
       - 'v*'
-
   pull_request:
     branches:
       - main
 
-  workflow_dispatch:
-
 permissions:
   contents: read
 

README.md

@@ -7,32 +7,33 @@
 <h2>Ordered</h2>
 
 [![Tests](https://img.shields.io/github/actions/workflow/status/CogitatorTech/ordered/tests.yml?label=tests&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/ordered/actions/workflows/tests.yml)
-[![CodeFactor](https://img.shields.io/codefactor/grade/github/CogitatorTech/ordered?label=code%20quality&style=flat&labelColor=282c34&logo=codefactor)](https://www.codefactor.io/repository/github/CogitatorTech/ordered)
-[![Zig Version](https://img.shields.io/badge/Zig-0.15.1-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download/)
+[![Benchmarks](https://img.shields.io/github/actions/workflow/status/CogitatorTech/ordered/benches.yml?label=benches&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/ordered/actions/workflows/benches.yml)
+[![CodeFactor](https://img.shields.io/codefactor/grade/github/CogitatorTech/ordered?label=quality&style=flat&labelColor=282c34&logo=codefactor)](https://www.codefactor.io/repository/github/CogitatorTech/ordered)
 [![Docs](https://img.shields.io/badge/docs-view-blue?style=flat&labelColor=282c34&logo=read-the-docs)](https://CogitatorTech.github.io/ordered/)
 [![Examples](https://img.shields.io/badge/examples-view-green?style=flat&labelColor=282c34&logo=zig)](https://github.com/CogitatorTech/ordered/tree/main/examples)
+[![Zig Version](https://img.shields.io/badge/Zig-0.15.1-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download/)
 [![Release](https://img.shields.io/github/release/CogitatorTech/ordered.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/CogitatorTech/ordered/releases/latest)
 [![License](https://img.shields.io/badge/license-MIT-007ec6?label=license&style=flat&labelColor=282c34&logo=open-source-initiative)](https://github.com/CogitatorTech/ordered/blob/main/LICENSE)
 
-A collection of data structures that keep data in order
+A collection of data structures that keep data in order in pure Zig
 
 </div>
 
 ---
 
-Ordered library includes fast and efficient implementations of popular data structures including
+Ordered is a Zig library that provides fast and efficient implementations of various popular data structures including
 B-tree, skip list, trie, and red-black tree for Zig programming language.
 
 ### Supported Data Structures
 
 Currently supported data structures include:
 
-- [B-tree](src/ordered/btree_map.zig): a balanced n-array tree that maintains the order of keys.
-- [Sorted set](src/ordered/sorted_set.zig): a set with ordered elements based on keys.
-- [Skip list](src/ordered/skip_list.zig): a probabilistic data structure that maintains sorted order using multiple linked lists.
-- [Trie](src/ordered/trie.zig): a prefix tree that supports efficient retrieval of keys with common prefixes.
-- [Red-black tree](src/ordered/red_black_tree.zig): A self-balancing binary search tree that maintains the order of keys
-- [Cartesian tree](src/ordered/cartesian_tree.zig): A binary tree that maintains both a binary search tree property on keys and a heap property on priorities.
+- [B-tree](src/ordered/btree_map.zig): A self-balancing search tree where nodes can have many children.
+- [Sorted Set](src/ordered/sorted_set.zig): A data structure that stores a collection of unique elements in a consistently sorted order.
+- [Skip List](src/ordered/skip_list.zig): A probabilistic data structure that uses multiple linked lists to create "express lanes" for fast, tree-like search.
+- [Trie](src/ordered/trie.zig): A tree where paths from the root represent prefixes which makes it extremely fast for tasks like text autocomplete.
+- [Red-black Tree](src/ordered/red_black_tree.zig): A self-balancing binary search tree that uses node colors to guarantee efficient operations.
+- [Cartesian Tree](src/ordered/cartesian_tree.zig): A binary tree that uniquely combines a binary search tree property for its keys with a heap** property for its values.
 
 | # | Data Structure | Build Complexity | Memory Complexity | Search Complexity    |  
 |---|----------------|------------------|-------------------|----------------------|

benches/README.md

@@ -1,16 +1,16 @@
-# Benchmarks
+## Benchmarks
 
-This directory contains performance benchmarks for all data structures in the `ordered` library.
+This directory contains benchmarks for the data structures in the `ordered` library.
 
-## Running Benchmarks
+### Running Benchmarks
 
 Each benchmark can be run using the following command pattern:
 
 ```bash
 zig build bench-<benchmark_name>
 ```
 
-### Available Benchmarks
+#### Available Benchmarks
 
 - **BTreeMap**: `zig build bench-btree_map_bench`
 - **SortedSet**: `zig build bench-sorted_set_bench`
@@ -19,53 +19,53 @@ zig build bench-<benchmark_name>
 - **Trie**: `zig build bench-trie_bench`
 - **CartesianTree**: `zig build bench-cartesian_tree_bench`
 
-## What Each Benchmark Tests
+### What Each Benchmark Tests
 
-### BTreeMap Benchmark
+#### BTreeMap Benchmark
 - **Insert**: Sequential insertion of integers
 - **Lookup**: Finding all inserted keys
 - **Delete**: Removing all keys
 
-### SortedSet Benchmark
-- **Add**: Adding elements while maintaining sorted order
+#### SortedSet Benchmark
+- **Add**: Adding elements while maintaining a sorted order
 - **Contains**: Checking if elements exist
 - **Remove**: Removing elements from the set
 
-### RedBlackTree Benchmark
+#### RedBlackTree Benchmark
 - **Insert**: Inserting nodes with self-balancing
 - **Find**: Searching for nodes
 - **Remove**: Deleting nodes while maintaining balance
 - **Iterator**: In-order traversal performance
 
-### SkipList Benchmark
+#### SkipList Benchmark
 - **Put**: Inserting key-value pairs with probabilistic levels
 - **Get**: Retrieving values by key
 - **Delete**: Removing key-value pairs
 
-### Trie Benchmark
+#### Trie Benchmark
 - **Put**: Inserting strings with associated values
 - **Get**: Retrieving values by string key
 - **Contains**: Checking if strings exist
 - **Prefix Search**: Finding all keys with a common prefix
 
-### CartesianTree Benchmark
+#### CartesianTree Benchmark
 - **Put**: Inserting key-value pairs with random priorities
 - **Get**: Retrieving values by key
 - **Remove**: Deleting nodes
 - **Iterator**: In-order traversal performance
 
-## Benchmark Sizes
+### Benchmark Sizes
 
 Each benchmark tests with multiple dataset sizes:
 - Small: 1,000 items
 - Medium: 10,000 items
 - Large: 50,000 - 100,000 items (varies by data structure)
 
-## Build Configuration
+### Build Configuration
 
 Benchmarks are compiled with `ReleaseFast` optimization mode for accurate performance measurements.
 
-## Example Output
+### Example Output
 
 ```
 === BTreeMap Benchmark ===
@@ -79,9 +79,9 @@ Lookup 10000 items: 2.10 ms (210 ns/op, found: 10000)
 Delete 10000 items: 4.15 ms (415 ns/op)
 ```
 
-## Notes
+### Notes
 
 - All benchmarks use a simple integer or string key type for consistency
 - Times are reported in both total milliseconds and nanoseconds per operation
-- Memory allocations use `GeneralPurposeAllocator` for production-like behavior
-
+- Memory allocations use `GeneralPurposeAllocator` for simulating a more realistic memory usage
+- Results may vary based on a hardware and system load

benches/b1_btree_map.zig

@@ -100,4 +100,3 @@ fn benchmarkDelete(allocator: std.mem.Allocator, size: usize) !void {
         ns_per_op,
     });
 }
-

benches/b2_sorted_set.zig

@@ -99,4 +99,3 @@ fn benchmarkRemove(allocator: std.mem.Allocator, size: usize) !void {
         ns_per_op,
     });
 }
-

benches/b3_red_black_tree.zig

@@ -135,4 +135,3 @@ fn benchmarkIterator(allocator: std.mem.Allocator, size: usize) !void {
         count,
     });
 }
-

benches/b4_skip_list.zig

@@ -100,4 +100,3 @@ fn benchmarkDelete(allocator: std.mem.Allocator, size: usize) !void {
         ns_per_op,
     });
 }
-