RangeSet (range_set v1.0.0)

Summary

Types

ranges()

t()

Functions

continuous?(range_set)

Determines if the set is continuous (there are no gaps).

difference(range_set, other)

Returns difference between sets.

empty?(range_set)

Determines if set is empty.

gaps(range_set)

Returns set that contains all gaps needed to make the range continuous.

intersection(range_set1, range_set2)

Returns intersection between two sets

length(range_set)

Computes length of the all ranges combined, aka amount of unique integers in set.

max(range_set, empty_callback \\ fn -> raise Enum.EmptyError end)

Returns the maximal element in set.

member?(range_set, value)

min(range_set, empty_callback \\ fn -> raise Enum.EmptyError end)

Returns the minimal element in set.

new()

Create new empty set.

new(set)

put(range_set, value)

Adds new value to set.

to_list(range_set)

Returns list of values stored in set.

union(range_set1, range_set2)

Returns union of sets

Types

ranges()

@opaque ranges()

t()

@type t() :: %RangeSet{ranges: ranges()}

Functions

continuous?(range_set)

@spec continuous?(t()) :: boolean()

Determines if the set is continuous (there are no gaps).

difference(range_set, other)

@spec difference(t(), t() | integer() | Range.t() | [integer()]) :: t()

Returns difference between sets.

empty?(range_set)

@spec empty?(t()) :: boolean()

Determines if set is empty.

iex> RangeSet.empty?(RangeSet.new())
true
iex> RangeSet.empty?(RangeSet.new(1..10))
false

gaps(range_set)

@spec gaps(t()) :: t()

Returns set that contains all gaps needed to make the range continuous.

iex> RangeSet.new([0..2, 6..9]) |> RangeSet.gaps()
RangeSet.new([3..5])

iex> RangeSet.new([0..5, 6..9]) |> RangeSet.gaps()
RangeSet.new([])

intersection(range_set1, range_set2)

@spec intersection(t(), t()) :: t()

Returns intersection between two sets

length(range_set)

@spec length(t()) :: non_neg_integer()

Computes length of the all ranges combined, aka amount of unique integers in set.

max(range_set, empty_callback \\ fn -> raise Enum.EmptyError end)

@spec max(t(), (-> term())) :: integer() | term()

Returns the maximal element in set.

If set is empty, the provided empty_callback is called.

Examples

iex> RangeSet.max(RangeSet.new([1..2, 5..10]))
10

member?(range_set, value)

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

min(range_set, empty_callback \\ fn -> raise Enum.EmptyError end)

@spec min(t(), (-> term())) :: integer() | term()

Returns the minimal element in set.

If set is empty, the provided empty_callback is called.

Examples

iex> RangeSet.min(RangeSet.new([1..2, 5..10]))
1

new()

@spec new() :: t()

Create new empty set.

new(set)

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

@spec new(Enumerable.t(Range.t())) :: t()

put(range_set, value)

@spec put(t(), integer() | Range.t()) :: t()

Adds new value to set.

to_list(range_set)

@spec to_list(t()) :: [integer()]

Returns list of values stored in set.

union(range_set1, range_set2)

@spec union(t(), t()) :: t()

Returns union of sets