查看源代码 MapSet (Elixir v1.16.2)
操作集合的函数。
集合是一种数据结构,可以包含任何类型的唯一元素,没有特定的顺序。 MapSet
是 Elixir 中的“首选”集合数据结构。
可以使用 MapSet.new/0
创建集合
iex> MapSet.new()
MapSet.new([])
集合中的元素不必是相同类型,它们可以从 可枚举 对象中填充,可以使用 MapSet.new/1
iex> MapSet.new([1, :two, {"three"}])
MapSet.new([1, :two, {"three"}])
可以使用 MapSet.put/2
插入元素
iex> MapSet.new([2]) |> MapSet.put(4) |> MapSet.put(0)
MapSet.new([0, 2, 4])
根据定义,集合不能包含重复元素:在将元素插入到已存在元素的集合中时,插入操作只是一个空操作。
iex> map_set = MapSet.new()
iex> MapSet.put(map_set, "foo")
MapSet.new(["foo"])
iex> map_set |> MapSet.put("foo") |> MapSet.put("foo")
MapSet.new(["foo"])
一个 MapSet
在内部使用 %MapSet{}
结构体表示。当需要对某个元素进行模式匹配时,可以使用此结构体来检查它是否是一个 MapSet
iex> match?(%MapSet{}, MapSet.new())
true
但是请注意,结构体的字段是私有的,不能直接访问;请使用本模块中的函数对集合执行操作。
还可以从其他集合类型数据结构开始创建 MapSet
:例如,请参见 MapSet.new/1
或 Enum.into/2
。
MapSet
是基于 Erlang 的 :sets
(版本 2) 构建的。这意味着它们共享许多属性,包括对数时间复杂度。Erlang :sets
(版本 2) 是基于映射实现的,因此请参见 Map
的文档以了解有关其执行时间复杂度的更多信息。
概要
函数
从 map_set
中删除 value
。
返回一个集合,该集合是 map_set1
去掉了 map_set2
中的成员。
检查 map_set1
和 map_set2
是否没有任何共同的成员。
检查两个集合是否相等。
通过仅返回 map_set
中调用 fun
返回真值的所有元素来过滤集合。
返回一个集合,该集合仅包含 map_set1
和 map_set2
共同拥有的成员。
检查 map_set
是否包含 value
。
返回一个新的集合。
从可枚举对象创建一个集合。
通过转换函数从可枚举对象创建一个集合。
如果 map_set
不包含 value
,则将 value
插入到 map_set
中。
通过排除 map_set
中调用 fun
返回真值的所有元素来返回一个集合。
返回 map_set
中的元素数量。
根据给定的函数 fun
将 map_set
拆分为两个 MapSet
。
检查 map_set1
的所有成员是否都包含在 map_set2
中。
返回一个集合,该集合包含仅存在于一个集合中,而不在两个集合中都存在的元素。
将 map_set
转换为列表。
返回一个集合,该集合包含 map_set1
和 map_set2
中的所有成员。
类型
函数
从 map_set
中删除 value
。
返回一个新的集合,它是 map_set
的副本,但不包含 value
。
示例
iex> map_set = MapSet.new([1, 2, 3])
iex> MapSet.delete(map_set, 4)
MapSet.new([1, 2, 3])
iex> MapSet.delete(map_set, 2)
MapSet.new([1, 3])
返回一个集合,该集合是 map_set1
去掉了 map_set2
中的成员。
示例
iex> MapSet.difference(MapSet.new([1, 2]), MapSet.new([2, 3, 4]))
MapSet.new([1])
检查 map_set1
和 map_set2
是否没有任何共同的成员。
示例
iex> MapSet.disjoint?(MapSet.new([1, 2]), MapSet.new([3, 4]))
true
iex> MapSet.disjoint?(MapSet.new([1, 2]), MapSet.new([2, 3]))
false
检查两个集合是否相等。
元素之间的比较使用 ===/2
完成,其中包含 1
的集合与包含 1.0
的集合不同。
示例
iex> MapSet.equal?(MapSet.new([1, 2]), MapSet.new([2, 1, 1]))
true
iex> MapSet.equal?(MapSet.new([1, 2]), MapSet.new([3, 4]))
false
iex> MapSet.equal?(MapSet.new([1]), MapSet.new([1.0]))
false
@spec filter(t(a), (a -> as_boolean(term()))) :: t(a) when a: value()
通过仅返回 map_set
中调用 fun
返回真值的所有元素来过滤集合。
另请参见 reject/2
,它将丢弃所有函数返回值为真值的所有元素。
性能注意事项
如果您发现自己在管道中多次调用
MapSet.filter/2
和MapSet.reject/2
,那么使用Enum.map/2
和Enum.filter/2
然后使用MapSet.new/1
转换为映射可能更高效。
示例
iex> MapSet.filter(MapSet.new(1..5), fn x -> x > 3 end)
MapSet.new([4, 5])
iex> MapSet.filter(MapSet.new(["a", :b, "c"]), &is_atom/1)
MapSet.new([:b])
返回一个集合,该集合仅包含 map_set1
和 map_set2
共同拥有的成员。
示例
iex> MapSet.intersection(MapSet.new([1, 2]), MapSet.new([2, 3, 4]))
MapSet.new([2])
iex> MapSet.intersection(MapSet.new([1, 2]), MapSet.new([3, 4]))
MapSet.new([])
检查 map_set
是否包含 value
。
示例
iex> MapSet.member?(MapSet.new([1, 2, 3]), 2)
true
iex> MapSet.member?(MapSet.new([1, 2, 3]), 4)
false
@spec new() :: t()
返回一个新的集合。
示例
iex> MapSet.new()
MapSet.new([])
@spec new(Enumerable.t()) :: t()
从可枚举对象创建一个集合。
示例
iex> MapSet.new([:b, :a, 3])
MapSet.new([3, :a, :b])
iex> MapSet.new([3, 3, 3, 2, 2, 1])
MapSet.new([1, 2, 3])
@spec new(Enumerable.t(), (term() -> val)) :: t(val) when val: value()
通过转换函数从可枚举对象创建一个集合。
示例
iex> MapSet.new([1, 2, 1], fn x -> 2 * x end)
MapSet.new([2, 4])
如果 map_set
不包含 value
,则将 value
插入到 map_set
中。
示例
iex> MapSet.put(MapSet.new([1, 2, 3]), 3)
MapSet.new([1, 2, 3])
iex> MapSet.put(MapSet.new([1, 2, 3]), 4)
MapSet.new([1, 2, 3, 4])
@spec reject(t(a), (a -> as_boolean(term()))) :: t(a) when a: value()
通过排除 map_set
中调用 fun
返回真值的所有元素来返回一个集合。
另请参见 filter/2
。
示例
iex> MapSet.reject(MapSet.new(1..5), fn x -> rem(x, 2) != 0 end)
MapSet.new([2, 4])
iex> MapSet.reject(MapSet.new(["a", :b, "c"]), &is_atom/1)
MapSet.new(["a", "c"])
@spec size(t()) :: non_neg_integer()
返回 map_set
中的元素数量。
示例
iex> MapSet.size(MapSet.new([1, 2, 3]))
3
根据给定的函数 fun
将 map_set
拆分为两个 MapSet
。
fun
接收 map_set
中的每个元素作为其唯一参数。返回一个元组,第一个 MapSet
包含 map_set
中所有应用 fun
返回真值的所有元素,第二个 MapSet
包含所有应用 fun
返回假值(false
或 nil
)的所有元素。
示例
iex> {while_true, while_false} = MapSet.split_with(MapSet.new([1, 2, 3, 4]), fn v -> rem(v, 2) == 0 end)
iex> while_true
MapSet.new([2, 4])
iex> while_false
MapSet.new([1, 3])
iex> {while_true, while_false} = MapSet.split_with(MapSet.new(), fn {_k, v} -> v > 50 end)
iex> while_true
MapSet.new([])
iex> while_false
MapSet.new([])
检查 map_set1
的所有成员是否都包含在 map_set2
中。
此函数检查 map_set1
是否是 map_set2
的子集。
示例
iex> MapSet.subset?(MapSet.new([1, 2]), MapSet.new([1, 2, 3]))
true
iex> MapSet.subset?(MapSet.new([1, 2, 3]), MapSet.new([1, 2]))
false
返回一个集合,该集合包含仅存在于一个集合中,而不在两个集合中都存在的元素。
示例
iex> MapSet.symmetric_difference(MapSet.new([1, 2, 3]), MapSet.new([2, 3, 4]))
MapSet.new([1, 4])
将 map_set
转换为列表。
示例
iex> MapSet.to_list(MapSet.new([1, 2, 3]))
[1, 2, 3]
返回一个集合,该集合包含 map_set1
和 map_set2
中的所有成员。
示例
iex> MapSet.union(MapSet.new([1, 2]), MapSet.new([2, 3, 4]))
MapSet.new([1, 2, 3, 4])