How do I convert a slice to a set using golang-set?

Use the NewSetFromSlice constructor or iterate through the slice with Add. The library provides convenient methods for converting from slices or maps, as shown in the documentation.

Is golang-set threadsafe out of the box?

No, you must explicitly choose the threadsafe implementation (e.g., NewThreadSafeSet) for concurrent access. The non-threadsafe version is default for performance, so concurrency handling is up to the developer.

golang-set vs using a map for unique collections – which is better?

golang-set is better for complex set operations like union or intersection, as it provides built-in methods. For simple uniqueness, a map might be faster and lighter, but lacks dedicated set functionality.

How to perform set difference with golang-set?

Call the Difference method on a set, passing another set as an argument. It returns a new set with elements in the first but not the second, similar to Python's set difference.

What types can I use with golang-set generics?

Any comparable type in Go, including primitives, pointers, arrays, and structs with all comparable fields. The library leverages Go's type constraints to ensure safety, as explained in the usage section.

Does golang-set support iteration in older Go versions?

Yes, but with limitations. For Go 1.23+, it has true iterators; for older versions, use methods like Range or convert to a slice, as noted in the update about iteration behavior changes.

Open-Awesome

golang-set

NOASSERTIONGov2.9.0

A generic, battle-tested set collection for Go, providing Python-like set operations for comparable types.

GitHub

4.7k stars291 forks0 contributors

What is golang-set?

golang-set is a Go library that provides a generic set data structure, allowing developers to manage collections of unique items with operations like union, intersection, and difference. It solves the lack of a built-in set type in Go's standard library, offering both threadsafe and non-threadsafe implementations for various use cases.

Target Audience

Go developers who need to work with collections of unique items, especially those coming from languages like Python that have built-in set types, or those building applications requiring efficient set operations.

Value Proposition

Developers choose golang-set for its battle-tested reliability, generic type support, and comprehensive feature set that mimics Python's set operations, all while providing both performance-optimized and concurrent-safe implementations.

Overview

A simple, battle-tested and generic set type for the Go language. Trusted by GoogleCloudPlatform, Docker, 1Password, Ethereum and Hashicorp.

Use Cases

Best For

Managing unique collections of comparable types in Go
Performing set operations like union, intersection, and difference
Deduplicating slices or arrays efficiently
Building concurrent applications that require threadsafe collections
Replacing manual loops with declarative set operations
Working with JSON-serializable collections of unique items

Not Ideal For

Projects stuck on Go versions below 1.18, as generics are required
Applications where minimal dependencies are critical and a simple map or slice suffices
Use cases requiring ordered collections or list-like indexing, since sets are unordered

Pros & Cons

Pros

Generic Type Safety

Supports any comparable type using Go 1.18+ generics, ensuring compile-time checks and reducing boilerplate for custom types, as highlighted in the usage examples.

Dual Implementation Flexibility

Offers both non-threadsafe (for performance) and threadsafe (for concurrency) versions, allowing developers to optimize based on specific needs without switching libraries.

Comprehensive Set Operations

Includes Python-like union, intersection, and difference operations, minimizing manual loops and code duplication, as demonstrated in the comprehensive example.

JSON Serialization Built-in

Provides full marshaling and unmarshaling capabilities, making it easy to persist or transmit set data, though past bugs required fixes as noted in updates.

Cons

Go Version Dependency

Requires Go 1.18 or higher, excluding legacy projects and adding migration overhead, which is a barrier for teams on older codebases.

Occasional Stability Issues

The README admits bugs like JSON unmarshaling problems in past releases, indicating that updates can introduce regressions that need fixes.

Overhead for Simple Use

For basic deduplication or membership checks, using native maps or slices might be more lightweight and less complex, making golang-set overkill in trivial scenarios.

Frequently Asked Questions

Related Projects

goset

Set is a useful collection but there is no built-in implementation in Go lang.

Stars53

Forks16

Last commit5 years ago

set

A simple Set data structure implementation in Go (Golang) using LinkedHashMap.

Stars30

Forks12

Last commit9 months ago

dsu

Disjoint Set data structure implementation in Go

Stars18

Forks1

Last commit4 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub