Add buffer getters and setters to binary.js

[Pisces] / numeric.js

diff --git a/numeric.js b/numeric.js
index 02ca876477a7a01f7dc1bfb6c1e542a0a92eeaf6..5a3d6ea0a9f8259d2df6374e56f31832739a8e7e 100644 (file)
--- a/numeric.js
+++ b/numeric.js
@@ -21,49 +21,49 @@ export const {
   /**
    * ln(10).
    *
   /**
    * ln(10).
    *

-   * ※ This is an alias for Math.LN10.
+   * ※ This is an alias for `Math.LN10`.

    */
   LN10,
 
   /**
    * ln(2).
    *
    */
   LN10,
 
   /**
    * ln(2).
    *

-   * ※ This is an alias for Math.LN2.
+   * ※ This is an alias for `Math.LN2`.

    */
   LN2,
 
   /**
    * log10(ℇ).
    *
    */
   LN2,
 
   /**
    * log10(ℇ).
    *

-   * ※ This is an alias for Math.LOG10E.
+   * ※ This is an alias for `Math.LOG10E`.

    */
   LOG10E: LOG10ℇ,
 
   /**
    * log2(ℇ).
    *
    */
   LOG10E: LOG10ℇ,
 
   /**
    * log2(ℇ).
    *

-   * ※ This is an alias for Math.LOG2E.
+   * ※ This is an alias for `Math.LOG2E`.

    */
   LOG2E: LOG2ℇ,
 
   /**
    */
   LOG2E: LOG2ℇ,
 
   /**

-   * sqrt(.5).
+   * sqrt(½).

    *
    *

-   * ※ This is an alias for Math.SQRT1_2.
+   * ※ This is an alias for `Math.SQRT1_2`.

    */
   SQRT1_2: RECIPROCAL_SQRT2,
 
   /**
    * sqrt(2).
    *
    */
   SQRT1_2: RECIPROCAL_SQRT2,
 
   /**
    * sqrt(2).
    *

-   * ※ This is an alias for Math.SQRT2.
+   * ※ This is an alias for `Math.SQRT2`.

    */
   SQRT2,
 
   /**
    * Returns the arccos of the provided value.
    *
    */
   SQRT2,
 
   /**
    * Returns the arccos of the provided value.
    *

-   * ※ This is an alias for Math.acos.
+   * ※ This is an alias for `Math.acos`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -72,7 +72,7 @@ export const {
   /**
    * Returns the arccosh of the provided value.
    *
   /**
    * Returns the arccosh of the provided value.
    *

-   * ※ This is an alias for Math.acosh.
+   * ※ This is an alias for `Math.acosh`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -81,7 +81,7 @@ export const {
   /**
    * Returns the arcsin of the provided value.
    *
   /**
    * Returns the arcsin of the provided value.
    *

-   * ※ This is an alias for Math.asin.
+   * ※ This is an alias for `Math.asin`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -90,7 +90,7 @@ export const {
   /**
    * Returns the arcsinh of the provided value.
    *
   /**
    * Returns the arcsinh of the provided value.
    *

-   * ※ This is an alias for Math.asinh.
+   * ※ This is an alias for `Math.asinh`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -99,7 +99,7 @@ export const {
   /**
    * Returns the arctan of the provided value.
    *
   /**
    * Returns the arctan of the provided value.
    *

-   * ※ This is an alias for Math.atan.
+   * ※ This is an alias for `Math.atan`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -108,7 +108,7 @@ export const {
   /**
    * Returns the arctanh of the provided value.
    *
   /**
    * Returns the arctanh of the provided value.
    *

-   * ※ This is an alias for Math.atanh.
+   * ※ This is an alias for `Math.atanh`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -117,7 +117,7 @@ export const {
   /**
    * Returns the cube root of the provided value.
    *
   /**
    * Returns the cube root of the provided value.
    *

-   * ※ This is an alias for Math.cbrt.
+   * ※ This is an alias for `Math.cbrt`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -126,7 +126,7 @@ export const {
   /**
    * Returns the ceiling of the provided value.
    *
   /**
    * Returns the ceiling of the provided value.
    *

-   * ※ This is an alias for Math.ceil.
+   * ※ This is an alias for `Math.ceil`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -135,7 +135,7 @@ export const {
   /**
    * Returns the cos of the provided value.
    *
   /**
    * Returns the cos of the provided value.
    *

-   * ※ This is an alias for Math.cos.
+   * ※ This is an alias for `Math.cos`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -144,7 +144,7 @@ export const {
   /**
    * Returns the cosh of the provided value.
    *
   /**
    * Returns the cosh of the provided value.
    *

-   * ※ This is an alias for Math.cosh.
+   * ※ This is an alias for `Math.cosh`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -153,7 +153,7 @@ export const {
   /**
    * Returns the Euler number raised to the provided value.
    *
   /**
    * Returns the Euler number raised to the provided value.
    *

-   * ※ This is an alias for Math.exp.
+   * ※ This is an alias for `Math.exp`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -162,7 +162,7 @@ export const {
   /**
    * Returns the Euler number raised to the provided value, minus one.
    *
   /**
    * Returns the Euler number raised to the provided value, minus one.
    *

-   * ※ This is an alias for Math.expm1.
+   * ※ This is an alias for `Math.expm1`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -171,7 +171,7 @@ export const {
   /**
    * Returns the floor of the provided value.
    *
   /**
    * Returns the floor of the provided value.
    *

-   * ※ This is an alias for Math.floor.
+   * ※ This is an alias for `Math.floor`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -181,7 +181,7 @@ export const {
    * Returns the square root of the sum of the squares of the provided
    * arguments.
    *
    * Returns the square root of the sum of the squares of the provided
    * arguments.
    *

-   * ※ This is an alias for Math.hypot.
+   * ※ This is an alias for `Math.hypot`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -190,7 +190,7 @@ export const {
   /**
    * Returns the ln of the provided value.
    *
   /**
    * Returns the ln of the provided value.
    *

-   * ※ This is an alias for Math.log.
+   * ※ This is an alias for `Math.log`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -199,7 +199,7 @@ export const {
   /**
    * Returns the log10 of the provided value.
    *
   /**
    * Returns the log10 of the provided value.
    *

-   * ※ This is an alias for Math.log10.
+   * ※ This is an alias for `Math.log10`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -208,7 +208,7 @@ export const {
   /**
    * Returns the ln of one plus the provided value.
    *
   /**
    * Returns the ln of one plus the provided value.
    *

-   * ※ This is an alias for Math.log1p.
+   * ※ This is an alias for `Math.log1p`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -217,7 +217,7 @@ export const {
   /**
    * Returns the log2 of the provided value.
    *
   /**
    * Returns the log2 of the provided value.
    *

-   * ※ This is an alias for Math.log2.
+   * ※ This is an alias for `Math.log2`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -226,14 +226,14 @@ export const {
   /**
    * Returns a pseudo·random value in the range [0, 1).
    *
   /**
    * Returns a pseudo·random value in the range [0, 1).
    *

-   * ※ This is an alias for Math.random.
+   * ※ This is an alias for `Math.random`.

    */
   random: rand,
 
   /**
    * Returns the round of the provided value.
    *
    */
   random: rand,
 
   /**
    * Returns the round of the provided value.
    *

-   * ※ This is an alias for Math.round.
+   * ※ This is an alias for `Math.round`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -242,7 +242,7 @@ export const {
   /**
    * Returns the sinh of the provided value.
    *
   /**
    * Returns the sinh of the provided value.
    *

-   * ※ This is an alias for Math.sinh.
+   * ※ This is an alias for `Math.sinh`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -251,7 +251,7 @@ export const {
   /**
    * Returns the square root of the provided value.
    *
   /**
    * Returns the square root of the provided value.
    *

-   * ※ This is an alias for Math.sqrt.
+   * ※ This is an alias for `Math.sqrt`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -260,7 +260,7 @@ export const {
   /**
    * Returns the tan of the provided value.
    *
   /**
    * Returns the tan of the provided value.
    *

-   * ※ This is an alias for Math.tan.
+   * ※ This is an alias for `Math.tan`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -269,7 +269,7 @@ export const {
   /**
    * Returns the tanh of the provided value.
    *
   /**
    * Returns the tanh of the provided value.
    *

-   * ※ This is an alias for Math.tanh.
+   * ※ This is an alias for `Math.tanh`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -278,7 +278,7 @@ export const {
   /**
    * Returns the trunc of the provided value.
    *
   /**
    * Returns the trunc of the provided value.
    *

-   * ※ This is an alias for Math.trunc.
+   * ※ This is an alias for `Math.trunc`.

    *
    * ☡ This function does not allow big·int arguments.
    */
    *
    * ☡ This function does not allow big·int arguments.
    */


@@ -287,14 +287,14 @@ export const {
   /**
    * The mathematical constant π.
    *
   /**
    * The mathematical constant π.
    *

-   * ※ This is an alias for Math.PI.
+   * ※ This is an alias for `Math.PI`.

    */
   PI: Π,
 
   /**
    * The Euler number.
    *
    */
   PI: Π,
 
   /**
    * The Euler number.
    *

-   * ※ This is an alias for Math.E.
+   * ※ This is an alias for `Math.E`.

    */
   E: ℇ,
 } = Math;
    */
   E: ℇ,
 } = Math;


