@numio/bigmath 2.3.2 → 2.4.0

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 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
 

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.2",
+  "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/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;