collection

README

集合（Collection）数据结构的接口定义

此仓库只做Collection的接口定义，不做具体实现。

Documentation

Index

• type Collection

Types

type Collection

type Collection[T any] interface {

	// Equalsable 能够比较两个集合是否相等
	compare_anything.Equalsable[Collection[T]]

	// Iterable 集合都是可迭代的，可以返回一个迭代器来遍历集合
	iterator.Iterable[T]

	// Marshaler 集合是可以被JSON序列化和反序列化的
	json.Marshaler
	json.Unmarshaler

	// Add 往集合中增加一个元素
	Add(value T)

	// AddAll 往集合中一次增加多个元素
	AddAll(values []T)

	// Clear 清空集合
	Clear()

	// Contains 判断集合是否包含给定的元素
	Contains(value T) bool

	// ContainsAll 判断集合是否包含全部给定的元素
	ContainsAll(values []T) bool
	ContainsAllByKeyFunc(values []T, keyFunc func(value T) string) bool

	// ContainsAny 判断集合是否包含给定的一批元素中的任意一个
	ContainsAny(value []T) bool
	ContainsAnyByKeyFunc(value []T, keyFunc func(value T)) bool

	// String 集合转为字符串，注意这个方法不一定是可逆的，通常只是为了把集合打印日志之类的
	String() string

	// IsEmpty 判断集合是否为空
	IsEmpty() bool
	IsNotEmpty() bool

	// Remove 从集合中移除给定元素
	Remove(value T)

	// RemoveAll 从集合中移除给定的一批元素
	RemoveAll(value []T)
	RemoveAllByKeyFunc(value []T, keyFunc func(value T) string)

	// RetainAll 当前集合只保留给定的元素，其它元素移除掉
	RetainAll(other Collection[T])
	RetainAllByKeyFunc(other Collection[T], keyFunc func(value T) string)

	// Union 返回两个集合的并集
	Union(other Collection[T]) Collection[T]

	// Intersection 返回两个集合的交集
	Intersection(other Collection[T]) Collection[T]
	IntersectionByKeyFunc(other Collection[T], keyFunc func(value T) string) Collection[T]

	// Size 返回集合的大小，如果集合为空则返回0
	Size() int

	// ToSlice 将集合转为切片
	ToSlice() []T

	// Copy 复制集合本身为一个新的集合
	Copy() Collection[T]

	// ForEach 遍历集合中的每一个元素
	ForEach(eachFunc func(i int, element T))
}

Collection 集合的定义