effect 2.0.0-next.42 → 2.0.0-next.44

package/Number/dist/effect-Number.cjs.prod.js

@@ -2,32 +2,392 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-require('../../dist/Equivalence-0bc84518.cjs.prod.js');
-require('../../dist/Function-2e6b0cda.cjs.prod.js');
-require('../../dist/Order-8a112bfb.cjs.prod.js');
-require('../../dist/Predicate-daa86e61.cjs.prod.js');
-var Number_dist_effectNumber = require('../../dist/Number-cb2ba2e8.cjs.prod.js');
-
-
-
-exports.Equivalence = Number_dist_effectNumber.Equivalence;
-exports.Order = Number_dist_effectNumber.Order;
-exports.between = Number_dist_effectNumber.between;
-exports.clamp = Number_dist_effectNumber.clamp;
-exports.decrement = Number_dist_effectNumber.decrement;
-exports.divide = Number_dist_effectNumber.divide;
-exports.greaterThan = Number_dist_effectNumber.greaterThan;
-exports.greaterThanOrEqualTo = Number_dist_effectNumber.greaterThanOrEqualTo;
-exports.increment = Number_dist_effectNumber.increment;
-exports.isNumber = Number_dist_effectNumber.isNumber;
-exports.lessThan = Number_dist_effectNumber.lessThan;
-exports.lessThanOrEqualTo = Number_dist_effectNumber.lessThanOrEqualTo;
-exports.max = Number_dist_effectNumber.max;
-exports.min = Number_dist_effectNumber.min;
-exports.multiply = Number_dist_effectNumber.multiply;
-exports.multiplyAll = Number_dist_effectNumber.multiplyAll;
-exports.remainder = Number_dist_effectNumber.remainder;
-exports.sign = Number_dist_effectNumber.sign;
-exports.subtract = Number_dist_effectNumber.subtract;
-exports.sum = Number_dist_effectNumber.sum;
-exports.sumAll = Number_dist_effectNumber.sumAll;
+var Equivalence_dist_effectEquivalence = require('../../Equivalence/dist/effect-Equivalence.cjs.prod.js');
+var Function_dist_effectFunction = require('../../Function/dist/effect-Function.cjs.prod.js');
+var Order_dist_effectOrder = require('../../Order/dist/effect-Order.cjs.prod.js');
+var Predicate_dist_effectPredicate = require('../../Predicate/dist/effect-Predicate.cjs.prod.js');
+
+/**
+ * This module provides utility functions and type class instances for working with the `number` type in TypeScript.
+ * It includes functions for basic arithmetic operations, as well as type class instances for
+ * `Equivalence`, `Order`, `Semigroup`, and `Monoid`.
+ *
+ * @since 2.0.0
+ */
+
+/**
+ * Tests if a value is a `number`.
+ *
+ * @param input - The value to test.
+ *
+ * @example
+ * import { isNumber } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(isNumber(2), true)
+ * assert.deepStrictEqual(isNumber("2"), false)
+ *
+ * @category guards
+ * @since 2.0.0
+ */
+const isNumber = Predicate_dist_effectPredicate.isNumber;
+
+/**
+ * Provides an addition operation on `number`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { sum } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(sum(2, 3), 5)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sum = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self + that);
+
+/**
+ * Provides a multiplication operation on `number`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { multiply } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(multiply(2, 3), 6)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const multiply = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self * that);
+
+/**
+ * Provides a subtraction operation on `number`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { subtract } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(subtract(2, 3), -1)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const subtract = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self - that);
+
+/**
+ * Provides a division operation on `number`s.
+ *
+ * @param self - The dividend operand.
+ * @param that - The divisor operand.
+ *
+ * @example
+ * import { divide } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(divide(6, 3), 2)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const divide = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self / that);
+
+/**
+ * Returns the result of adding `1` to a given number.
+ *
+ * @param n - A `number` to be incremented.
+ *
+ * @example
+ * import { increment } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(increment(2), 3)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const increment = n => n + 1;
+
+/**
+ * Decrements a number by `1`.
+ *
+ * @param n - A `number` to be decremented.
+ *
+ * @example
+ * import { decrement } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(decrement(3), 2)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const decrement = n => n - 1;
+
+/**
+ * @category instances
+ * @since 2.0.0
+ */
+const Equivalence = Equivalence_dist_effectEquivalence.number;
+
+/**
+ * @category instances
+ * @since 2.0.0
+ */
+const Order = Order_dist_effectOrder.number;
+
+/**
+ * Returns `true` if the first argument is less than the second, otherwise `false`.
+ *
+ * @param self - The first argument.
+ * @param that - The second argument.
+ *
+ * @example
+ * import { lessThan } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(lessThan(2, 3), true)
+ * assert.deepStrictEqual(lessThan(3, 3), false)
+ * assert.deepStrictEqual(lessThan(4, 3), false)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const lessThan = /*#__PURE__*/Order_dist_effectOrder.lessThan(Order);
+
+/**
+ * Returns a function that checks if a given `number` is less than or equal to the provided one.
+ *
+ * @param self - The first `number` to compare with.
+ * @param that - The second `number` to compare with.
+ *
+ * @example
+ * import { lessThanOrEqualTo } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(lessThanOrEqualTo(2, 3), true)
+ * assert.deepStrictEqual(lessThanOrEqualTo(3, 3), true)
+ * assert.deepStrictEqual(lessThanOrEqualTo(4, 3), false)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const lessThanOrEqualTo = /*#__PURE__*/Order_dist_effectOrder.lessThanOrEqualTo(Order);
+
+/**
+ * Returns `true` if the first argument is greater than the second, otherwise `false`.
+ *
+ * @param self - The first argument.
+ * @param that - The second argument.
+ *
+ * @example
+ * import { greaterThan } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(greaterThan(2, 3), false)
+ * assert.deepStrictEqual(greaterThan(3, 3), false)
+ * assert.deepStrictEqual(greaterThan(4, 3), true)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const greaterThan = /*#__PURE__*/Order_dist_effectOrder.greaterThan(Order);
+
+/**
+ * Returns a function that checks if a given `number` is greater than or equal to the provided one.
+ *
+ * @param self - The first `number` to compare with.
+ * @param that - The second `number` to compare with.
+ *
+ * @example
+ * import { greaterThanOrEqualTo } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(greaterThanOrEqualTo(2, 3), false)
+ * assert.deepStrictEqual(greaterThanOrEqualTo(3, 3), true)
+ * assert.deepStrictEqual(greaterThanOrEqualTo(4, 3), true)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const greaterThanOrEqualTo = /*#__PURE__*/Order_dist_effectOrder.greaterThanOrEqualTo(Order);
+
+/**
+ * Checks if a `number` is between a `minimum` and `maximum` value (inclusive).
+ *
+ * @param self - The `number` to check.
+ * @param minimum - The `minimum` value to check.
+ * @param maximum - The `maximum` value to check.
+ *
+ * @example
+ * import { between } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(between(0, 5)(3), true)
+ * assert.deepStrictEqual(between(0, 5)(-1), false)
+ * assert.deepStrictEqual(between(0, 5)(6), false)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const between = /*#__PURE__*/Order_dist_effectOrder.between(Order);
+
+/**
+ * Restricts the given `number` to be within the range specified by the `minimum` and `maximum` values.
+ *
+ * - If the `number` is less than the `minimum` value, the function returns the `minimum` value.
+ * - If the `number` is greater than the `maximum` value, the function returns the `maximum` value.
+ * - Otherwise, it returns the original `number`.
+ *
+ * @param self - The `number` to be clamped.
+ * @param minimum - The lower end of the range.
+ * @param maximum - The upper end of the range.
+ *
+ * @example
+ * import { clamp } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(clamp(0, 5)(3), 3)
+ * assert.deepStrictEqual(clamp(0, 5)(-1), 0)
+ * assert.deepStrictEqual(clamp(0, 5)(6), 5)
+ *
+ * @since 2.0.0
+ */
+const clamp = /*#__PURE__*/Order_dist_effectOrder.clamp(Order);
+
+/**
+ * Returns the minimum between two `number`s.
+ *
+ * @param self - The first `number`.
+ * @param that - The second `number`.
+ *
+ * @example
+ * import { min } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(min(2, 3), 2)
+ *
+ * @since 2.0.0
+ */
+const min = /*#__PURE__*/Order_dist_effectOrder.min(Order);
+
+/**
+ * Returns the maximum between two `number`s.
+ *
+ * @param self - The first `number`.
+ * @param that - The second `number`.
+ *
+ * @example
+ * import { max } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(max(2, 3), 3)
+ *
+ * @since 2.0.0
+ */
+const max = /*#__PURE__*/Order_dist_effectOrder.max(Order);
+
+/**
+ * Determines the sign of a given `number`.
+ *
+ * @param n - The `number` to determine the sign of.
+ *
+ * @example
+ * import { sign } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(sign(-5), -1)
+ * assert.deepStrictEqual(sign(0), 0)
+ * assert.deepStrictEqual(sign(5), 1)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sign = n => Order(n, 0);
+
+/**
+ * Takes an `Iterable` of `number`s and returns their sum as a single `number`.
+ *
+ * @param collection - The collection of `number`s to sum.
+ *
+ * @example
+ * import { sumAll } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(sumAll([2, 3, 4]), 9)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sumAll = collection => {
+  let out = 0;
+  for (const n of collection) {
+    out += n;
+  }
+  return out;
+};
+
+/**
+ * Takes an `Iterable` of `number`s and returns their multiplication as a single `number`.
+ *
+ * @param collection - The collection of `number`s to multiply.
+ *
+ * @example
+ * import { multiplyAll } from 'effect/Number'
+ *
+ * assert.deepStrictEqual(multiplyAll([2, 3, 4]), 24)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const multiplyAll = collection => {
+  let out = 1;
+  for (const n of collection) {
+    if (n === 0) {
+      return 0;
+    }
+    out *= n;
+  }
+  return out;
+};
+
+/**
+ * Returns the remainder left over when one operand is divided by a second operand.
+ *
+ * It always takes the sign of the dividend.
+ *
+ * @param self - The dividend.
+ * @param divisor - The divisor.
+ *
+ * @example
+ * import { remainder } from "effect/Number"
+ *
+ * assert.deepStrictEqual(remainder(2, 2), 0)
+ * assert.deepStrictEqual(remainder(3, 2), 1)
+ * assert.deepStrictEqual(remainder(-4, 2), -0)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const remainder = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, divisor) => {
+  // https://stackoverflow.com/questions/3966484/why-does-modulus-operator-return-fractional-number-in-javascript/31711034#31711034
+  const selfDecCount = (self.toString().split(".")[1] || "").length;
+  const divisorDecCount = (divisor.toString().split(".")[1] || "").length;
+  const decCount = selfDecCount > divisorDecCount ? selfDecCount : divisorDecCount;
+  const selfInt = parseInt(self.toFixed(decCount).replace(".", ""));
+  const divisorInt = parseInt(divisor.toFixed(decCount).replace(".", ""));
+  return selfInt % divisorInt / Math.pow(10, decCount);
+});
+
+exports.Equivalence = Equivalence;
+exports.Order = Order;
+exports.between = between;
+exports.clamp = clamp;
+exports.decrement = decrement;
+exports.divide = divide;
+exports.greaterThan = greaterThan;
+exports.greaterThanOrEqualTo = greaterThanOrEqualTo;
+exports.increment = increment;
+exports.isNumber = isNumber;
+exports.lessThan = lessThan;
+exports.lessThanOrEqualTo = lessThanOrEqualTo;
+exports.max = max;
+exports.min = min;
+exports.multiply = multiply;
+exports.multiplyAll = multiplyAll;
+exports.remainder = remainder;
+exports.sign = sign;
+exports.subtract = subtract;
+exports.sum = sum;
+exports.sumAll = sumAll;