From c1d21f2a289ac4bde11b05d413c29b3dcaf8a19a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20Cederstr=C3=B6m?= <andreas.cederstrom@arizon.se>
Date: Tue, 15 Oct 2024 09:04:08 +0200
Subject: [PATCH] Add Set functions

 Set.difference
 Set.intersection
 Set.union
 Set.symmetricDifference
 Set.isSubsetOf
 Set.isSupersetOf
 Set.isDisjointFrom
 Set.toArray
---
 CHANGELOG.md       |   2 +
 src/Core__Set.res  |  10 ++++
 src/Core__Set.resi | 133 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 145 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e146c5bc..364145bc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Next version
 
+- Add `difference`, `intersection`, `union`, `symmetricDifference`, `isSubsetOf`, `isSupersetOf`, `isDisjointFrom`, `toArray` functions to `Set`. https://github.com/rescript-association/rescript-core/pull/247
+
 ## 1.6.0
 
 - Optimize compare and equal functions. https://github.com/rescript-association/rescript-core/pull/238
diff --git a/src/Core__Set.res b/src/Core__Set.res
index 6a2ed0fa..4782eb6a 100644
--- a/src/Core__Set.res
+++ b/src/Core__Set.res
@@ -15,3 +15,13 @@ type t<'a> = Js.Set.t<'a>
 @send external forEach: (t<'a>, 'a => unit) => unit = "forEach"
 
 @send external values: t<'a> => Core__Iterator.t<'a> = "values"
+
+@send external difference: (t<'a>, t<'a>) => t<'a> = "difference"
+@send external intersection: (t<'a>, t<'a>) => t<'a> = "intersection"
+@send external union: (t<'a>, t<'a>) => t<'a> = "union"
+@send external symmetricDifference: (t<'a>, t<'a>) => t<'a> = "symmetricDifference"
+@send external isSubsetOf: (t<'a>, t<'a>) => bool = "isSubsetOf"
+@send external isSupersetOf: (t<'a>, t<'a>) => bool = "isSupersetOf"
+@send external isDisjointFrom: (t<'a>, t<'a>) => bool = "isDisjointFrom"
+
+external toArray: t<'a> => array<'a> = "Array.from"
diff --git a/src/Core__Set.resi b/src/Core__Set.resi
index 297755d0..058e08fa 100644
--- a/src/Core__Set.resi
+++ b/src/Core__Set.resi
@@ -68,6 +68,8 @@ external fromIterator: Core__Iterator.t<'a> => t<'a> = "Set"
 /**
 Returns the size, the number of unique values, of the set.
 
+See [`Set.prototype.size`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/size) on MDN.
+
 ## Examples
 ```rescript
 let set = Set.make()
@@ -85,6 +87,8 @@ external size: t<'a> => int = "size"
 /**
 Clears all entries in the set.
 
+See [`Set.clear`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/clear) on MDN.
+
 ## Examples
 ```rescript
 let set = Set.make()
@@ -102,6 +106,8 @@ external clear: t<'a> => unit = "clear"
 /**
 Adds a new value to the set.
 
+See [`Set.add`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/add) on MDN.
+
 ## Examples
 ```rescript
 let set = Set.make()
@@ -114,6 +120,8 @@ external add: (t<'a>, 'a) => unit = "add"
 /**
 Deletes the provided `value` from the set. Returns a `bool` for whether the value existed, and was deleted.
 
+See [`Set.delete`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/delete) on MDN.
+
 ## Examples
 ```rescript
 let set = Set.make()
@@ -131,6 +139,8 @@ external delete: (t<'a>, 'a) => bool = "delete"
 /**
 Checks whether the set has a specific value.
 
+See [`Set.has`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/has) on MDN.
+
 ## Examples
 ```rescript
 let set = Set.make()
@@ -148,6 +158,8 @@ external has: (t<'a>, 'a) => bool = "has"
 /**
 Iterates through all values of the set.
 
+See [`Set.forEach`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/forEach) on MDN.
+
 ## Examples
 ```rescript
 let set = Set.make()
@@ -165,6 +177,8 @@ external forEach: (t<'a>, 'a => unit) => unit = "forEach"
 /**
 Returns an iterator that holds all values of the set.
 
+See [`Set.values`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/values) on MDN.
+
 ## Examples
 ```rescript
 let set = Set.make()
@@ -183,3 +197,122 @@ Console.log(set->Set.values->Iterator.toArray)
 */
 @send
 external values: t<'a> => Core__Iterator.t<'a> = "values"
