https://github.com/habedi/ordered

A collection of useful data structures that keep data sorted by key
https://github.com/habedi/ordered

data-structures ordered-collections zig zig-library zig-package ziglang

Last synced: about 2 months ago
JSON representation

A collection of useful data structures that keep data sorted by key

• Host: GitHub
• URL: https://github.com/habedi/ordered
• Owner: habedi
• License: mit
• Created: 2025-07-31T20:13:17.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2025-08-11T19:43:10.000Z (2 months ago)
• Last Synced: 2025-08-11T21:11:51.987Z (2 months ago)
• Topics: data-structures, ordered-collections, zig, zig-library, zig-package, ziglang
• Language: Zig
• Homepage:
• Size: 2.66 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


  

    

  




Ordered


[![Tests](https://img.shields.io/github/actions/workflow/status/habedi/ordered/tests.yml?label=tests&style=flat&labelColor=282c34&logo=github)](https://github.com/habedi/ordered/actions/workflows/tests.yml)

[![CodeFactor](https://img.shields.io/codefactor/grade/github/habedi/ordered?label=code%20quality&style=flat&labelColor=282c34&logo=codefactor)](https://www.codefactor.io/repository/github/habedi/ordered)

[![Zig Version](https://img.shields.io/badge/Zig-0.14.1-orange?logo=zig&labelColor=282c34)](https://ziglang.org/download/)

[![Docs](https://img.shields.io/github/v/tag/habedi/ordered?label=docs&color=blue&style=flat&labelColor=282c34&logo=read-the-docs)](https://habedi.github.io/ordered/)

[![Release](https://img.shields.io/github/release/habedi/ordered.svg?label=release&style=flat&labelColor=282c34&logo=github)](https://github.com/habedi/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/habedi/ordered/blob/main/LICENSE)

A Zig library of common data structures that keep data in order



---

Ordered Zig library includes implementations of popular data structures including B-tree, skip list, trie, and

red-black tree.

### Features

- Implementations for common data structures that maintain the order of keys:

    - [`BTreeMap`](src/btree_map.zig): A balanced tree map that maintains order of keys.

    - [`OrderedSet`](src/sorted_set.zig): A set with ordered elements.

    - [`SkipList`](src/skip_list.zig): A probabilistic data structure that allows fast search, insertion, and deletion.

    - [`Trie`](src/trie.zig): A prefix tree for fast retrieval of keys with common prefixes.

    - [`RedBlackTree`](src/red_black_tree.zig): A self-balancing binary search tree that maintains order of keys.

> [!IMPORTANT]

> Zig-DbC is in early development, so bugs and breaking API changes are expected.

> Please use the [issues page](https://github.com/habedi/zig-dbc/issues) to report bugs or request features.

---

### Getting Started

To be added.

---

### Documentation

You can find the API documentation for the latest release of Ordered [here](https://habedi.github.io/ordered/).

Alternatively, you can use the `make docs` command to generate the documentation for the current version of Ordered.

This will generate HTML documentation in the `docs/api` directory, which you can serve locally with `make serve-docs`

and view in a web browser.

### Examples

Check out the [examples](examples/) directory for example usages of Ordered.

---

### Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution.

### License

Ordered is licensed under the MIT License (see [LICENSE](LICENSE)).

### Acknowledgements

* The logo is from [SVG Repo](https://www.svgrepo.com/svg/469537/zig-zag-left-right-arrow).