effect 2.0.0-next.42 → 2.0.0-next.43

package/Bigint/dist/effect-Bigint.cjs.dev.js

@@ -2,31 +2,368 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-require('../../dist/Equivalence-de7a0d51.cjs.dev.js');
-require('../../dist/Function-41ce433d.cjs.dev.js');
-require('../../dist/Order-28bdebd2.cjs.dev.js');
-require('../../dist/Predicate-9e859c9c.cjs.dev.js');
-var Bigint_dist_effectBigint = require('../../dist/Bigint-0ebd807c.cjs.dev.js');
-
-
-
-exports.Equivalence = Bigint_dist_effectBigint.Equivalence;
-exports.Order = Bigint_dist_effectBigint.Order;
-exports.between = Bigint_dist_effectBigint.between;
-exports.clamp = Bigint_dist_effectBigint.clamp;
-exports.decrement = Bigint_dist_effectBigint.decrement;
-exports.divide = Bigint_dist_effectBigint.divide;
-exports.greaterThan = Bigint_dist_effectBigint.greaterThan;
-exports.greaterThanOrEqualTo = Bigint_dist_effectBigint.greaterThanOrEqualTo;
-exports.increment = Bigint_dist_effectBigint.increment;
-exports.isBigint = Bigint_dist_effectBigint.isBigint;
-exports.lessThan = Bigint_dist_effectBigint.lessThan;
-exports.lessThanOrEqualTo = Bigint_dist_effectBigint.lessThanOrEqualTo;
-exports.max = Bigint_dist_effectBigint.max;
-exports.min = Bigint_dist_effectBigint.min;
-exports.multiply = Bigint_dist_effectBigint.multiply;
-exports.multiplyAll = Bigint_dist_effectBigint.multiplyAll;
-exports.sign = Bigint_dist_effectBigint.sign;
-exports.subtract = Bigint_dist_effectBigint.subtract;
-exports.sum = Bigint_dist_effectBigint.sum;
-exports.sumAll = Bigint_dist_effectBigint.sumAll;
+var Equivalence_dist_effectEquivalence = require('../../Equivalence/dist/effect-Equivalence.cjs.dev.js');
+var Function_dist_effectFunction = require('../../Function/dist/effect-Function.cjs.dev.js');
+var Order_dist_effectOrder = require('../../Order/dist/effect-Order.cjs.dev.js');
+var Predicate_dist_effectPredicate = require('../../Predicate/dist/effect-Predicate.cjs.dev.js');
+
+/**
+ * This module provides utility functions and type class instances for working with the `bigint` 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 `bigint`.
+ *
+ * @param input - The value to test.
+ *
+ * @example
+ * import { isBigint } from "effect/Bigint"
+ *
+ * assert.deepStrictEqual(isBigint(1n), true)
+ * assert.deepStrictEqual(isBigint(1), false)
+ *
+ * @category guards
+ * @since 2.0.0
+ */
+const isBigint = Predicate_dist_effectPredicate.isBigint;
+
+/**
+ * Provides an addition operation on `bigint`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { sum } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(sum(2n, 3n), 5n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sum = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self + that);
+
+/**
+ * Provides a multiplication operation on `bigint`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { multiply } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(multiply(2n, 3n), 6n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const multiply = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self * that);
+
+/**
+ * Provides a subtraction operation on `bigint`s.
+ *
+ * @param self - The first operand.
+ * @param that - The second operand.
+ *
+ * @example
+ * import { subtract } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(subtract(2n, 3n), -1n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const subtract = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self - that);
+
+/**
+ * Provides a division operation on `bigint`s.
+ *
+ * If the dividend is not a multiple of the divisor the result will be a `bigint` value
+ * which represents the integer division rounded down to the nearest integer.
+ *
+ * @param self - The dividend operand.
+ * @param that - The divisor operand.
+ *
+ * @example
+ * import { divide } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(divide(6n, 3n), 2n)
+ * assert.deepStrictEqual(divide(6n, 4n), 1n)
+ *
+ * @category math
+ * @since 2.0.0
+ * @since 2.0.0
+ */
+const divide = /*#__PURE__*/Function_dist_effectFunction.dual(2, (self, that) => self / that);
+
+/**
+ * Returns the result of adding `1n` to a given number.
+ *
+ * @param n - A `bigint` to be incremented.
+ *
+ * @example
+ * import { increment } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(increment(2n), 3n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const increment = n => n + 1n;
+
+/**
+ * Decrements a number by `1n`.
+ *
+ * @param n - A `bigint` to be decremented.
+ *
+ * @example
+ * import { decrement } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(decrement(3n), 2n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const decrement = n => n - 1n;
+
+/**
+ * @category instances
+ * @since 2.0.0
+ */
+const Equivalence = Equivalence_dist_effectEquivalence.bigint;
+
+/**
+ * @category instances
+ * @since 2.0.0
+ */
+const Order = Order_dist_effectOrder.bigint;
+
+/**
+ * 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/Bigint'
+ *
+ * assert.deepStrictEqual(lessThan(2n, 3n), true)
+ * assert.deepStrictEqual(lessThan(3n, 3n), false)
+ * assert.deepStrictEqual(lessThan(4n, 3n), false)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const lessThan = /*#__PURE__*/Order_dist_effectOrder.lessThan(Order);
+
+/**
+ * Returns a function that checks if a given `bigint` is less than or equal to the provided one.
+ *
+ * @param self - The first `bigint` to compare with.
+ * @param that - The second `bigint` to compare with.
+ *
+ * @example
+ * import { lessThanOrEqualTo } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(lessThanOrEqualTo(2n, 3n), true)
+ * assert.deepStrictEqual(lessThanOrEqualTo(3n, 3n), true)
+ * assert.deepStrictEqual(lessThanOrEqualTo(4n, 3n), 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/Bigint'
+ *
+ * assert.deepStrictEqual(greaterThan(2n, 3n), false)
+ * assert.deepStrictEqual(greaterThan(3n, 3n), false)
+ * assert.deepStrictEqual(greaterThan(4n, 3n), true)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const greaterThan = /*#__PURE__*/Order_dist_effectOrder.greaterThan(Order);
+
+/**
+ * Returns a function that checks if a given `bigint` is greater than or equal to the provided one.
+ *
+ * @param self - The first `bigint` to compare with.
+ * @param that - The second `bigint` to compare with.
+ *
+ * @example
+ * import { greaterThanOrEqualTo } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(greaterThanOrEqualTo(2n, 3n), false)
+ * assert.deepStrictEqual(greaterThanOrEqualTo(3n, 3n), true)
+ * assert.deepStrictEqual(greaterThanOrEqualTo(4n, 3n), true)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const greaterThanOrEqualTo = /*#__PURE__*/Order_dist_effectOrder.greaterThanOrEqualTo(Order);
+
+/**
+ * Checks if a `bigint` 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/Bigint'
+ *
+ * assert.deepStrictEqual(between(0n, 5n)(3n), true)
+ * assert.deepStrictEqual(between(0n, 5n)(-1n), false)
+ * assert.deepStrictEqual(between(0n, 5n)(6n), false)
+ *
+ * @category predicates
+ * @since 2.0.0
+ */
+const between = /*#__PURE__*/Order_dist_effectOrder.between(Order);
+
+/**
+ * Restricts the given `bigint` to be within the range specified by the `minimum` and `maximum` values.
+ *
+ * - If the `bigint` is less than the `minimum` value, the function returns the `minimum` value.
+ * - If the `bigint` is greater than the `maximum` value, the function returns the `maximum` value.
+ * - Otherwise, it returns the original `bigint`.
+ *
+ * @param self - The `bigint` to be clamped.
+ * @param minimum - The lower end of the range.
+ * @param maximum - The upper end of the range.
+ *
+ * @example
+ * import { clamp } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(clamp(0n, 5n)(3n), 3n)
+ * assert.deepStrictEqual(clamp(0n, 5n)(-1n), 0n)
+ * assert.deepStrictEqual(clamp(0n, 5n)(6n), 5n)
+ *
+ * @since 2.0.0
+ */
+const clamp = /*#__PURE__*/Order_dist_effectOrder.clamp(Order);
+
+/**
+ * Returns the minimum between two `bigint`s.
+ *
+ * @param self - The first `bigint`.
+ * @param that - The second `bigint`.
+ *
+ * @example
+ * import { min } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(min(2n, 3n), 2n)
+ *
+ * @since 2.0.0
+ */
+const min = /*#__PURE__*/Order_dist_effectOrder.min(Order);
+
+/**
+ * Returns the maximum between two `bigint`s.
+ *
+ * @param self - The first `bigint`.
+ * @param that - The second `bigint`.
+ *
+ * @example
+ * import { max } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(max(2n, 3n), 3n)
+ *
+ * @since 2.0.0
+ */
+const max = /*#__PURE__*/Order_dist_effectOrder.max(Order);
+
+/**
+ * Determines the sign of a given `bigint`.
+ *
+ * @param n - The `bigint` to determine the sign of.
+ *
+ * @example
+ * import { sign } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(sign(-5n), -1)
+ * assert.deepStrictEqual(sign(0n), 0)
+ * assert.deepStrictEqual(sign(5n), 1)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sign = n => Order(n, 0n);
+
+/**
+ * Takes an `Iterable` of `bigint`s and returns their sum as a single `bigint
+ *
+ * @param collection - The collection of `bigint`s to sum.
+ *
+ * @example
+ * import { sumAll } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(sumAll([2n, 3n, 4n]), 9n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const sumAll = collection => {
+  let out = 0n;
+  for (const n of collection) {
+    out += n;
+  }
+  return out;
+};
+
+/**
+ * Takes an `Iterable` of `bigint`s and returns their multiplication as a single `number`.
+ *
+ * @param collection - The collection of `bigint`s to multiply.
+ *
+ * @example
+ * import { multiplyAll } from 'effect/Bigint'
+ *
+ * assert.deepStrictEqual(multiplyAll([2n, 3n, 4n]), 24n)
+ *
+ * @category math
+ * @since 2.0.0
+ */
+const multiplyAll = collection => {
+  let out = 1n;
+  for (const n of collection) {
+    if (n === 0n) {
+      return 0n;
+    }
+    out *= n;
+  }
+  return out;
+};
+
+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.isBigint = isBigint;
+exports.lessThan = lessThan;
+exports.lessThanOrEqualTo = lessThanOrEqualTo;
+exports.max = max;
+exports.min = min;
+exports.multiply = multiply;
+exports.multiplyAll = multiplyAll;
+exports.sign = sign;
+exports.subtract = subtract;
+exports.sum = sum;
+exports.sumAll = sumAll;