set

package module

v0.5.1 Latest Latest Go to latest Published: Apr 1, 2025 License: MIT Imports: 3 Imported by: 7

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/clambin/go-common

Links

Open Source Insights

README ¶

set

Basic set implemented with generics.

Authors

Christophe Lambin

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Documentation ¶

Overview ¶

Package set implements a set & related functions.

Deprecated: moved to codeberg.org/clambin/go-common

Index ¶

type Set

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Set ¶

type Set[T cmp.Ordered] map[T]struct{}

Set holds a set of unique values

func Difference ¶ added in v0.2.0

func Difference[T cmp.Ordered](setA, setB Set[T]) Set[T]

Difference returns a new set containing the values from setA that don't exist in setB

func Intersection ¶ added in v0.2.0

func Intersection[T cmp.Ordered](setA, setB Set[T]) Set[T]

Intersection returns a new set containing the common values between setA and setB

func New ¶ added in v0.3.0

func New[T cmp.Ordered](values ...T) Set[T]

New creates a new set containing the optional values

func Union ¶ added in v0.2.0

func Union[T cmp.Ordered](setA, setB Set[T]) Set[T]

Union returns a new set containing all values from setA and setB

func (Set[T]) Add ¶

func (s Set[T]) Add(value ...T)

Add adds value to the set

func (Set[T]) Clone ¶ added in v0.4.3

func (s Set[T]) Clone() Set[T]

Clone returns a copy of the set

func (Set[T]) Contains ¶ added in v0.2.0

func (s Set[T]) Contains(value T) bool

Contains returns true if the set contains value

func (Set[T]) Equals ¶ added in v0.2.0

func (s Set[T]) Equals(other Set[T]) bool

Equals returns true if both sets contain the same values

func (Set[T]) List ¶ added in v0.2.0

func (s Set[T]) List() []T

List returns all values present in the set. Order is not guaranteed. If ListOrdered() if required.

func (Set[T]) ListOrdered ¶ added in v0.3.0

func (s Set[T]) ListOrdered() []T

ListOrdered returns all values present in the set, in order

func (Set[T]) Remove ¶ added in v0.2.0

func (s Set[T]) Remove(value ...T)

Remove deletes value from the set, if present

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL