github.com/m4gshm/gollections@v0.0.13-0.20240331203319-a34a86e58a24/collection/mutable/set.go

package mutable

import (
	"fmt"

	breakLoop "github.com/m4gshm/gollections/break/loop"
	"github.com/m4gshm/gollections/c"
	"github.com/m4gshm/gollections/collection"
	"github.com/m4gshm/gollections/collection/mutable/ordered"
	"github.com/m4gshm/gollections/loop"
	"github.com/m4gshm/gollections/map_"
	"github.com/m4gshm/gollections/slice"
)

// WrapSet creates a set using a map as the internal storage.
func WrapSet[T comparable](elements map[T]struct{}) *Set[T] {
	return &Set[T]{elements: elements}
}

// Set is a collection implementation that provides element uniqueness. The elements must be comparable.
type Set[T comparable] struct {
	elements map[T]struct{}
}

var (
	_ c.Addable[int]                  = (*Set[int])(nil)
	_ c.AddableNew[int]               = (*Set[int])(nil)
	_ c.AddableAll[c.ForEach[int]]    = (*Set[int])(nil)
	_ c.AddableAllNew[c.ForEach[int]] = (*Set[int])(nil)
	_ c.Deleteable[int]               = (*Set[int])(nil)
	_ c.DeleteableVerify[int]         = (*Set[int])(nil)
	_ collection.Set[int]             = (*Set[int])(nil)
	_ fmt.Stringer                    = (*Set[int])(nil)
)

// All is used to iterate through the collection using `for ... range`. Supported since go 1.22 with GOEXPERIMENT=rangefunc enabled.
func (s *Set[T]) All(consumer func(T) bool) {
	for v := range s.elements {
		if !consumer(v) {
			return
		}
	}
}

// Loop creates a loop to iterate through the collection.
func (s *Set[T]) Loop() loop.Loop[T] {
	h := s.Head()
	return (&h).Next
}

// IterEdit creates iterator that can delete iterable elements
func (s *Set[T]) IterEdit() c.DelIterator[T] {
	h := s.Head()
	return &h
}

// Deprecated: Head is deprecated. Will be replaced by rance-over function iterator.
// Head creates an iterator to iterate through the collection.
func (s *Set[T]) Head() SetIter[T] {
	var elements map[T]struct{}
	if s != nil {
		elements = s.elements
	}
	return NewSetIter(elements, s.DeleteOne)
}

// Deprecated: First is deprecated. Will be replaced by rance-over function iterator.
// First returns the first element of the collection, an iterator to iterate over the remaining elements, and true\false marker of availability next elements.
// If no more elements then ok==false.
func (s *Set[T]) First() (SetIter[T], T, bool) {
	var (
		iterator  = s.Head()
		first, ok = iterator.Next()
	)
	return iterator, first, ok
}

// Slice collects the elements to a slice
func (s *Set[T]) Slice() (out []T) {
	if s != nil {
		if elements := s.elements; elements != nil {
			out = map_.Keys(elements)
		}
	}
	return out
}

// Append collects the values to the specified 'out' slice
func (s *Set[T]) Append(out []T) []T {
	if s != nil {
		if elements := s.elements; elements != nil {
			out = map_.AppendKeys(s.elements, out)
		}
	}
	return out
}

// Clone returns copy of the collection
func (s *Set[T]) Clone() *Set[T] {
	var elements map[T]struct{}
	if s != nil {
		elements = map_.Clone(s.elements)
	}
	return WrapSet(elements)
}

// IsEmpty returns true if the collection is empty
func (s *Set[T]) IsEmpty() bool {
	return s.Len() == 0
}

// Len returns amount of the elements
func (s *Set[T]) Len() int {
	if s == nil {
		return 0
	}
	return len(s.elements)
}

// Contains checks if the collection contains an element
func (s *Set[T]) Contains(element T) (ok bool) {
	if s != nil {
		_, ok = s.elements[element]
	}
	return ok
}

// Add adds elements in the collection
func (s *Set[T]) Add(elements ...T) {
	if s != nil {
		for _, element := range elements {
			s.AddOne(element)
		}
	}
}

// AddOne adds an element in the collection
func (s *Set[T]) AddOne(element T) {
	if s == nil {
		return
	} else if elements := s.elements; elements == nil {
		s.elements = map[T]struct{}{element: {}}
	} else {
		elements[element] = struct{}{}
	}
}

// AddNew inserts elements if they are not contained in the collection
func (s *Set[T]) AddNew(elements ...T) bool {
	if s == nil {
		return false
	}
	ok := false
	for _, element := range elements {
		ok = s.AddOneNew(element) || ok
	}
	return ok
}

// AddOneNew inserts an element if it is not contained in the collection
func (s *Set[T]) AddOneNew(element T) (ok bool) {
	if s != nil {
		elements := s.elements
		if elements == nil {
			elements = map[T]struct{}{}
			s.elements = elements
		}
		if ok = !s.Contains(element); ok {
			elements[element] = struct{}{}
		}
	}
	return ok
}

// AddAll inserts all elements from the "other" collection
func (s *Set[T]) AddAll(elements c.ForEach[T]) {
	if !(s == nil || elements == nil) {
		elements.ForEach(s.AddOne)
	}
}

// AddAllNew inserts elements from the "other" collection if they are not contained in the collection
func (s *Set[T]) AddAllNew(other c.ForEach[T]) (ok bool) {
	if !(s == nil || other == nil) {
		other.ForEach(func(element T) { ok = s.AddOneNew(element) || ok })
	}
	return ok
}

// Delete removes elements from the collection
func (s *Set[T]) Delete(elements ...T) {
	if s != nil {
		for _, element := range elements {
			s.DeleteOne(element)
		}
	}
}

// DeleteOne removes an element from the collection
func (s *Set[T]) DeleteOne(element T) {
	if s != nil {
		delete(s.elements, element)
	}
}

// DeleteActual removes elements only if they are contained in the collection
func (s *Set[T]) DeleteActual(elements ...T) bool {
	if s == nil {
		return false
	}
	ok := false
	for i := range elements {
		ok = s.DeleteActualOne(elements[i]) || ok
	}
	return ok
}

// DeleteActualOne removes an element only if it is contained in the collection
func (s *Set[T]) DeleteActualOne(element T) (ok bool) {
	if !(s == nil || s.elements == nil) {
		if _, ok = s.elements[element]; ok {
			delete(s.elements, element)
		}
	}
	return ok
}

// For applies the 'consumer' function for the elements until the consumer returns the c.Break to stop.
func (s *Set[T]) For(consumer func(T) error) error {
	if s == nil {
		return nil
	}
	return map_.ForKeys(s.elements, consumer)
}

// ForEach applies the 'consumer' function for every element
func (s *Set[T]) ForEach(consumer func(T)) {
	if s != nil {
		map_.ForEachKey(s.elements, consumer)
	}
}

// Filter returns a loop consisting of elements that satisfy the condition of the 'predicate' function
func (s *Set[T]) Filter(predicate func(T) bool) loop.Loop[T] {
	return loop.Filter(s.Loop(), predicate)
}

// Filt returns a breakable loop consisting of elements that satisfy the condition of the 'predicate' function
func (s Set[T]) Filt(predicate func(T) (bool, error)) breakLoop.Loop[T] {
	return loop.Filt(s.Loop(), predicate)
}

// Convert returns a loop that applies the 'converter' function to the collection elements
func (s *Set[T]) Convert(converter func(T) T) loop.Loop[T] {
	return loop.Convert(s.Loop(), converter)
}

// Conv returns a breakable loop that applies the 'converter' function to the collection elements
func (s *Set[T]) Conv(converter func(T) (T, error)) breakLoop.Loop[T] {
	return loop.Conv(s.Loop(), converter)
}

// Reduce reduces the elements into an one using the 'merge' function
func (s *Set[T]) Reduce(merge func(T, T) T) (t T) {
	if s != nil {
		t, _ = map_.Reduce(s.elements, func(t1, t2 T, _, _ struct{}) (t T, out struct{}) {
			return merge(t1, t2), out
		})
	}
	return t
}

// HasAny finds the first element that satisfies the 'predicate' function condition and returns true if successful
func (s *Set[K]) HasAny(predicate func(K) bool) bool {
	if s != nil {
		return map_.HasAny(s.elements, func(k K, _ struct{}) bool {
			return predicate(k)
		})
	}
	return false
}

// Sort transforms to the ordered Set contains sorted elements
func (s *Set[T]) Sort(comparer slice.Comparer[T]) *ordered.Set[T] {
	if s != nil {
		return ordered.NewSet(slice.Sort(s.Slice(), comparer)...)
	}
	return nil
}

// StableSort transforms to the ordered Set contains sorted elements
func (s *Set[T]) StableSort(comparer slice.Comparer[T]) *ordered.Set[T] {
	if s != nil {
		return ordered.NewSet(slice.StableSort(s.Slice(), comparer)...)
	}
	return nil
}

func (s *Set[T]) String() string {
	return slice.ToString(s.Slice())
}