@@ -303,84 +303,84 @@ export const {
   /**
    * The largest number value less than infinity.
    *
   /**
    * The largest number value less than infinity.
    *

-   * ※ This is an alias for Number.MAX_VALUE.
+   * ※ This is an alias for `Number.MAX_VALUE`.

    */
   MAX_VALUE: MAXIMUM_NUMBER,
 
   /**
    * 2**53 - 1.
    *
    */
   MAX_VALUE: MAXIMUM_NUMBER,
 
   /**
    * 2**53 - 1.
    *

-   * ※ This is an alias for Number.MAX_SAFE_INTEGER.
+   * ※ This is an alias for `Number.MAX_SAFE_INTEGER`.

    */
   MAX_SAFE_INTEGER: MAXIMUM_SAFE_INTEGRAL_NUMBER,
 
   /**
    * The smallest number value greater than negative infinity.
    *
    */
   MAX_SAFE_INTEGER: MAXIMUM_SAFE_INTEGRAL_NUMBER,
 
   /**
    * The smallest number value greater than negative infinity.
    *

-   * ※ This is an alias for Number.MIN_VALUE.
+   * ※ This is an alias for `Number.MIN_VALUE`.

    */
   MIN_VALUE: MINIMUM_NUMBER,
 
   /**
    * -(2**53 - 1).
    *
    */
   MIN_VALUE: MINIMUM_NUMBER,
 
   /**
    * -(2**53 - 1).
    *

-   * ※ This is an alias for Number.MIN_SAFE_INTEGER.
+   * ※ This is an alias for `Number.MIN_SAFE_INTEGER`.

    */
   MIN_SAFE_INTEGER: MINIMUM_SAFE_INTEGRAL_NUMBER,
 
   /**
    * Negative infinity.
    *
    */
   MIN_SAFE_INTEGER: MINIMUM_SAFE_INTEGRAL_NUMBER,
 
   /**
    * Negative infinity.
    *

-   * ※ This is an alias for Number.NEGATIVE_INFINITY.
+   * ※ This is an alias for `Number.NEGATIVE_INFINITY`.

    */
   NEGATIVE_INFINITY,
 
   /**
    * Nan.
    *
    */
   NEGATIVE_INFINITY,
 
   /**
    * Nan.
    *

-   * ※ This is an alias for Number.NaN.
+   * ※ This is an alias for `Number.NaN`.

    */
   NaN: NAN,
 
   /**
    * Positive infinity.
    *
    */
   NaN: NAN,
 
   /**
    * Positive infinity.
    *

-   * ※ This is an alias for Number.POSITIVE_INFINITY.
+   * ※ This is an alias for `Number.POSITIVE_INFINITY`.

    */
   POSITIVE_INFINITY,
 
   /**
    * The difference between 1 and the smallest number greater than 1.
    *
    */
   POSITIVE_INFINITY,
 
   /**
    * The difference between 1 and the smallest number greater than 1.
    *

-   * ※ This is an alias for Number.EPSILON.
+   * ※ This is an alias for `Number.EPSILON`.

    */
   EPSILON: Ε,
 
   /**
    * Returns whether the provided value is a finite number.
    *
    */
   EPSILON: Ε,
 
   /**
    * Returns whether the provided value is a finite number.
    *

-   * ※ This is an alias for Number.isFinite.
+   * ※ This is an alias for `Number.isFinite`.

    */
   isFinite: isFiniteNumber,
 
   /**
    * Returns whether the provided value is an integral number.
    *
    */
   isFinite: isFiniteNumber,
 
   /**
    * Returns whether the provided value is an integral number.
    *

-   * ※ This is an alias for Number.isInteger.
+   * ※ This is an alias for `Number.isInteger`.

    */
   isInteger: isIntegralNumber,
 
   /**
    * Returns whether the provided value is nan.
    *
    */
   isInteger: isIntegralNumber,
 
   /**
    * Returns whether the provided value is nan.
    *

-   * ※ This is an alias for Number.isNaN.
+   * ※ This is an alias for `Number.isNaN`.

    */
   isNaN: isNan,
 
   /**
    * Returns whether the provided value is a safe integral number.
    *
    */
   isNaN: isNan,
 
   /**
    * Returns whether the provided value is a safe integral number.
    *

-   * ※ This is an alias for Number.isSafeInteger.
+   * ※ This is an alias for `Number.isSafeInteger`.

    */
   isSafeInteger: isSafeIntegralNumber,
 } = Number;
    */
   isSafeInteger: isSafeIntegralNumber,
 } = Number;


@@ -394,7 +394,7 @@ export const NEGATIVE_ZERO = -0;
 /**
  * Returns the magnitude (absolute value) of the provided value.
  *
 /**
  * Returns the magnitude (absolute value) of the provided value.
  *

- * ※ Unlike Math.abs, this function can take big·int arguments.
+ * ※ Unlike `Math.abs`, this function can take big·int arguments.

  */
 export const abs = ($) => {
   const n = toNumeric($);
  */
 export const abs = ($) => {
   const n = toNumeric($);


@@ -415,17 +415,17 @@ export const {
   /**
    * Returns the arctangent of the dividend of the provided values.
    *
   /**
    * Returns the arctangent of the dividend of the provided values.
    *

-   * ※ Unlike Math.atan2, this function can take big·int arguments.
+   * ※ Unlike `Math.atan2`, this function can take big·int arguments.

    * However, the result will always be a number.
    */
   atan2,
 
   /**
    * However, the result will always be a number.
    */
   atan2,
 
   /**

-   * Returns the number of leading zeroes in the 32‐bit representation of
-   * the provided value.
+   * Returns the number of leading zeroes in the 32‐bit representation
+   * of the provided value.

    *
    *

-   * ※ Unlike Math.clz32, this function accepts either number or big·int
-   * values.
+   * ※ Unlike `Math.clz32`, this function accepts either number or
+   * big·int values.

    */
   clz32,
 
    */
   clz32,
 


@@ -433,7 +433,7 @@ export const {
    * Returns the 32‐bit float which best approximate the provided
    * value.
    *
    * Returns the 32‐bit float which best approximate the provided
    * value.
    *

-   * ※ Unlike Math.fround, this function can take big·int arguments.
+   * ※ Unlike `Math.fround`, this function can take big·int arguments.

    * However, the result will always be a number.
    */
   toFloat32,
    * However, the result will always be a number.
    */
   toFloat32,


@@ -457,7 +457,7 @@ export const {
  * Returns the highest value of the provided arguments, or negative
  * infinity if no argument is provided.
  *
  * Returns the highest value of the provided arguments, or negative
  * infinity if no argument is provided.
  *

- * ※ Unlike Math.max, this function accepts either number or big·int
+ * ※ Unlike `Math.max`, this function accepts either number or big·int

  * values. All values must be of the same type, or this function will
  * throw an error.
  *
  * values. All values must be of the same type, or this function will
  * throw an error.
  *


@@ -506,7 +506,7 @@ export const max = (...$s) => {
  * Returns the lowest value of the provided arguments, or positive
  * infinity if no argument is provided.
  *
  * Returns the lowest value of the provided arguments, or positive
  * infinity if no argument is provided.
  *

- * ※ Unlike Math.min, this function accepts either number or big·int
+ * ※ Unlike `Math.min`, this function accepts either number or big·int

  * values. All values must be of the same type, or this function will
  * throw an error.
  *
  * values. All values must be of the same type, or this function will
  * throw an error.
  *


@@ -558,17 +558,17 @@ export const min = (...$s) => {
  * signed) zero.
  *
  * For big·ints, the return value of this function is 0n if the
  * signed) zero.
  *
  * For big·ints, the return value of this function is 0n if the

- * provided value is 0n, -1n if the provided value is negative, and +1n
+ * provided value is 0n, −1n if the provided value is negative, and +1n

  * otherwise.
  *
  * otherwise.
  *

- * For numbers, the return value is nan, -0, or +0 if the provided
- * value is nan, -0, or +0, respectively, and -1 if the provided value
+ * For numbers, the return value is nan, −0, or +0 if the provided
+ * value is nan, −0, or +0, respectively, and −1 if the provided value

  * is negative and +1 if the provided value is positive otherwise. Note
  * is negative and +1 if the provided value is positive otherwise. Note

- * that positive and negative infinity will return +1 and -1
+ * that positive and negative infinity will return +1 and −1

  * respectively.
  *
  * respectively.
  *

- * ※ Unlike Math.sign, this function accepts either number or big·int
- * values.
+ * ※ Unlike `Math.sign`, this function accepts either number or
+ * big·int values.

  */
 export const sgn = ($) => {
   const n = toNumeric($);
  */
 export const sgn = ($) => {
   const n = toNumeric($);


@@ -587,7 +587,7 @@ export const sgn = ($) => {
  *
  * ※ This method is safe to use with numbers.
  *
  *
  * ※ This method is safe to use with numbers.
  *

- * ※ This is effectively an alias for BigInt.
+ * ※ This is effectively an alias for `BigInt`.

  */
 export const { toBigInt } = (() => {
   const makeBigInt = BigInt;
  */
 export const { toBigInt } = (() => {
   const makeBigInt = BigInt;


@@ -724,7 +724,7 @@ export const toIntegralNumberOrInfinity = ($) => {
  *
  * ※ This function is safe to use with big·ints.
  *
  *
  * ※ This function is safe to use with big·ints.
  *

- * ※ This is effectively a nonconstructible version of the Number
+ * ※ This is effectively a nonconstructible version of the `Number`

  * constructor.
  */
 export const { toNumber } = (() => {
  * constructor.
  */
 export const { toNumber } = (() => {


@@ -749,7 +749,7 @@ export const {
    * Returns the result of converting the provided value to fit within
    * the provided number of bits as a signed integer.
    *
    * Returns the result of converting the provided value to fit within
    * the provided number of bits as a signed integer.
    *

-   * ※ Unlike BigInt.asIntN, this function accepts both big·int and
+   * ※ Unlike `BigInt.asIntN`, this function accepts both big·int and

    * number values.
    *
    * ☡ The first argument, the number of bits, must be a number.
    * number values.
    *
    * ☡ The first argument, the number of bits, must be a number.


@@ -760,7 +760,7 @@ export const {
    * Returns the result of converting the provided value to fit within
    * the provided number of bits as an unsigned integer.
    *
    * Returns the result of converting the provided value to fit within
    * the provided number of bits as an unsigned integer.
    *

-   * ※ Unlike BigInt.asUintN, this function accepts both big·int and
+   * ※ Unlike `BigInt.asUintN`, this function accepts both big·int and

    * number values.
    *
    * ☡ The first argument, the number of bits, must be a number.
    * number values.
    *
    * ☡ The first argument, the number of bits, must be a number.