Исходный код MapSet

Функции, работающие с множествами.

Множество — это структура данных, которая может содержать уникальные элементы любого типа без какой-либо определенной упорядоченности. 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> 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"])

По определению, множества не могут содержать дублирующих элементов: при вставке элемента в множество, если он уже присутствует, вставка просто игнорируется.

iex> MapSet.new([2]) |> MapSet.put(4) |> MapSet.put(0)
MapSet.new([0, 2, 4])

Множество MapSet представлено внутри с помощью структуры %MapSet{}. Эта структура может быть использована, когда необходимо выполнить сопоставление с образцом для чего-либо, являющегося MapSet:

iex> match?(%MapSet{}, MapSet.new())
true

Обратите внимание, однако, что поля структуры являются закрытыми и не должны напрямую обращаться; для выполнения операций над множествами используйте функции в этом модуле.

Множества MapSet также можно создавать, начиная с других структур данных коллекций: например, см. MapSet.new/1 или Enum.into/2.

Множества MapSet основаны на наборах Erlang :sets (версия 2). Это означает, что они обладают многими свойствами, включая логарифмическую временную сложность. Наборы Erlang :sets (версия 2) реализованы на основе карт, поэтому для получения дополнительной информации о временной сложности их выполнения см. документацию по Map.

Краткое описание

Функции

delete(map_set, value): Удаляет value из map_set.
difference(map_set1, map_set2): Возвращает множество, которое является map_set1 без элементов из map_set2.
disjoint?(map_set1, map_set2): Проверяет, что map_set1 и map_set2 не имеют общих элементов.
equal?(map_set1, map_set2): Проверяет, равны ли два множества.
filter(map_set, fun): Фильтрует множество, возвращая только те элементы из map_set, для которых вызов fun возвращает истинное значение.
intersection(map_set1, map_set2): Возвращает множество, содержащее только элементы, которые map_set1 и map_set2 имеют общие.
member?(map_set, value): Проверяет, содержит ли map_set value.
new(): Возвращает новое множество.
new(enumerable): Создаёт множество из перечисляемого объекта.
new(enumerable, transform): Создаёт множество из перечисляемого объекта с помощью функции преобразования.
put(map_set, value): Вставляет value в map_set если map_set его еще не содержит.
reject(map_set, fun): Возвращает множество, исключая элементы из map_set, для которых вызов fun возвращает истинное значение.
size(map_set): Возвращает количество элементов в map_set.
split_with(map_set, fun): Разделяет множество map_set на два множества MapSet в соответствии с заданной функцией fun.
subset?(map_set1, map_set2): Проверяет, что все элементы множества map_set1 содержатся в множестве map_set2.
symmetric_difference(map_set1, map_set2): Возвращает множество с элементами, которые присутствуют только в одном, но не в обоих множествах.
to_list(map_set): Преобразует map_set в список.
union(map_set1, map_set2): Возвращает множество, содержащее все элементы из map_set1 и map_set2.

Типы

internal(value)Исходный код

@opaque internal(value)

t()Исходный код

@type t() :: t(term())

t(value)Исходный код

@type t(value) :: %MapSet{map: internal(value)}

value()Исходный код

@type value() :: term()

Функции

delete(map_set, value)Source

@spec delete(t(val1), val2) :: t(val1) when val1: value(), val2: value()

Удаляет value из map_set.

Возвращает новый набор, являющийся копией 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])

difference(map_set1, map_set2)Source

@spec difference(t(val1), t(val2)) :: t(val1) when val1: value(), val2: value()

Возвращает множество, представляющее собой map_set1 без элементов из map_set2.

Примеры

iex> MapSet.difference(MapSet.new([1, 2]), MapSet.new([2, 3, 4]))
MapSet.new([1])

disjoint?(map_set1, map_set2)Source

@spec disjoint?(t(), t()) :: boolean()

Проверяет, что 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

equal?(map_set1, map_set2)Source

@spec equal?(t(), t()) :: boolean()

Проверяет, равны ли два множества.

Сравнение элементов выполняется с использованием ===/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

filter(map_set, fun)Source

@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])

intersection(map_set1, map_set2)Source

@spec intersection(t(val), t(val)) :: t(val) when val: value()

Возвращает множество, содержащее только элементы, которые 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([])

member?(map_set, value)Source

@spec member?(t(), value()) :: boolean()

Проверяет, содержит ли map_set элемент value.

Примеры

iex> MapSet.member?(MapSet.new([1, 2, 3]), 2)
true
iex> MapSet.member?(MapSet.new([1, 2, 3]), 4)
false

new()Source

@spec new() :: t()

Возвращает новое множество.

Примеры

iex> MapSet.new()
MapSet.new([])

new(enumerable)Source

@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])

new(enumerable, transform)Source

@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])

put(map_set, value)Source

@spec put(t(val), new_val) :: t(val | new_val) when val: value(), new_val: value()

Вставляет value в map_set если 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])

reject(map_set, fun)Source

@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"])

size(map_set)Source

@spec size(t()) :: non_neg_integer()

Возвращает количество элементов в map_set.

Примеры

iex> MapSet.size(MapSet.new([1, 2, 3]))
3

split_with(map_set, fun)Source

@spec split_with(t(), (any() -> as_boolean(term()))) :: {t(), t()}

Разделяет map_set на два множества согласно заданной функции fun.

fun получает каждый элемент map_set в качестве единственного аргумента. Возвращает кортеж с первым множеством, содержащим все элементы map_set, для которых применение fun вернуло истинное значение, и вторым множеством со всеми элементами, для которых применение 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([])

subset?(map_set1, map_set2)Source

@spec subset?(t(), t()) :: boolean()

Проверяет, содержатся ли все элементы 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

symmetric_difference(map_set1, map_set2)Source

@spec symmetric_difference(t(val1), t(val2)) :: t(val1 | val2)
when val1: value(), val2: value()

Возвращает множество с элементами, присутствующими только в одном, но не в обоих множествах.

Примеры

iex> MapSet.symmetric_difference(MapSet.new([1, 2, 3]), MapSet.new([2, 3, 4]))
MapSet.new([1, 4])

to_list(map_set)Source

@spec to_list(t(val)) :: [val] when val: value()

Преобразует map_set в список.

Примеры

iex> MapSet.to_list(MapSet.new([1, 2, 3]))
[1, 2, 3]

union(map_set1, map_set2)Source

@spec union(t(val1), t(val2)) :: t(val1 | val2) when val1: value(), val2: value()

Возвращает множество, содержащее все элементы из map_set1 и map_set2.

Примеры

iex> MapSet.union(MapSet.new([1, 2]), MapSet.new([2, 3, 4]))
MapSet.new([1, 2, 3, 4])