sets

package
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 19, 2024 License: Apache-2.0 Imports: 2 Imported by: 20,179

Documentation

Overview

Package sets has generic set and specified sets. Generic set will replace specified ones over time. And specific ones are deprecated.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func List added in v0.26.0 

func List[T cmp.Ordered](s Set[T]) []T

List returns the contents as a sorted T slice.

This is a separate function and not a method because not all types supported by Generic are ordered and only those can be sorted.

Types

type Byte deprecated 

type Byte map[byte]Empty

Byte is a set of bytes, implemented via map[byte]struct{} for minimal memory consumption.

Deprecated: use generic Set instead. new ways: s1 := Set[byte]{} s2 := New[byte]()

func ByteKeySet 

func ByteKeySet[T any](theMap map[byte]T) Byte

ByteKeySet creates a Byte from a keys of a map[byte](? extends interface{}). If the value passed in is not actually a map, this will panic.

func NewByte 

func NewByte(items ...byte) Byte

NewByte creates a Byte from a list of values.

func (Byte) Clone added in v0.25.0 

func (s Byte) Clone() Byte

Clone returns a new set which is a copy of the current set.

func (Byte) Delete 

func (s Byte) Delete(items ...byte) Byte

Delete removes all items from the set.

func (Byte) Difference 

func (s1 Byte) Difference(s2 Byte) Byte

Difference returns a set of objects that are not in s2. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.Difference(s2) = {a3} s2.Difference(s1) = {a4, a5}

func (Byte) Equal 

func (s1 Byte) Equal(s2 Byte) bool

Equal returns true if and only if s1 is equal (as a set) to s2. Two sets are equal if their membership is identical. (In practice, this means same elements, order doesn't matter)

func (Byte) Has 

func (s Byte) Has(item byte) bool

Has returns true if and only if item is contained in the set.

func (Byte) HasAll 

func (s Byte) HasAll(items ...byte) bool

HasAll returns true if and only if all items are contained in the set.

func (Byte) HasAny 

func (s Byte) HasAny(items ...byte) bool

HasAny returns true if any items are contained in the set.

func (Byte) Insert 

func (s Byte) Insert(items ...byte) Byte

Insert adds items to the set.

func (Byte) Intersection 

func (s1 Byte) Intersection(s2 Byte) Byte

Intersection returns a new set which includes the item in BOTH s1 and s2 For example: s1 = {a1, a2} s2 = {a2, a3} s1.Intersection(s2) = {a2}

func (Byte) IsSuperset 

func (s1 Byte) IsSuperset(s2 Byte) bool

IsSuperset returns true if and only if s1 is a superset of s2.

func (Byte) Len 

func (s Byte) Len() int

Len returns the size of the set.

func (Byte) List 

func (s Byte) List() []byte

List returns the contents as a sorted byte slice.

func (Byte) PopAny 

func (s Byte) PopAny() (byte, bool)

PopAny returns a single element from the set.

func (Byte) SymmetricDifference added in v0.26.0 

func (s1 Byte) SymmetricDifference(s2 Byte) Byte

SymmetricDifference returns a set of elements which are in either of the sets, but not in their intersection. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.SymmetricDifference(s2) = {a3, a4, a5} s2.SymmetricDifference(s1) = {a3, a4, a5}

func (Byte) Union 

func (s1 Byte) Union(s2 Byte) Byte

Union returns a new set which includes items in either s1 or s2. For example: s1 = {a1, a2} s2 = {a3, a4} s1.Union(s2) = {a1, a2, a3, a4} s2.Union(s1) = {a1, a2, a3, a4}

func (Byte) UnsortedList 

func (s Byte) UnsortedList() []byte

UnsortedList returns the slice with contents in random order.

type Empty 

type Empty struct{}

Empty is public since it is used by some internal API objects for conversions between external string arrays and internal sets, and conversion logic requires public types today.

type Int deprecated 

type Int map[int]Empty

Int is a set of ints, implemented via map[int]struct{} for minimal memory consumption.

Deprecated: use generic Set instead. new ways: s1 := Set[int]{} s2 := New[int]()

func IntKeySet 

func IntKeySet[T any](theMap map[int]T) Int

IntKeySet creates a Int from a keys of a map[int](? extends interface{}). If the value passed in is not actually a map, this will panic.

func NewInt 

func NewInt(items ...int) Int

NewInt creates a Int from a list of values.

func (Int) Clone added in v0.25.0 

func (s Int) Clone() Int

Clone returns a new set which is a copy of the current set.

func (Int) Delete 

func (s Int) Delete(items ...int) Int

Delete removes all items from the set.

func (Int) Difference 

func (s1 Int) Difference(s2 Int) Int

Difference returns a set of objects that are not in s2. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.Difference(s2) = {a3} s2.Difference(s1) = {a4, a5}

func (Int) Equal 

func (s1 Int) Equal(s2 Int) bool

Equal returns true if and only if s1 is equal (as a set) to s2. Two sets are equal if their membership is identical. (In practice, this means same elements, order doesn't matter)

func (Int) Has 

func (s Int) Has(item int) bool

Has returns true if and only if item is contained in the set.

func (Int) HasAll 

func (s Int) HasAll(items ...int) bool

HasAll returns true if and only if all items are contained in the set.

func (Int) HasAny 

func (s Int) HasAny(items ...int) bool

HasAny returns true if any items are contained in the set.

func (Int) Insert 

func (s Int) Insert(items ...int) Int

Insert adds items to the set.

func (Int) Intersection 

func (s1 Int) Intersection(s2 Int) Int

Intersection returns a new set which includes the item in BOTH s1 and s2 For example: s1 = {a1, a2} s2 = {a2, a3} s1.Intersection(s2) = {a2}

func (Int) IsSuperset 

func (s1 Int) IsSuperset(s2 Int) bool

IsSuperset returns true if and only if s1 is a superset of s2.

func (Int) Len 

func (s Int) Len() int

Len returns the size of the set.

func (Int) List 

func (s Int) List() []int

List returns the contents as a sorted int slice.

func (Int) PopAny 

func (s Int) PopAny() (int, bool)

PopAny returns a single element from the set.

func (Int) SymmetricDifference added in v0.26.0 

func (s1 Int) SymmetricDifference(s2 Int) Int

SymmetricDifference returns a set of elements which are in either of the sets, but not in their intersection. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.SymmetricDifference(s2) = {a3, a4, a5} s2.SymmetricDifference(s1) = {a3, a4, a5}

func (Int) Union 

func (s1 Int) Union(s2 Int) Int

Union returns a new set which includes items in either s1 or s2. For example: s1 = {a1, a2} s2 = {a3, a4} s1.Union(s2) = {a1, a2, a3, a4} s2.Union(s1) = {a1, a2, a3, a4}

func (Int) UnsortedList 

func (s Int) UnsortedList() []int

UnsortedList returns the slice with contents in random order.

type Int32 deprecated 

type Int32 map[int32]Empty

Int32 is a set of int32s, implemented via map[int32]struct{} for minimal memory consumption.

Deprecated: use generic Set instead. new ways: s1 := Set[int32]{} s2 := New[int32]()

func Int32KeySet 

func Int32KeySet[T any](theMap map[int32]T) Int32

Int32KeySet creates a Int32 from a keys of a map[int32](? extends interface{}). If the value passed in is not actually a map, this will panic.

func NewInt32 

func NewInt32(items ...int32) Int32

NewInt32 creates a Int32 from a list of values.

func (Int32) Clone added in v0.25.0 

func (s Int32) Clone() Int32

Clone returns a new set which is a copy of the current set.

func (Int32) Delete 

func (s Int32) Delete(items ...int32) Int32

Delete removes all items from the set.

func (Int32) Difference 

func (s1 Int32) Difference(s2 Int32) Int32

Difference returns a set of objects that are not in s2. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.Difference(s2) = {a3} s2.Difference(s1) = {a4, a5}

func (Int32) Equal 

func (s1 Int32) Equal(s2 Int32) bool

Equal returns true if and only if s1 is equal (as a set) to s2. Two sets are equal if their membership is identical. (In practice, this means same elements, order doesn't matter)

func (Int32) Has 

func (s Int32) Has(item int32) bool

Has returns true if and only if item is contained in the set.

func (Int32) HasAll 

func (s Int32) HasAll(items ...int32) bool

HasAll returns true if and only if all items are contained in the set.

func (Int32) HasAny 

func (s Int32) HasAny(items ...int32) bool

HasAny returns true if any items are contained in the set.

func (Int32) Insert 

func (s Int32) Insert(items ...int32) Int32

Insert adds items to the set.

func (Int32) Intersection 

func (s1 Int32) Intersection(s2 Int32) Int32

Intersection returns a new set which includes the item in BOTH s1 and s2 For example: s1 = {a1, a2} s2 = {a2, a3} s1.Intersection(s2) = {a2}

func (Int32) IsSuperset 

func (s1 Int32) IsSuperset(s2 Int32) bool

IsSuperset returns true if and only if s1 is a superset of s2.

func (Int32) Len 

func (s Int32) Len() int

Len returns the size of the set.

func (Int32) List 

func (s Int32) List() []int32

List returns the contents as a sorted int32 slice.

func (Int32) PopAny 

func (s Int32) PopAny() (int32, bool)

PopAny returns a single element from the set.

func (Int32) SymmetricDifference added in v0.26.0 

func (s1 Int32) SymmetricDifference(s2 Int32) Int32

SymmetricDifference returns a set of elements which are in either of the sets, but not in their intersection. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.SymmetricDifference(s2) = {a3, a4, a5} s2.SymmetricDifference(s1) = {a3, a4, a5}

func (Int32) Union 

func (s1 Int32) Union(s2 Int32) Int32

Union returns a new set which includes items in either s1 or s2. For example: s1 = {a1, a2} s2 = {a3, a4} s1.Union(s2) = {a1, a2, a3, a4} s2.Union(s1) = {a1, a2, a3, a4}

func (Int32) UnsortedList 

func (s Int32) UnsortedList() []int32

UnsortedList returns the slice with contents in random order.

type Int64 deprecated 

type Int64 map[int64]Empty

Int64 is a set of int64s, implemented via map[int64]struct{} for minimal memory consumption.

Deprecated: use generic Set instead. new ways: s1 := Set[int64]{} s2 := New[int64]()

func Int64KeySet 

func Int64KeySet[T any](theMap map[int64]T) Int64

Int64KeySet creates a Int64 from a keys of a map[int64](? extends interface{}). If the value passed in is not actually a map, this will panic.

func NewInt64 

func NewInt64(items ...int64) Int64

NewInt64 creates a Int64 from a list of values.

func (Int64) Clone added in v0.25.0 

func (s Int64) Clone() Int64

Clone returns a new set which is a copy of the current set.

func (Int64) Delete 

func (s Int64) Delete(items ...int64) Int64

Delete removes all items from the set.

func (Int64) Difference 

func (s1 Int64) Difference(s2 Int64) Int64

Difference returns a set of objects that are not in s2. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.Difference(s2) = {a3} s2.Difference(s1) = {a4, a5}

func (Int64) Equal 

func (s1 Int64) Equal(s2 Int64) bool

Equal returns true if and only if s1 is equal (as a set) to s2. Two sets are equal if their membership is identical. (In practice, this means same elements, order doesn't matter)

func (Int64) Has 

func (s Int64) Has(item int64) bool

Has returns true if and only if item is contained in the set.

func (Int64) HasAll 

func (s Int64) HasAll(items ...int64) bool

HasAll returns true if and only if all items are contained in the set.

func (Int64) HasAny 

func (s Int64) HasAny(items ...int64) bool

HasAny returns true if any items are contained in the set.

func (Int64) Insert 

func (s Int64) Insert(items ...int64) Int64

Insert adds items to the set.

func (Int64) Intersection 

func (s1 Int64) Intersection(s2 Int64) Int64

Intersection returns a new set which includes the item in BOTH s1 and s2 For example: s1 = {a1, a2} s2 = {a2, a3} s1.Intersection(s2) = {a2}

func (Int64) IsSuperset 

func (s1 Int64) IsSuperset(s2 Int64) bool

IsSuperset returns true if and only if s1 is a superset of s2.

func (Int64) Len 

func (s Int64) Len() int

Len returns the size of the set.

func (Int64) List 

func (s Int64) List() []int64

List returns the contents as a sorted int64 slice.

func (Int64) PopAny 

func (s Int64) PopAny() (int64, bool)

PopAny returns a single element from the set.

func (Int64) SymmetricDifference added in v0.26.0 

func (s1 Int64) SymmetricDifference(s2 Int64) Int64

SymmetricDifference returns a set of elements which are in either of the sets, but not in their intersection. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.SymmetricDifference(s2) = {a3, a4, a5} s2.SymmetricDifference(s1) = {a3, a4, a5}

func (Int64) Union 

func (s1 Int64) Union(s2 Int64) Int64

Union returns a new set which includes items in either s1 or s2. For example: s1 = {a1, a2} s2 = {a3, a4} s1.Union(s2) = {a1, a2, a3, a4} s2.Union(s1) = {a1, a2, a3, a4}

func (Int64) UnsortedList 

func (s Int64) UnsortedList() []int64

UnsortedList returns the slice with contents in random order.

type Set added in v0.26.0 

type Set[T comparable] map[T]Empty

Set is a set of the same type elements, implemented via map[comparable]struct{} for minimal memory consumption.

func Insert added in v0.26.0 

func Insert[T comparable](set Set[T], items ...T) Set[T]

func KeySet added in v0.26.0 

func KeySet[T comparable, V any](theMap map[T]V) Set[T]

KeySet creates a Set from a keys of a map[comparable](? extends interface{}). If the value passed in is not actually a map, this will panic.

func New added in v0.26.0 

func New[T comparable](items ...T) Set[T]

New creates a Set from a list of values. NOTE: type param must be explicitly instantiated if given items are empty.

func (Set[T]) Clear added in v0.27.0 

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

Clear empties the set. It is preferable to replace the set with a newly constructed set, but not all callers can do that (when there are other references to the map).

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

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

Clone returns a new set which is a copy of the current set.

func (Set[T]) Delete added in v0.26.0 

func (s Set[T]) Delete(items ...T) Set[T]

Delete removes all items from the set.

func (Set[T]) Difference added in v0.26.0 

func (s1 Set[T]) Difference(s2 Set[T]) Set[T]

Difference returns a set of objects that are not in s2. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.Difference(s2) = {a3} s2.Difference(s1) = {a4, a5}

func (Set[T]) Equal added in v0.26.0 

func (s1 Set[T]) Equal(s2 Set[T]) bool

Equal returns true if and only if s1 is equal (as a set) to s2. Two sets are equal if their membership is identical. (In practice, this means same elements, order doesn't matter)

func (Set[T]) Has added in v0.26.0 

func (s Set[T]) Has(item T) bool

Has returns true if and only if item is contained in the set.

func (Set[T]) HasAll added in v0.26.0 

func (s Set[T]) HasAll(items ...T) bool

HasAll returns true if and only if all items are contained in the set.

func (Set[T]) HasAny added in v0.26.0 

func (s Set[T]) HasAny(items ...T) bool

HasAny returns true if any items are contained in the set.

func (Set[T]) Insert added in v0.26.0 

func (s Set[T]) Insert(items ...T) Set[T]

Insert adds items to the set.

func (Set[T]) Intersection added in v0.26.0 

func (s1 Set[T]) Intersection(s2 Set[T]) Set[T]

Intersection returns a new set which includes the item in BOTH s1 and s2 For example: s1 = {a1, a2} s2 = {a2, a3} s1.Intersection(s2) = {a2}

func (Set[T]) IsSuperset added in v0.26.0 

func (s1 Set[T]) IsSuperset(s2 Set[T]) bool

IsSuperset returns true if and only if s1 is a superset of s2.

func (Set[T]) Len added in v0.26.0 

func (s Set[T]) Len() int

Len returns the size of the set.

func (Set[T]) PopAny added in v0.26.0 

func (s Set[T]) PopAny() (T, bool)

PopAny returns a single element from the set.

func (Set[T]) SymmetricDifference added in v0.26.0 

func (s1 Set[T]) SymmetricDifference(s2 Set[T]) Set[T]

SymmetricDifference returns a set of elements which are in either of the sets, but not in their intersection. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.SymmetricDifference(s2) = {a3, a4, a5} s2.SymmetricDifference(s1) = {a3, a4, a5}

func (Set[T]) Union added in v0.26.0 

func (s1 Set[T]) Union(s2 Set[T]) Set[T]

Union returns a new set which includes items in either s1 or s2. For example: s1 = {a1, a2} s2 = {a3, a4} s1.Union(s2) = {a1, a2, a3, a4} s2.Union(s1) = {a1, a2, a3, a4}

func (Set[T]) UnsortedList added in v0.26.0 

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

UnsortedList returns the slice with contents in random order.

type String deprecated 

type String map[string]Empty

String is a set of strings, implemented via map[string]struct{} for minimal memory consumption.

Deprecated: use generic Set instead. new ways: s1 := Set[string]{} s2 := New[string]()

func NewString 

func NewString(items ...string) String

NewString creates a String from a list of values.

func StringKeySet 

func StringKeySet[T any](theMap map[string]T) String

StringKeySet creates a String from a keys of a map[string](? extends interface{}). If the value passed in is not actually a map, this will panic.

func (String) Clone added in v0.25.0 

func (s String) Clone() String

Clone returns a new set which is a copy of the current set.

func (String) Delete 

func (s String) Delete(items ...string) String

Delete removes all items from the set.

func (String) Difference 

func (s1 String) Difference(s2 String) String

Difference returns a set of objects that are not in s2. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.Difference(s2) = {a3} s2.Difference(s1) = {a4, a5}

func (String) Equal 

func (s1 String) Equal(s2 String) bool

Equal returns true if and only if s1 is equal (as a set) to s2. Two sets are equal if their membership is identical. (In practice, this means same elements, order doesn't matter)

func (String) Has 

func (s String) Has(item string) bool

Has returns true if and only if item is contained in the set.

func (String) HasAll 

func (s String) HasAll(items ...string) bool

HasAll returns true if and only if all items are contained in the set.

func (String) HasAny 

func (s String) HasAny(items ...string) bool

HasAny returns true if any items are contained in the set.

func (String) Insert 

func (s String) Insert(items ...string) String

Insert adds items to the set.

func (String) Intersection 

func (s1 String) Intersection(s2 String) String

Intersection returns a new set which includes the item in BOTH s1 and s2 For example: s1 = {a1, a2} s2 = {a2, a3} s1.Intersection(s2) = {a2}

func (String) IsSuperset 

func (s1 String) IsSuperset(s2 String) bool

IsSuperset returns true if and only if s1 is a superset of s2.

func (String) Len 

func (s String) Len() int

Len returns the size of the set.

func (String) List 

func (s String) List() []string

List returns the contents as a sorted string slice.

func (String) PopAny 

func (s String) PopAny() (string, bool)

PopAny returns a single element from the set.

func (String) SymmetricDifference added in v0.26.0 

func (s1 String) SymmetricDifference(s2 String) String

SymmetricDifference returns a set of elements which are in either of the sets, but not in their intersection. For example: s1 = {a1, a2, a3} s2 = {a1, a2, a4, a5} s1.SymmetricDifference(s2) = {a3, a4, a5} s2.SymmetricDifference(s1) = {a3, a4, a5}

func (String) Union 

func (s1 String) Union(s2 String) String

Union returns a new set which includes items in either s1 or s2. For example: s1 = {a1, a2} s2 = {a3, a4} s1.Union(s2) = {a1, a2, a3, a4} s2.Union(s1) = {a1, a2, a3, a4}

func (String) UnsortedList 

func (s String) UnsortedList() []string

UnsortedList returns the slice with contents in random order.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.