Spec-Zone.ru › Elixir 1.9

MapSet

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

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

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

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

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.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.

END_OF_DOCUMENT_MARKER

Типы

t()

Характеристики

t() :: t(term())

t(значение)

Характеристики

t(value)

значение()

Характеристики

value() :: term()

Функции

delete(map_set, value)

Спецификации

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)

Спецификации

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)

Спецификации

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)

Спецификации

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

Проверяет, равны ли два набора.

Сравнение элементов должно выполняться с помощью ===/2.

Примеры

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

intersection(map_set, map_set)

Спецификации

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)

Спецификации

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

Спецификации

new() :: t()

Возвращает новый набор.

Примеры

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

new(enumerable)

Спецификации

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)

Спецификации

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)

Спецификации

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)

Спецификации

size(t()) :: non_neg_integer()

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

Примеры

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

subset?(map_set1, map_set2)

Спецификации

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)

Спецификации

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)

Спецификации

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.9.4/MapSet.html

Spec-Zone.ru

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