@numio/bigmath 2.3.1 → 2.4.0

package/CHANGELOG.md

@@ -1,9 +1,15 @@
+### 2.4.0
+Add Mod - Modulo operation, which finds the remainder when one number is divided by another
+
+### 2.3.2
+FDR - change variable name to make it consistent
+
 ### 2.3.1
 Fix import
 
 ### 2.2.8
-Better error handling
-Add FDR - Freedman-Diaconis Rule
+Better error handling \
+Add FDR - Freedman-Diaconis Rule \
 MAD - median of the absolute deviations from `median` or `mean`
 
 ### 2.2.7
@@ -13,48 +19,48 @@ Throw an error if input is not valid. In the error show exact invalid input.
 Optimize performance for small numbers (add operation)
 
 ### 2.2.5
-Handle "0B", "0X", "0O", "-0B", "-0X", "-0O" as a start of the input for toBase function.
+Handle "0B", "0X", "0O", "-0B", "-0X", "-0O" as a start of the input for toBase function. \
 Move documentation from README.md to web-site http://numio.deno.dev
 
 ### 2.2.4
 Fix handling negative numbers for toBase function.
 
 ### 2.2.3
-Add validation for negative number input in square root function
+Add validation for negative number input in square root function \
 Add validation for negative number input in cube root function
 
 ### 2.2.2
-Throw an error if input for MAD and IQR is less than 3 elements
+Throw an error if input for MAD and IQR is less than 3 elements \
 Add home-page url
 
 ### 2.2.1
 Add Number format validation examples (README.md)
 
 ### 2.2.0
-Added `isHex(str: string): boolean` - Checks if a string is a valid hexadecimal number (prefixed with `0x` or `-0x`).
-Added `isBinary(str: string): boolean` - Checks if a string is a valid binary number (prefixed with `0b` or `-0b`).
-Added `isDecimal(str: string): boolean` - Checks if a string is a valid decimal number.
-Added `isOctal(str: string): boolean` - Checks if a string is a valid octal number (prefixed with `0o` or `-0o`).
+Added `isHex(str: string): boolean` - Checks if a string is a valid hexadecimal number (prefixed with `0x` or `-0x`). \
+Added `isBinary(str: string): boolean` - Checks if a string is a valid binary number (prefixed with `0b` or `-0b`). \
+Added `isDecimal(str: string): boolean` - Checks if a string is a valid decimal number. \
+Added `isOctal(str: string): boolean` - Checks if a string is a valid octal number (prefixed with `0o` or `-0o`). \
 Added `isNumber(str: string): boolean` - Checks if a string is a valid number in any of the formats supported by the library (decimal, hexadecimal, binary, octal).
 
 ### 2.1.3
 Optimize performance for small numbers
 
 ### 2.1.2
-Renamed main.ts files
-Changed import path in test files
+Renamed main.ts files \
+Changed import path in test files \
 Change build config - run test on JSR and NPM versions
 
 ### 2.1.1
 Fixed lib crash (NPM version)
 
 ### 2.1.0 
-Added `toBase` - convert number to another base
-Added `abs` - absolute value
-Added `isLeftGreaterOrEqual` - Is the left-hand side value greater than or equal to the right-hand side value
+Added `toBase` - convert number to another base \
+Added `abs` - absolute value \
+Added `isLeftGreaterOrEqual` - Is the left-hand side value greater \ than or equal to the right-hand side value \
 Added `cbrt` - cube root of a number
 
-Added `Pipe().abs` - absolute value in pipe
+Added `Pipe().abs` - absolute value in pipe \
 Added `Pipe().resultToBase` - convert number to another base in pipe
 
 ### 2.0.0

package/README.md

@@ -5,11 +5,10 @@
 
 ## Latest Update
 
-This update introduces several enhancements and new functionalities:
+This update introduces new functionalities:
 
