Spec-Zone.ru › Elixir 1.13

MapSet

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

Множество — это структура данных, которая может содержать уникальные элементы любого типа без определенного порядка. MapSet — это структура данных "множество" в Elixir.

Множество можно создать, используя MapSet.new/0:

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

Элементы множества могут быть разных типов и могут быть заполнены из перечисляемого объекта, используя MapSet.new/1:

iex> MapSet.new([1, :two, {"three"}])
#MapSet<[1, :two, {"three"}]>

Элементы можно вставить, используя MapSet.put/2:

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

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

iex> map_set = MapSet.new()
iex> MapSet.put(map_set, "foo")
#MapSet<["foo"]>
iex> map_set |> MapSet.put("foo") |> MapSet.put("foo")
#MapSet<["foo"]>

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

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

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

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

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

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

Типы

t()
t(value)
value()

Функции

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)

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

intersection(map_set, map_set)

Возвращает множество, содержащее только элементы, которые 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 его ещё не содержит.

size(map_set)

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

subset?(map_set1, map_set2)

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

to_list(map_set)

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

union(map_set1, map_set2)

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

Типы

t()Source

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

t(value)Source

@opaque t(value)

value()Source

@type value() :: term()
END_OF_DOCUMENT_MARKER

Функции

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<[1, 2, 3]>
iex> MapSet.delete(map_set, 2)
#MapSet<[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<[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

intersection(map_set, map_set)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<[2]>

iex> MapSet.intersection(MapSet.new([1, 2]), MapSet.new([3, 4]))
#MapSet<[]>

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(enumerable)Source

@spec new(Enum.t()) :: t()

Создает набор из перечислимого объекта.

Примеры

iex> MapSet.new([:b, :a, 3])
#MapSet<[3, :a, :b]>
iex> MapSet.new([3, 3, 3, 2, 2, 1])
#MapSet<[1, 2, 3]>

new(enumerable, transform)Source

@spec new(Enum.t(), (term() -> val)) :: t(val) when val: value()

Создает набор из перечислимого объекта с помощью функции преобразования.

Примеры

iex> MapSet.new([1, 2, 1], fn x -> 2 * x end)
#MapSet<[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<[1, 2, 3]>
iex> MapSet.put(MapSet.new([1, 2, 3]), 4)
#MapSet<[1, 2, 3, 4]>

size(map_set)Source

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

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

Примеры

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

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

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<[1, 2, 3, 4]>

© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.13.4/MapSet.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API