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

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

Типы

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

t() :: t(term())

t(value) (opaque)

t(value)

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