-- **Improved Error Handling:** The application now features more robust error handling to provide clearer feedback and prevent unexpected crashes.
-- **Freedman-Diaconis Rule (FDR):** Added the Freedman-Diaconis rule for optimal binwidth estimation in histogram creation.
-- **Median Absolute Deviation (MAD):** Implemented calculation for the Median Absolute Deviation, allowing users to compute it based on either the `median` or the `mean` of the dataset.
+* **Modulo Operation (`mod`):** A new `mod` function has been added for performing modulo operations.
+* **Pipe Function Enhancement:** The `mod` function has been integrated into the `Pipe` function for seamless chaining of operations.
 
 ## Existing Functionality
 
@@ -32,6 +31,7 @@ The application currently supports the following operations:
     - `min`: Finding the minimum value in a dataset.
     - `MAD`: Calculating the Median Absolute Deviation (based on either median or mean).
     - `IQR`: Calculating the Interquartile Range.
+    - `FDR`: Freedman-Diaconis rule
 - **Comparison:**
     - `isEqual`: Checking if two values are equal.
     - `isLeftGreater`: Checking if the left value is greater than the right value.
@@ -40,6 +40,7 @@ The application currently supports the following operations:
     - `sqrt`: Calculating the square root of a number.
     - `cbrt`: Calculating the cube root of a number.
     - `abs`: Calculating the absolute value of a number.
+    - `mod`: Modulo operation, which finds the remainder when one number is divided by another
 - **Number Base Conversion:**
     - `toBase`: Converting a number to a specified base.
     - `isHex`: Checking if a string is a valid hexadecimal number.

package/index.d.ts

@@ -24,4 +24,5 @@ import { isDecimal } from "./src/isValid/isDecimal.d.ts";
 import { isOctal } from "./src/isValid/isOctal.d.ts";
 import { isNumber } from "./src/isValid/isNumber.d.ts";
 import { FDR } from "./src/FDR/fdr.d.ts";
-export { abs, add, cbrt, div, IQR, isEqual, isLeftGreater, isLeftGreaterOrEqual, MAD, max, mean, min, mul, Pipe, quartile, round, sort, sqrt, sub, toBase, isHex, isBinary, isDecimal, isOctal, isNumber, FDR };
+import { mod } from "./src/mod/mod.d.ts";
+export { abs, add, cbrt, div, IQR, isEqual, isLeftGreater, isLeftGreaterOrEqual, MAD, max, mean, min, mul, Pipe, quartile, round, sort, sqrt, sub, toBase, isHex, isBinary, isDecimal, isOctal, isNumber, FDR, mod };

package/index.js

@@ -24,4 +24,5 @@ import { isDecimal } from "./src/isValid/isDecimal.js";
 import { isOctal } from "./src/isValid/isOctal.js";
 import { isNumber } from "./src/isValid/isNumber.js";
 import { FDR } from "./src/FDR/fdr.js";
