The first revision (#5)

Author: habedi

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add logs to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussions
+    url: https://github.com/CogitatorTech/ordered/discussions
+    about: Please ask and answer general questions here

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/benches.yml

@@ -3,8 +3,6 @@ name: Run Benchmarks
 on:
   workflow_dispatch:
   push:
-    branches:
-      - main
     tags:
       - 'v*'
   pull_request:
@@ -25,7 +23,7 @@ jobs:
       - name: Install Zig
         uses: goto-bus-stop/setup-zig@v2
         with:
-          version: '0.15.1'
+          version: '0.15.2'
 
       - name: Install Dependencies
         run: |

.github/workflows/docs.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Install Zig
         uses: goto-bus-stop/setup-zig@v2
         with:
-          version: '0.15.1'
+          version: '0.15.2'
 
       - name: Install System Dependencies
         run: |

.github/workflows/lints.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Install Zig
         uses: goto-bus-stop/setup-zig@v2
         with:
-          version: '0.15.1'
+          version: '0.15.2'
 
       - name: Install Dependencies
         run: |

.github/workflows/tests.yml

@@ -3,8 +3,6 @@ name: Run Tests
 on:
   workflow_dispatch:
   push:
-    branches:
-      - main
     tags:
       - 'v*'
   pull_request:
@@ -25,7 +23,7 @@ jobs:
       - name: Install Zig
         uses: goto-bus-stop/setup-zig@v2
         with:
-          version: '0.15.1'
+          version: '0.15.2'
 
       - name: Install Dependencies
         run: |

Makefile

@@ -1,7 +1,7 @@
 # ################################################################################
 # # Configuration and Variables
 # ################################################################################
-ZIG    ?= $(shell which zig || echo ~/.local/share/zig/0.15.1/zig)
+ZIG    ?= $(shell which zig || echo ~/.local/share/zig/0.15.2/zig)
 BUILD_TYPE    ?= Debug
 BUILD_OPTS      = -Doptimize=$(BUILD_TYPE)
 JOBS          ?= $(shell nproc || echo 2)

README.md

@@ -7,42 +7,38 @@
 <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)
-[![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)
+[![Benchmarks](https://img.shields.io/github/actions/workflow/status/CogitatorTech/ordered/benches.yml?label=benchmarks&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)
+[![Zig Version](https://img.shields.io/badge/Zig-0.15.2-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download/)
+<br>
 [![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 in pure Zig
+Pure Zig implementations of high-performance, memory-safe ordered data structures
 
 </div>
 
 ---
 
-Ordered is a Zig library that provides fast and efficient implementations of various popular data structures including
+Ordered is a Zig library that provides efficient implementations of various popular data structures including
 B-tree, skip list, trie, and red-black tree for Zig programming language.
 
-### Supported Data Structures
+### Features
 
-Currently supported data structures include:
+To be added.
 
-- [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 Structures
 
-| # | Data Structure | Build Complexity | Memory Complexity | Search Complexity    |  
-|---|----------------|------------------|-------------------|----------------------|
-| 1 | B-tree         | $O(\log n)$      | $O(n)$            | $O(\log n)$          |  
-| 2 | Cartesian tree | $O(\log n)$\*    | $O(n)$            | $O(\log n)$\* |  
-| 3 | Red-black tree | $O(\log n)$      | $O(n)$            | $O(\log n)$          |  
-| 4 | Skip list      | $O(\log n)$\*    | $O(n)$            | $O(\log n)$\* |  
-| 5 | Sorted set     | $O(n)$           | $O(n)$            | $O(\log n)$          |
-| 6 | Trie           | $O(m)$           | $O(n \cdot m)$    | $O(m)$               |  
+| Data Structure                                                         | Build Complexity | Memory Complexity | Search Complexity |  
+|------------------------------------------------------------------------|------------------|-------------------|-------------------|
+| [B-tree](https://en.wikipedia.org/wiki/B-tree)                         | $O(\log n)$      | $O(n)$            | $O(\log n)$       |  
+| [Cartesian tree](https://en.wikipedia.org/wiki/Cartesian_tree)         | $O(\log n)$\*    | $O(n)$            | $O(\log n)$\*     |  
+| [Red-black tree](https://en.wikipedia.org/wiki/Red%E2%80%93black_tree) | $O(\log n)$      | $O(n)$            | $O(\log n)$       |  
+| [Skip list](https://en.wikipedia.org/wiki/Skip_list)                   | $O(\log n)$\*    | $O(n)$            | $O(\log n)$\*     |  
+| Sorted set                                                             | $O(n)$           | $O(n)$            | $O(\log n)$       |
+| [Trie](https://en.wikipedia.org/wiki/Trie)                             | $O(m)$           | $O(n \cdot m)$    | $O(m)$            |  
 
 - $n$: number of stored elements
 - $m$: maximum length of a key
@@ -72,6 +68,10 @@ and view in a web browser.
 
 Check out the [examples](examples) directory for example usages of Ordered.
 
+### Benchmarks
+
+To be added.
+
 ---
 
 ### Contributing

benches/b2_sorted_set.zig

@@ -32,7 +32,7 @@ fn benchmarkAdd(allocator: std.mem.Allocator, size: usize) !void {
 
     var i: i32 = 0;
     while (i < size) : (i += 1) {
-        try set.add(i);
+        _ = try set.put(i);
     }
 
     const elapsed = timer.read() - start;
@@ -51,7 +51,7 @@ fn benchmarkContains(allocator: std.mem.Allocator, size: usize) !void {
 
     var i: i32 = 0;
     while (i < size) : (i += 1) {
-        try set.add(i);
+        _ = try set.put(i);
     }
 
     var timer = try Timer.start();
@@ -80,7 +80,7 @@ fn benchmarkRemove(allocator: std.mem.Allocator, size: usize) !void {
 
     var i: i32 = 0;
     while (i < size) : (i += 1) {
-        try set.add(i);
+        _ = try set.put(i);
     }
 
     var timer = try Timer.start();