sets

type OrderedSet[T cmp.Ordered] struct {
	// contains filtered or unexported fields
}

type Set[T any] interface {
	// Size returns the number of elements in the set.
	//
	// Returns:
	//   - int: The number of elements in the set. Never negative.
	Size() int

	// IsEmpty checks whether the set is empty.
	//
	// Returns:
	//   - bool: True if the set is empty, false otherwise.
	IsEmpty() bool

	// Reset resets the set for reuse.
	Reset()

	// Add inserts an element into the set if it is not already present.
	//
	// Parameters:
	//   - elem: The element to add to the set.
	//
	// Returns:
	//   - error: Returns an error if the receiver is nil.
	Add(elem T) error

	// AddMany adds multiple elements to the set. It must be equal to calling Add
	// multiple times but can be more efficient than adding each element individually.
	//
	// Parameters:
	//   - elems: The elements to add to the set.
	//
	// Returns:
	//   - error: Returns an error if the receiver is nil.
	AddMany(elems []T) error

	// Contains checks whether the specified element is present in the set.
	//
	// Parameters:
	//   - elem: The element to check for presence in the set.
	//
	// Returns:
	//   - bool: True if the element is present in the set, false otherwise.
	Contains(elem T) bool

	// Elem iterates through the elements in the set. The order of elements
	// is not guaranteed to be the same as the order in which they were added.
	//
	// Returns:
	//   - iter.Seq[T]: The elements in the set. Never returns nil.
	Elem() iter.Seq[T]
}