lists.go

package stick

// Unique will return a new list with unique strings.
func Unique[T comparable](list []T) []T {
	// check nil
	if list == nil {
		return nil
	}

	// prepare table and result
	table := make(map[T]bool)
	res := make([]T, 0, len(list))

	// add items not in table
	for _, item := range list {
		if _, ok := table[item]; !ok {
			table[item] = true
			res = append(res, item)
		}
	}

	return res
}

// Contains return whether the list contains the item.
func Contains[T comparable](list []T, str T) bool {
	for _, item := range list {
		if item == str {
			return true
		}
	}

	return false
}

// Includes returns whether a list includes another list.
func Includes[T comparable](all, subset []T) bool {
	for _, item := range subset {
		if !Contains(all, item) {
			return false
		}
	}

	return true
}

// Union will merge all list and remove duplicates.
func Union[T comparable](lists ...[]T) []T {
	// check lists
	if len(lists) == 0 {
		return nil
	}

	// sum length and check nil
	var sum int
	var nonNil bool
	for _, l := range lists {
		sum += len(l)
		if l != nil {
			nonNil = true
		}
	}
	if !nonNil {
		return nil
	}

	// prepare table and result
	table := make(map[T]bool, sum)
	res := make([]T, 0, sum)

	// add items not present in table
	for _, list := range lists {
		for _, item := range list {
			if _, ok := table[item]; !ok {
				table[item] = true
				res = append(res, item)
			}
		}
	}

	return res
}

// Subtract will return a list with items that are only part of the first list.
func Subtract[T comparable](listA, listB []T) []T {
	// check nil
	if listA == nil {
		return nil
	}

	// prepare new list
	list := make([]T, 0, len(listA))

	// add items that are not in second list
	for _, item := range listA {
		if !Contains(listB, item) {
			list = append(list, item)
		}
	}

	return list
}

// Intersect will return a list with items that are part of both lists.
func Intersect[T comparable](listA, listB []T) []T {
	// check nil
	if listA == nil || listB == nil {
		return nil
	}

	// prepare new list
	list := make([]T, 0, len(listA))

	// add items that are part of both lists
	for _, item := range listA {
		if Contains(listB, item) {
			list = append(list, item)
		}
	}

	return list
}