+
+/** 
+Returns a new set with the values of the set that are not in the other set.
+
+See [`Set.difference`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/difference) on MDN.
+
+## Examples
+```rescript
+let set1 = Set.fromArray(["apple", "orange", "banana"])
+let set2 = Set.fromArray(["apple", "banana", "pear"])
+set1->Set.difference(set2) // Set.fromArray(["orange"])
+```
+*/
+@send
+external difference: (t<'a>, t<'a>) => t<'a> = "difference"
+
+/**
+Returns a new set with the values containing the values which are in either the set, but not in both.
+
+See [`Set.symmetricDifference`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/symmetricDifference) on MDN.
+
+## Examples
+```rescript
+let set1 = Set.fromArray(["apple", "orange", "banana"])
+let set2 = Set.fromArray(["apple", "banana", "pear"])
+set1->Set.symmetricDifference(set2) // Set.fromArray(["orange", "pear"])
+```
+
+*/
+@send
+external symmetricDifference: (t<'a>, t<'a>) => t<'a> = "symmetricDifference"
+
+/**
+Returns a new set with the values containing the values which are in both the set and the other set.
+
+See [`Set.intersection`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/intersection) on MDN.
+
+## Examples
+```rescript
+let set1 = Set.fromArray(["apple", "orange", "banana"])
+let set2 = Set.fromArray(["apple", "banana", "pear"])
+set1->Set.intersection(set2) // Set.fromArray(["apple", "banana"])
+```
+*/
+@send
+external intersection: (t<'a>, t<'a>) => t<'a> = "intersection"
+
+/**
+Returns a bool indicating if this set has no elements in common with the given set.
+
+See [`Set.isDisjointFrom`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/isDisjointFrom) on MDN.
+
+## Examples
+```rescript
+let set1 = Set.fromArray(["apple", "orange", "banana"])
+let set2 = Set.fromArray(["kiwi", "melon", "pear"])
+set1->Set.isDisjointFrom(set2) // true
+```
+*/
+@send
+external isDisjointFrom: (t<'a>, t<'a>) => bool = "isDisjointFrom"
+
+/**
+Returns a bool indicating if the all values in the set are in the given set.
+
+See [`Set.isSubsetOf`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/isSubsetOf) on MDN.
+
+## Examples
+```rescript
+let set1 = Set.fromArray(["apple", "banana"])
+let set2 = Set.fromArray(["apple", "banana", "pear"])
+set1->Set.isSubsetOf(set2) // true
+```
+ */
+@send
+external isSubsetOf: (t<'a>, t<'a>) => bool = "isSubsetOf"
+
+/**
+Returns a bool indicating if the all values in the given set are in the set.
+
+See [`Set.isSupersetOf`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/isSupersetOf) on MDN.
+
+## Examples
+```rescript
+let set1 = Set.fromArray(["apple", "banana", "pear"])
+let set2 = Set.fromArray(["apple", "banana"])
+set1->Set.isSupersetOf(set2) // true
+ ```
+*/
+@send
+external isSupersetOf: (t<'a>, t<'a>) => bool = "isSupersetOf"
+
+/**
+ Returns a new set with the values of the set that are in both the set and the other set.
+
+See [`Set.union`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/union) on MDN.
+
+## Examples
+```rescript
+let set1 = Set.fromArray(["apple", "orange", "banana"])
+let set2 = Set.fromArray(["apple", "banana", "pear"])
+set1->Set.union(set2) // Set.fromArray(["apple", "orange", "banana", "pear"])
+```
+*/
+@send
+external union: (t<'a>, t<'a>) => t<'a> = "union"
+
+/**
+`toArray(set)` returns an array of all values of the set.
+
+See [`Array.from`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from) on MDN.
+
+## Examples
+```rescript
+let set = Set.fromArray(["apple", "orange", "apple", "banana"])
+set->Set.toArray // ["apple", "orange", "banana"]
+```
+*/
+external toArray: t<'a> => array<'a> = "Array.from"