@numio/bigmath 2.2.0 → 2.2.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 2.2.2
+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`).

package/README.md

@@ -23,7 +23,7 @@
 * **Round Based on Significant Figures:** Control rounding based on the number of significant figures, crucial for scientific and engineering applications.
 * **Calculate Roots:**
     * **Calculate Square Root (`sqrt`):** Compute the square root of a number with arbitrary precision. You can also specify the desired precision of the result.
-    * **NEW! Calculate Cube Root (`cbrt`):** Determine the cube root of a number with arbitrary precision, allowing you to specify the desired accuracy.
+    * ****NEW! Calculate Cube Root (`cbrt`):** Determine the cube root of a number with arbitrary precision, allowing you to specify the desired accuracy.
 
 * **Chain Operations with Pipe:** Simplify complex calculations by chaining arithmetic operations in a readable and intuitive manner.
 * **Analyze Data Distribution:**
@@ -33,12 +33,12 @@
 * **Compare Numbers:**
     * **Check for Equality (`isEqual`):** Accurately determine if two arbitrary-precision numbers are equal.
     * **Check if Left is Greater (`isLeftGreater`):** Precisely compare two arbitrary-precision numbers to see if the left operand is greater than the right.
-    * **NEW! Check if Left is Greater or Equal (`isLeftGreaterOrEqual`):** Precisely compare two arbitrary-precision numbers to determine if the left operand is greater than or equal to the right.
+    * ****NEW! Check if Left is Greater or Equal (`isLeftGreaterOrEqual`):** Precisely compare two arbitrary-precision numbers to determine if the left operand is greater than or equal to the right.
 * **Sort Numbers Accurately:** Sort arrays of numbers, including negative and decimal values, in ascending or descending order, correctly handling string representations of numbers that JavaScript's native sort might misinterpret.
 * **Calculate Central Tendency:** Easily compute the mean (average) of a set of numbers.
 * **Identify Extremes:** Find the maximum and minimum values within an array of numbers.
-* **NEW! Calculate Absolute Value (`abs`):** Determine the non-negative value of a number, regardless of its sign.
-* **NEW! Convert Number to Another Base (`toBase`):** Seamlessly convert numbers between decimal, hexadecimal (HEX), binary, and octal representations.
+* ****NEW! Calculate Absolute Value (`abs`):** Determine the non-negative value of a number, regardless of its sign.
+* ****NEW! Convert Number to Another Base (`toBase`):** Seamlessly convert numbers between decimal, hexadecimal (HEX), binary, and octal representations.
 
 ## When is @numio/bigmath essential?
 
@@ -377,6 +377,40 @@ toBase({ value: "0b1101", toBase: 16 }) // d
 toBase({ value: "0o11", toBase: 10 }) // 9
 ```
 
+### Number format validation
+
+```javascript
+import { isHex, isBinary, isDecimal, isOctal, isNumber } from "@numio/bigmath";
+
+console.log(isHex("0x1A")); // true
+console.log(isHex("1A"));    // false (no 0x prefix)
+console.log(isHex("-0x2f")); // true
+console.log(isHex("0xG"));  // false (invalid hex digit)
+
+console.log(isBinary("0b101")); // true
+console.log(isBinary("101"));   // false (no 0b prefix)
+console.log(isBinary("-0b11"));  // true
+console.log(isBinary("0b12"));  // false (invalid binary digit)
+
+console.log(isDecimal("123"));   // true
+console.log(isDecimal("123.45"));// true
+console.log(isDecimal("-0.5"));  // true
+console.log(isDecimal(".5"));   // false (leading dot)
+console.log(isDecimal("10."));  // false (trailing dot)
+
+console.log(isOctal("0o77"));  // true
+console.log(isOctal("77"));    // false (no 0o prefix)
+console.log(isOctal("-0o12")); // true
+console.log(isOctal("0o19"));  // false (invalid octal digit)
+
+console.log(isNumber("0x1A"));  // true (hex)
+console.log(isNumber("0b101")); // true (binary)
+console.log(isNumber("123.45"));// true (decimal)
+console.log(isNumber("0o77"));  // true (octal)
+console.log(isNumber("123"));   // true (decimal)
+console.log(isNumber("abc"));   // false (not a valid number)
+```
+
 Does not have a limitation on the number of digits. You can use any length you'd
 like
 
@@ -397,7 +431,7 @@ Download from NPM - https://www.npmjs.com/package/@numio/bigmath
 
 Download from JSR - https://jsr.io/@numio/bigmath
 
-Home page - https://github.com/shpunter/numio-bigmath/blob/main/README.md
+Home page - https://numio.deno.dev
 
 Change log - https://github.com/shpunter/numio-bigmath/blob/main/CHANGELOG.md
 

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.2.0",
+  "version": "2.2.2",
   "keywords": [
     "precision",
     "arithmetic",
@@ -51,7 +51,8 @@
     "octal",
     "binary",
     "decimal",
-    "binary"
+    "binary",
+    "cube root"
   ],
   "repository": {
     "type": "git",

package/src/IQR/utils.js

@@ -4,6 +4,9 @@ import { PipeInner } from "../pipe/utils.js";
 import { quartileInner } from "../quartile/utils.js";
 export const MIN_LENGTH_FOR_MAD = 30;
 export const IQRInner = (array, sigNum = false) => {
+    if (array.length < 3) {
+        throw Error("To calculate IQR you need at least 3 elements");
+    }
     const { Q1, Q3 } = quartileInner(array);
     const sub = new PipeInner().sub([Q3, Q1]).calc();
     if (sigNum) {

package/src/MAD/utils.js

@@ -3,6 +3,9 @@ import { quartileInner } from "../quartile/utils.js";
 import { ASC } from "../sort/constants.js";
 import { sortInner } from "../sort/utils.js";
 export const MADInner = (array) => {
+    if (array.length < 3) {
+        throw Error("To calculate MAD you need at least 3 elements");
+    }
     const median = quartileInner(array).Q2;
     const madArray = array.map((el) => {
         const [bi, fpe] = new PipeInner().sub([el, median]).calc();