-export { abs, add, cbrt, div, IQR, isEqual, isLeftGreater, isLeftGreaterOrEqual, MAD, max, mean, min, mul, Pipe, quartile, round, sort, sqrt, sub, toBase, isHex, isBinary, isDecimal, isOctal, isNumber, FDR };
+import { mod } from "./src/mod/mod.js";
+export { abs, add, cbrt, div, IQR, isEqual, isLeftGreater, isLeftGreaterOrEqual, MAD, max, mean, min, mul, Pipe, quartile, round, sort, sqrt, sub, toBase, isHex, isBinary, isDecimal, isOctal, isNumber, FDR, mod };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@numio/bigmath",
   "description": "@numio/bigmath is an arbitrary-precision arithmetic library. It can be used for basic operations with decimal numbers (integers and float)",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "keywords": [
     "precision",
     "arithmetic",
@@ -54,7 +54,8 @@
     "binary",
     "cube root",
     "FDR",
-    "Freedman-Diaconis Rule"
+    "Freedman-Diaconis Rule",
+    "mod"
   ],
   "repository": {
     "type": "git",

package/src/FDR/fdr.js

@@ -6,13 +6,13 @@ export const FDR = (array, options) => {
     for (let i = 0; i < array.length; i++) {
         arrayInner[i] = s2bi(array[i]);
     }
-    const { binWidth, binsNum } = fdrInner(arrayInner, {
+    const { binWidth, binNum } = fdrInner(arrayInner, {
         useMadAbove: (_a = options === null || options === void 0 ? void 0 : options.useMadAbove) !== null && _a !== void 0 ? _a : 0,
         maxBinNumber: (_b = options === null || options === void 0 ? void 0 : options.maxBinNumber) !== null && _b !== void 0 ? _b : 90,
         madFrom: (_c = options === null || options === void 0 ? void 0 : options.madFrom) !== null && _c !== void 0 ? _c : "median",
     });
     return {
-        binsNum: bi2s(binsNum),
+        binNum: bi2s(binNum),
         binWidth: bi2s(binWidth),
     };
 };

package/src/FDR/types.d.ts

@@ -12,10 +12,10 @@ type OptionsInner = {
 };
 export type FDRInner = (array: BI[], options: OptionsInner) => {
     binWidth: BI;
-    binsNum: BI;
+    binNum: BI;
 };
 export type TFDR = (array: string[], options?: Options) => {
     binWidth: string;
-    binsNum: string;
+    binNum: string;
 };
 export {};

package/src/FDR/utils.js

@@ -6,11 +6,11 @@ import { divInner } from "../operations/div/utils.js";
 import { PipeInner } from "../pipe/utils.js";
 import { tryBigInt } from "../shared/utils.js";
 const getBinsNum = (range, binWidth) => {
-    let binsNum = new PipeInner().div([range, binWidth], 10).bi;
-    if (binsNum[1] > 0) {
-        binsNum = [new PipeInner().div([range, binWidth], 0).bi[0] + 1n, 0];
+    let binNum = new PipeInner().div([range, binWidth], 10).bi;
+    if (binNum[1] > 0) {
+        binNum = [new PipeInner().div([range, binWidth], 0).bi[0] + 1n, 0];
     }
-    return binsNum;
+    return binNum;
 };
 export const fdrInner = (array, options = { useMadAbove: 0, maxBinNumber: 90, madFrom: "mean" }) => {
     const mad = MADInner(array, { from: options.madFrom });
@@ -21,14 +21,14 @@ export const fdrInner = (array, options = { useMadAbove: 0, maxBinNumber: 90, ma
     const [cbrtLen] = cbrtInner([tryBigInt(array.length), 0]);
     const binWidth = new PipeInner().mul([[2n, 0], validIQR]).div([cbrtLen]).bi;
     const range = new PipeInner().sub([array[array.length - 1], array[0]]).bi;
-    const binsNum = getBinsNum(range, binWidth);
+    const binNum = getBinsNum(range, binWidth);
     const maxBinNum = [tryBigInt(options.maxBinNumber), 0];
-    const scale = isLeftGreaterOrEqualInner({ left: binsNum, right: maxBinNum })
-        ? divInner([binsNum, maxBinNum], 20)
+    const scale = isLeftGreaterOrEqualInner({ left: binNum, right: maxBinNum })
+        ? divInner([binNum, maxBinNum], 20)
         : [1n, 0];
     const scaledBinWidth = new PipeInner().mul([binWidth, scale]).bi;
     return {
         binWidth: scaledBinWidth,
-        binsNum: getBinsNum(range, scaledBinWidth),
+        binNum: getBinsNum(range, scaledBinWidth),
     };
 };

package/src/mod/mod.d.ts

@@ -0,0 +1,2 @@
+import type { Mod } from "./types.d.ts";
+export declare const mod: Mod;

package/src/mod/mod.js

@@ -0,0 +1,6 @@
+import { bi2s, s2bi } from "../shared/utils.js";
+import { modInner } from "./utils.js";
+export const mod = (left, right, options = { precision: 20 }) => {
+    const bi = modInner(s2bi(left), s2bi(right), options);
+    return bi2s(bi);
+};

package/src/mod/types.d.ts

@@ -0,0 +1,6 @@
+import type { BI } from "../shared/types.d.ts";
+export type ModOptions = {
+    precision: number;
+};
+export type Mod = (left: string, right: string, options?: ModOptions) => string;
+export type ModInner = (left: BI, right: BI, options: ModOptions) => BI;

package/src/mod/utils.d.ts

@@ -0,0 +1,2 @@
+import type { ModInner } from "./types.d.ts";
+export declare const modInner: ModInner;

package/src/mod/utils.js

@@ -0,0 +1,6 @@
+import { divInner } from "../operations/div/utils.js";
+import { tryBigInt } from "../shared/utils.js";
+export const modInner = (left, right, { precision }) => {
+    const bi = divInner([left, right], precision);
+    return bi[1] === 0 ? [0n, 0] : [bi[0] % (10n ** tryBigInt(bi[1])), 0];
+};

package/src/operations/add/add.js

@@ -1,4 +1,4 @@
-import { bi2s, calcInner, s2bi, tryBigInt, tryNumber } from "../../shared/utils.js";
+import { bi2s, calcInner, s2bi, tryBigInt, tryNumber, } from "../../shared/utils.js";
 const MAX_SUM = 8e+15;
 const MIN_SUM = 8e-15;
 /** This function adds numbers (as string). */

package/src/pipe/pipe.d.ts

@@ -1,4 +1,5 @@
 import type { BI2S } from "../shared/types.d.ts";
+import type { ModOptions } from "../mod/types.d.ts";
 /** Using this function you can chain operations (add, sub, div, mul). */
 export declare class Pipe {
     #private;
@@ -8,6 +9,7 @@ export declare class Pipe {
     div(array: string[], precision?: number): Pipe;
     mul(array: string[]): Pipe;
     abs(): Pipe;
+    mod(value: string, options?: ModOptions): Pipe;
     calc(): ReturnType<BI2S>;
     resultToBase(radix: number): string;
 }

package/src/pipe/pipe.js

@@ -13,6 +13,7 @@ var _Pipe_result;
 import { bi2s, calcInner, s2bi } from "../shared/utils.js";
 import { divInner } from "../operations/div/utils.js";
 import { absInner } from "../abs/utils.js";
+import { modInner } from "../mod/utils.js";
 /** Using this function you can chain operations (add, sub, div, mul). */
 export class Pipe {
     constructor(value) {
@@ -46,6 +47,13 @@ export class Pipe {
         __classPrivateFieldSet(this, _Pipe_result, absInner(__classPrivateFieldGet(this, _Pipe_result, "f")), "f");
         return this;
     }
+    mod(value, options = { precision: 20 }) {
+        if (!__classPrivateFieldGet(this, _Pipe_result, "f")) {
+            throw new Error("Value is undefined.");
+        }
+        __classPrivateFieldSet(this, _Pipe_result, modInner(__classPrivateFieldGet(this, _Pipe_result, "f"), s2bi(value), options), "f");
+        return this;
+    }
     calc() {
         if (!__classPrivateFieldGet(this, _Pipe_result, "f")) {
             throw new Error("Cannot calculate based on an undefined input.");

package/src/shared/types.d.ts

@@ -1,4 +1,5 @@
 export type BI = [bigint, number];
+export type Input = string[];
 export type FillHead = (len: number, fpe: number, isNeg: boolean, hasBefore: boolean) => string;
 export type TrimTail = (str: string) => string;
 export type CalcInner = (array: BI[], op: (a: bigint, b: bigint) => bigint, def?: BI) => BI;