Elixir v1.3.0-rc.0 MapSet View Source
A set of functions for working with sets.
The MapSet is represented internally as a struct,
therefore %MapSet{} can be used whenever there is a
need to match on any MapSet. Note though the struct
fields are private and must not be accessed directly.
Instead, use the functions in this module.
Link to this section Summary
Functions
Deletes value from set
Returns a set that is set1 without the members of set2
Checks if set1 and set2 have no members in common
Checks if two sets are equal
Returns a set containing only members that set1 and set2 have in common
Checks if set contains value
Returns a new set
Creates a set from an enumerable
Creates a mapset from an enumerable via the transformation function
Inserts value into set if set doesn’t already contain it
Returns the number of elements in set
Checks if set1’s members are all contained in set2
Converts set to a list
Returns a set containing all members of set1 and set2
Link to this section Types
Link to this section Functions
Deletes value from set.
Returns a new set which is a copy of set but without value.
Examples
iex> set = MapSet.new([1, 2, 3])
iex> MapSet.delete(set, 4)
#MapSet<[1, 2, 3]>
iex> MapSet.delete(set, 2)
#MapSet<[1, 3]>Returns a set that is set1 without the members of set2.
Examples
iex> MapSet.difference(MapSet.new([1, 2]), MapSet.new([2, 3, 4]))
#MapSet<[1]>Checks if set1 and set2 have no members in common.
Examples
iex> MapSet.disjoint?(MapSet.new([1, 2]), MapSet.new([3, 4]))
true
iex> MapSet.disjoint?(MapSet.new([1, 2]), MapSet.new([2, 3]))
falseChecks if two sets are equal.
The comparison between elements must be done using ===.
Examples
iex> MapSet.equal?(MapSet.new([1, 2]), MapSet.new([2, 1, 1]))
true
iex> MapSet.equal?(MapSet.new([1, 2]), MapSet.new([3, 4]))
falseReturns a set containing only members that set1 and set2 have in common.
Examples
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<[]>Checks if set contains value.
Examples
iex> MapSet.member?(MapSet.new([1, 2, 3]), 2)
true
iex> MapSet.member?(MapSet.new([1, 2, 3]), 4)
falseCreates a set from an enumerable.
Examples
iex> MapSet.new([:b, :a, 3])
#MapSet<[3, :a, :b]>
iex> MapSet.new([3, 3, 3, 2, 2, 1])
#MapSet<[1, 2, 3]>Creates a mapset from an enumerable via the transformation function.
Examples
iex> MapSet.new([1, 2, 1], fn x -> 2 * x end)
#MapSet<[2, 4]>Inserts value into set if set doesn’t already contain it.
Examples
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]>Checks if set1’s members are all contained in set2.
This function checks if set1 is a subset of set2.
Examples
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