ziglang-set

KO | EN

gitlite — search

#python #ai #typescript #golang #deep-learning #linux #nodejs #windows #cli #vue #awesome-list #pytorch #ios #openai

(★ 107)

A generic and general purpose Set implementation for the Zig language

ziglang-set Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

### Ziglang Set

![License](https://img.shields.io/github/license/deckarep/ziglang-set) ![Issue](https://img.shields.io/github/issues-raw/deckarep/ziglang-set?style=flat) ![Commit](https://img.shields.io/github/last-commit/deckarep/ziglang-set) ![CI](https://github.com/deckarep/ziglang-set/actions/workflows/test.yml/badge.svg)

Ziglang-Set: a generic and general-purpose Set implementation for Zig. 🚧 BETA 🚧

#

 <a href="https://deckarep.github.io/ziglang-set/"><img src="https://img.shields.io/badge/api-reference-blue.svg?style=flat-square" alt="API Reference"></a>

A set offers a fast way to manipulate data and avoid excessive looping.

Zig currently [does not have](https://github.com/ziglang/zig/issues/6919) a built-in, general purpose Set data structure at this point in time. Until it does, try this!

Rationale: It may be common knowledge that a dictionary, map or hashset can be used as a set with a value of `void`. While this is true, there's a lot to think about in terms of supporting all the common set operations in a performant and correct way and there's no good reason why a common module for this shouldn't exist. I'm hoping this implementation can fill that gap and provide some value after being modeled similar to other collections in Zig's stdlib.

This module offers a Set implementation built in the same vein and spirit of the other data structures within the Zig standard library. This is an attempt to model one that can get better over time and grow with community interest and support. See a problem, file a bug! Or better yet contribute and let's build the best implementation together.

I am the original author of a popular Go based set package: [golang-set](https://github.com/deckarep/golang-set) that is used by software components built by Docker, 1Password, Ethereum, SendGrid, CrowdStrike and HashiCorp. At just shy of `4.7k stars`, I figured I'd take a crack at building a comprehensive and generic Zig-based set that goes above and beyond the original Go implementation. After using Zig for over 3+ years on personal projects, I thought it was time that Zig had a robust Set implementation for itself.

This implementation gives credit and acknowledgement to the [Zig language](https://ziglang.org) and powerful [Std Library](https://ziglang.org/documentation/master/std/#std) [HashMap](https://ziglang.org/documentation/master/std/#std.hash_map.HashMap) data structure of which this set implementation is built on top of. Without that, this probably wouldn't exist. Efforts will be made to keep the Ziglang Set code fast and straightforward but this Set's raw speed will largely be bounded by the performance of the Zig HashMap of which it is built on top of.

#### Features
  * Offers idiomatic, generic-based Zig API - allocator support, iterators, capacity hints, clearing, resizing, etc.
  * A few flavors to choose from
    * NOTE: Future versions of Zig [will be deprecating the `managed` variants](https://ziglang.org/download/0.14.0/release-notes.html#Embracing-Unmanaged-Style-Containers), and this repo will be following suit.
    * Hash-based: everyday usecase, optimized for lookups primarily, insertion/removal secondarily - [further reading](https://devlog.hexops.com/2022/zig-hashmaps-explained/)
    * Array-based: more specialized, iteration much faster, insertion order preserved, indexing into underylying data - [further reading](https://devlog.hexops.com/2022/zig-hashmaps-explained/)
  * Common set operations
    * add, append, appendSlice
    * remove, removeAll
    * containsOne, containsAny, containsAll
    * clone, cloneWithAllocator
    * equals, isEmpty, cardinality
    * intersection, intersectionUpdate (in-place variant)
    * union, unionUpdate (in-place variant)
    * difference, differenceUpdate (in-place variant)
    * symmetricDifference, symmetricDifferenceUpdate (in-place variant)
    * isDisjoint
    * isSubset
    * isSuperset
    * isProperSubset
    * isProperSuperset
    * pop
  * Fully documented and robustly tested
  * Performance aware to minimize unecessary allocs/iteration internally
  * Custom hash function support
  * "string" support
  * Benchmarks

#### Example
```zig
    // import the namespace.
    const set = @import("ziglangSet");

// Create a set of u32s called A
    var A = set.Set(u32).init(std.testing.allocator);
    defer A.deinit();

// Add some data
    _ = try A.add(5);
    _ = try A.add(6);
    _ = try A.add(7);

// Add more data; single shot, duplicate data is ignored.
    _ = try A.appendSlice(&.{ 5, 3, 0, 9 });

// Create another set called B
    var B = set.Set(u32).init(std.testing.allocator);
    defer B.deinit();

// Add data to B
    _ = try B.appendSlice(&.{ 50, 30, 20 });

// Get the union of A | B
    var un = try A.unionOf(B);
    defer un.deinit();

// Grab an iterator and dump the contents.
    var iter = un.iterator();
    while (iter.next()) |el| {
        std.log.debug("element: {d}", .{el.*});
    }
```
#

Output of `A | B` - the union of A and B (order is not guaranteed)
```sh
> element: 5
> element: 6
> element: 7
> element: 3
> element: 0
> element: 9
> element: 50
> element: 30
> element: 20
```

#### Custom Hash Function

To use a custom hash function, you can use the following types:

- `HashSetUnmanagedWithContext`
- `HashSetManagedWithContext`

Example:

```zig
    const SimpleHasher = struct {
        const Self = @This();
        pub fn hash(_: Self, key: u32) u64 {
            return @as(u64, key) *% 0x517cc1b727220a95;
        }
        pub fn eql(_: Self, a: u32, b: u32) bool {
            return a == b;
        }
    };

const ctx = SimpleHasher{};
    var set = HashSetUnmanagedWithContext(u32, SimpleHasher, 75).initContext(ctx);
    defer set.deinit(testing.allocator);

_ = try set.add(testing.allocator, 123);
    try expect(set.contains(123));
    try expect(!set.contains(456));
```

#### Installation of Module

To add this module, update your applications build.zig.zon file by adding the `.ziglang-set` dependency definition.

```zig
.{
    .name = "your-app",
    .version = "0.1.0",
    .dependencies = .{
        .ziglangSet = .{
            .url = "https://github.com/deckarep/ziglang-set/archive/$COMMIT_YOU_WANT_TO_USE.tar.gz",
        },
    },
}
```

When running zig build now, Zig will tell you you need a hash for the dependency and provide one.
Put it in your dependency so it looks like:

```zig
.{
  .ziglangSet = .{
      .url = "https://github.com/deckarep/ziglang-set/archive/$COMMIT_YOU_WANT_TO_USE.tar.gz",
      .hash = "$HASH_ZIG_GAVE_YOU",
  },
}
```

With the dependency in place, you can now put the following in your build.zig file:

```zig
    const ziglangSet = b.dependency("ziglangSet", .{});
    exe.root_module.addImport("ziglangSet", ziglangSet.module("ziglangSet"));
```

In the above change `exe` to whatever CompileStep you are using. For an executable it will
probably be exe, but `main_tests` or lib are also common.

With the build file in order, you can now use the module in your zig source. For example:

```zig
const std = @import("std");
const set = @import("ziglangSet");

pub fn main() void {
    // 1. This datastructure requires an allocator.
    //    Setup and choose your respective allocator.
    // See: https://zig.guide/standard-library/allocators

// 2. Go to town!
    var A = set.Set(u32).init(allocator);
    defer A.deinit();

// Now do something cool with your set!
    // ...
}
```

Check the tests for more comprehensive examples on how to use this package.

#### Testing

```sh
zig build test
```

#### Docs Generation

```sh
# With Zig installed:
zig build docs && cp -a zig-out/docs/. docs/

# Alternatively, using Zigup:
zigup run <zig-version> build docs && cp -a zig-out/docs/. docs/
```

ziglang-set

ziglang-set Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ziglang-set

ziglang-set Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README