Set

A Set is an unordered collection of unique values. Operations on a Set mutate the internal state, so it never needs to be re-assigned.

An immutable set implementation is available in the Immutable submodule.

1

from "set" include Set

Types

Type declarations included in the Set module.

Set.Set

1

type Set<k>

Set.InternalSetStats

1
2
3
4

record InternalSetStats {
  currentSize: Number,
  bucketCount: Number,
}

Represents the internal state of a set.

Values

Functions and constants included in the Set module.

Set.make

1

make : (?size: Number) => Set<a>

Creates a new empty set with an initial storage of the given size. As values are added or removed, the internal storage may grow or shrink. Generally, you won’t need to care about the storage size of your set and can use the default size.

Parameters:

Returns:

Set.add

1

add : (key: a, set: Set<a>) => Void

Adds a new value to the set. If the value already exists, nothing happens.

Parameters:

Set.contains

1

contains : (key: a, set: Set<a>) => Bool

Determines if the set contains the given value.

Parameters:

Returns:

Set.remove

1

remove : (key: a, set: Set<a>) => Void

Removes the given value from the set. If the value doesn’t exist, nothing happens.

Parameters:

Set.size

1

size : (set: Set<a>) => Number

Provides the count of values within the set.

Parameters:

Returns:

Set.isEmpty

1

isEmpty : (set: Set<a>) => Bool

Determines if the set contains no elements.

Parameters:

Returns:

Set.clear

1

clear : (set: Set<a>) => Void

Resets the set by removing all values.

Parameters:

Set.forEach

1

forEach : (fn: (a => Void), set: Set<a>) => Void

Iterates the set, calling an iterator function on each element.

Parameters:

Set.reduce

1

reduce : (fn: ((a, b) => a), init: a, set: Set<b>) => a

Combines all elements of a set using a reducer function.

Parameters:

Returns:

Set.filter

1

filter : (fn: (a => Bool), set: Set<a>) => Void

Removes elements from a set where a predicate function returns false.

Parameters:

Set.reject

1

reject : (fn: (a => Bool), set: Set<a>) => Void

Removes elements from a set where a predicate function returns true.

Parameters:

Set.toList

1

toList : (set: Set<a>) => List<a>

Converts a set into a list of its elements.

Parameters:

Returns:

Set.fromList

1

fromList : (list: List<a>) => Set<a>

Creates a set from a list.

Parameters:

Returns:

Set.toArray

1

toArray : (set: Set<a>) => Array<a>

Converts a set into an array of its elements.

Parameters:

Returns:

Set.fromArray

1

fromArray : (array: Array<a>) => Set<a>

Creates a set from an array.

Parameters:

Returns:

Set.union

1

union : (set1: Set<a>, set2: Set<a>) => Set<a>

Combines two sets into a single set containing all elements from both sets.

Parameters:

Returns:

Set.diff

1

diff : (set1: Set<a>, set2: Set<a>) => Set<a>

Combines two sets into a single set containing only the elements not shared between both sets.

Parameters:

Returns:

Set.intersect

1

intersect : (set1: Set<a>, set2: Set<a>) => Set<a>

Combines two sets into a single set containing only the elements shared between both sets.

Parameters:

Returns:

Set.getInternalStats

1

getInternalStats : (set: Set<a>) => InternalSetStats

Provides data representing the internal state state of the set.

Parameters:

Returns:

Set.Immutable

An immutable set implementation.

Types

Type declarations included in the Set.Immutable module.

Set.Immutable.Set

1

type Set<a>

Values

Functions and constants included in the Set.Immutable module.

Set.Immutable.empty

1

empty : Set<a>

An empty set

Set.Immutable.size

1

size : (set: Set<a>) => Number

Provides the count of values within the set.

Parameters:

Returns:

Set.Immutable.isEmpty

1

isEmpty : (set: Set<a>) => Bool

Determines if the set contains no elements.

Parameters:

Returns:

Set.Immutable.add

1

add : (key: a, set: Set<a>) => Set<a>

Produces a new set by inserting the given value into the set. If the value already exists, the new set will have the same elements as the input set.

Parameters:

Returns:

Set.Immutable.contains

1

contains : (key: a, set: Set<a>) => Bool

Determines if the set contains the given value.

Parameters:

Returns:

Set.Immutable.remove

1

remove : (key: a, set: Set<a>) => Set<a>

Produces a new set without the given element. If the value doesn’t exist in the set, the set will be returned unmodified.

Parameters:

Returns:

Set.Immutable.forEach

1

forEach : (fn: (a => Void), set: Set<a>) => Void

Iterates the set, calling an iterator function on each element.

Parameters:

Set.Immutable.reduce

1

reduce : (fn: ((a, b) => a), init: a, set: Set<b>) => a

Combines all elements of a set using a reducer function.

Parameters:

Returns:

Set.Immutable.filter

1

filter : (fn: (a => Bool), set: Set<a>) => Set<a>

Produces a new set without the elements from the input set where a predicate function returns false.

Parameters:

Returns:

Set.Immutable.reject

1

reject : (fn: (a => Bool), set: Set<a>) => Set<a>

Produces a new set without the elements from the input set where a predicate function returns true.

Parameters:

Returns:

Set.Immutable.union

1

union : (set1: Set<a>, set2: Set<a>) => Set<a>

Combines two sets into a single set containing all elements from both sets.

Parameters:

Returns:

Set.Immutable.diff

1

diff : (set1: Set<a>, set2: Set<a>) => Set<a>

Combines two sets into a single set containing only the elements not shared between both sets.

Parameters:

Returns:

Set.Immutable.intersect

1

intersect : (set1: Set<a>, set2: Set<a>) => Set<a>

Combines two sets into a single set containing only the elements shared between both sets.

Parameters:

Returns:

Set.Immutable.fromList

1

fromList : (list: List<a>) => Set<a>

Creates a set from a list.

Parameters:

Returns:

Set.Immutable.toList

1

toList : (set: Set<a>) => List<a>

Converts a set into a list of its elements.

Parameters:

Returns:

Set.Immutable.fromArray

1

fromArray : (array: Array<a>) => Set<a>

Creates a set from an array.

Parameters:

Returns:

Set.Immutable.toArray

1

toArray : (set: Set<a>) => Array<a>

Converts a set into an array of its elements.

Parameters:

Returns: