feat(stdlib): Expose equality operators through Number module (#2296)

Author: spotandjake

stdlib/number.gr

@@ -139,6 +139,22 @@ provide let (*) = (*)
  */
 provide let (/) = (/)
 
+/**
+ * Computes the remainder of the division of the first operand by the second.
+ * The result will have the sign of the second operand.
+ *
+ * @param num1: The first operand
+ * @param num2: The second operand
+ * @returns The modulus of its operands
+ *
+ * @example
+ * use Number.{ (%) }
+ * assert 10 % 3 == 1
+ *
+ * @since v0.7.1
+ */
+provide let (%) = (%)
+
 /**
  * Computes the exponentiation of the given base and power.
  *
@@ -155,6 +171,104 @@ provide let (/) = (/)
  */
 provide let (**) = (**)
 
+/**
+ * Checks if the first value is equal to the second value.
+ *
+ * @param x: The first value
+ * @param y: The second value
+ * @returns `true` if the first value is equal to the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (==) }
+ * assert 1 == 1
+ *
+ * @since v0.7.1
+ */
+provide let (==) = Numbers.numberEq
+
+/**
+ * Checks if the first value is equal to the second value.
+ *
+ * @param x: The first value
+ * @param y: The second value
+ * @returns `true` if the first value is equal to the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (==) }
+ * assert 1 == 1
+ *
+ * @since v0.7.1
+ */
+provide let (!=) = (x, y) => !Numbers.numberEq(x, y)
+
+/**
+ * Checks if the first value is less than the second value.
+ *
+ * @param num1: The first value
+ * @param num2: The second value
+ * @returns `true` if the first value is less than the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (<) }
+ * assert 1 < 5
+ *
+ * @since v0.7.1
+ */
+provide let (<) = (<)
+
+/**
+ * Checks if the first value is greater than the second value.
+ *
+ * @param num1: The first value
+ * @param num2: The second value
+ * @returns `true` if the first value is greater than the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (>) }
+ * assert 5 > 1
+ *
+ * @since v0.7.1
+ */
+provide let (>) = (>)
+
+/**
+ * Checks if the first value is less than or equal to the second value.
+ *
+ * @param num1: The first value
+ * @param num2: The second value
+ * @returns `true` if the first value is less than or equal to the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (<=) }
+ * assert 1 <= 2
+ * @example
+ * use Number.{ (<=) }
+ * assert 1 <= 1
+ *
+ * @since v0.7.1
+ */
+@unsafe
+provide let (<=) = (<=)
+
+/**
+ * Checks if the first value is greater than or equal to the second value.
+ *
+ * @param num1: The first value
+ * @param num2: The second value
+ * @returns `true` if the first value is greater than or equal to the second value or `false` otherwise
+ *
+ * @example
+ * use Number.{ (>=) }
+ * assert 3 >= 2
+ * @example
+ * use Number.{ (>=) }
+ * assert 1 >= 1
+ *
+ * @since v0.7.1
+ */
+@unsafe
+provide let (>=) = (>=)
+
 /**
  * Computes the exponentiation of Euler's number to the given power.
  *

stdlib/number.md

@@ -281,6 +281,40 @@ use Number.{ (/) }
 assert 10 / 2.5 == 4
 ```
 
+### Number.**(%)**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+(%): (num1: Number, num2: Number) => Number
+```
+
+Computes the remainder of the division of the first operand by the second.
+The result will have the sign of the second operand.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`num1`|`Number`|The first operand|
+|`num2`|`Number`|The second operand|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The modulus of its operands|
+
+Examples:
+
+```grain
+use Number.{ (%) }
+assert 10 % 3 == 1
+```
+
 ### Number.**(\*\*)**
 
 <details>
@@ -321,6 +355,214 @@ use Number.{ (**) }
 assert 10 ** 2 == 100
 ```
 
+### Number.**(==)**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+(==): (x: Number, y: Number) => Bool
+```
+
+Checks if the first value is equal to the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Number`|The first value|
+|`y`|`Number`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is equal to the second value or `false` otherwise|
+
+Examples:
+
+```grain
+use Number.{ (==) }
+assert 1 == 1
+```
+
+### Number.**(!=)**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+(!=): (x: Number, y: Number) => Bool
+```
+
+Checks if the first value is equal to the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`x`|`Number`|The first value|
+|`y`|`Number`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is equal to the second value or `false` otherwise|
+
+Examples:
+
+```grain
+use Number.{ (==) }
+assert 1 == 1
+```
+
+### Number.**(<)**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+(<): (num1: Number, num2: Number) => Bool
+```
+
+Checks if the first value is less than the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`num1`|`Number`|The first value|
+|`num2`|`Number`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is less than the second value or `false` otherwise|
+
+Examples:
+
+```grain
+use Number.{ (<) }
+assert 1 < 5
+```
+
+### Number.**(>)**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+(>): (num1: Number, num2: Number) => Bool
+```
+
+Checks if the first value is greater than the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`num1`|`Number`|The first value|
+|`num2`|`Number`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is greater than the second value or `false` otherwise|
+
+Examples:
+
+```grain
+use Number.{ (>) }
+assert 5 > 1
+```
+
+### Number.**(<=)**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+(<=): (num1: Number, num2: Number) => Bool
+```
+
+Checks if the first value is less than or equal to the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`num1`|`Number`|The first value|
+|`num2`|`Number`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is less than or equal to the second value or `false` otherwise|
+
+Examples:
+
+```grain
+use Number.{ (<=) }
+assert 1 <= 2
+```
+
+```grain
+use Number.{ (<=) }
+assert 1 <= 1
+```
+
+### Number.**(>=)**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+(>=): (num1: Number, num2: Number) => Bool
+```
+
+Checks if the first value is greater than or equal to the second value.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`num1`|`Number`|The first value|
+|`num2`|`Number`|The second value|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the first value is greater than or equal to the second value or `false` otherwise|
+
+Examples:
+
+```grain
+use Number.{ (>=) }
+assert 3 >= 2
+```
+
+```grain
+use Number.{ (>=) }
+assert 1 >= 1
+```
+
 ### Number.**exp**
 
 <details disabled>