https://github.com/scnewma/gosets

Sets in Go!
https://github.com/scnewma/gosets

Last synced: 10 days ago
JSON representation

Sets in Go!

• Host: GitHub
• URL: https://github.com/scnewma/gosets
• Owner: scnewma
• License: apache-2.0
• Created: 2023-01-28T19:02:48.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-30T01:47:11.000Z (almost 2 years ago)
• Last Synced: 2024-06-20T17:47:27.516Z (5 months ago)
• Language: Go
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# go-sets

[![Go Reference](https://pkg.go.dev/badge/github.com/scnewma/gosets.svg)](https://pkg.go.dev/github.com/scnewma/gosets/hashset)

Tired of writing code like this?

```

set := map[string]struct{}{}

set["bob"] = struct{}{}

_, contains := set["bob"]

if contains {

    // ...

}

```

This package introduces a new `hashset.Set[T]` type that allows you to write this instead.

```

set := hashset.New[string](nil)

set.Insert("bob")

if set.Contains("bob") {

    // ...

}

```

In addition to basic set operations, it also supports common functions from set theory, which can be useful at times.

```

s1 := hashset.New([]string{"a", "b", "c"})

s2 := hashset.New([]string{"b", "c", "d"})

s3 := hashset.New([]string{"a"})

_ = s1.Diff(s2)      // {a}

_ = s1.SymDiff(s2)   // {a,d}

_ = s1.Intersect(s2) // {b,c}

_ = s1.Union(s2)     // {a,b,c,d}

_ = s2.Disjoint(s3)  // true

_ = s3.Subset(s1)    // true

_ = s1.Subset(s3)    // false

_ = s1.Superset(s3)  // true

```

## Acknowledgements

The API for this package was inspired by Rust's [HashSet](https://doc.rust-lang.org/std/collections/hash_set/struct.HashSet.html) implementation. Many of the examples are copies of their examples as they are simple to understand.