@numio/bigmath 1.0.4 → 1.0.5

package/README.md

@@ -50,7 +50,9 @@ large numbers are essential, such as:
 
 ### Latest update
 
-Added pipe functionality
+Added quartile functionality. When you might need it?
+Understanding Distribution. Quartiles (Q1, Q2, and Q3) split a dataset into four groups, each representing 25% of the data. 
+Identifying Outliers. They help visualize the shape and spread of the data, revealing whether it's skewed or symmetrical. 
 
 # Install:
 
@@ -211,6 +213,16 @@ pipe.add(addNums) // 6
   .calc()
 ```
 
+### Quartile
+```javascript
+import { quartile } from "@numio/bigmath";
+
+quartile(["1", "2", "3", "4", "5", "6", "7", "8", "9"]) // { Q1: "2.5", Q2: "5", Q3: "7.5" }
+quartile(["0.001", "0.3", "0.4", "1"]) // { Q1: "0.1505", Q2: "0.35", Q3: "0.7" }
+
+```
+
+
 Does not have a limitation on the number of digits. You can use any length you'd
 like
 

package/index.d.ts

@@ -1,7 +1,8 @@
-import { add } from "./src/add/index.d.ts";
-import { mul } from "./src/mul/index.d.ts";
-import { sub } from "./src/sub/index.d.ts";
-import { div } from "./src/div/index.d.ts";
+import { add } from "./src/mathOperations/add/index.d.ts";
+import { mul } from "./src/mathOperations/mul/index.d.ts";
+import { sub } from "./src/mathOperations/sub/index.d.ts";
+import { div } from "./src/mathOperations/div/index.d.ts";
 import { round } from "./src/round/index.d.ts";
 import { pipe } from "./src/pipe/main.d.ts";
-export { add, div, mul, round, sub, pipe };
+import { quartile } from "./src/quartile/main.d.ts";
+export { add, div, mul, pipe, quartile, round, sub };

package/index.js

@@ -1,7 +1,8 @@
-import { add } from "./src/add/index.js";
-import { mul } from "./src/mul/index.js";
-import { sub } from "./src/sub/index.js";
-import { div } from "./src/div/index.js";
+import { add } from "./src/mathOperations/add/index.js";
+import { mul } from "./src/mathOperations/mul/index.js";
+import { sub } from "./src/mathOperations/sub/index.js";
+import { div } from "./src/mathOperations/div/index.js";
 import { round } from "./src/round/index.js";
 import { pipe } from "./src/pipe/main.js";
-export { add, div, mul, round, sub, pipe };
+import { quartile } from "./src/quartile/main.js";
+export { add, div, mul, pipe, quartile, round, sub };

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": "1.0.4",
+  "version": "1.0.5",
   "keywords": [
     "precision",
     "arithmetic",
@@ -28,7 +28,12 @@
     "divide",
     "long division",
     "bigmath",
-    "numio"
+    "numio",
+    "quartile",
+    "Q1",
+    "Q2",
+    "Q3",
+    "round"
   ],
   "repository": {
     "type": "git",

package/src/{add → mathOperations/add}/index.js

@@ -1,5 +1,5 @@
-import { DEFAULT } from "../shared/constant.js";
-import { a2s, s2a } from "../shared/utils.js";
+import { DEFAULT } from "../../shared/constant.js";
+import { a2s, s2a } from "../../shared/utils.js";
 import { addRoute } from "./utils.js";
 /** This function adds numbers (as string). */
 export function add(strs) {

package/src/{add → mathOperations/add}/types.d.ts

@@ -1,2 +1,2 @@
-import type { InputData } from "../types.d.ts";
+import type { InputData } from "../../types.d.ts";
 export type Addition = (L: [number[], number], R: [number[], number], isNegative: boolean) => InputData;

package/src/mathOperations/add/utils.d.ts

@@ -0,0 +1,5 @@
+import type { Route } from "../../types.d.ts";
+import type { Addition } from "./types.d.ts";
+/** This function adds 2 numbers (as array). */
+export declare const addition: Addition;
+export declare const addRoute: Route;

package/src/{div → mathOperations/div}/index.js

@@ -1,5 +1,5 @@
-import { DEFAULT } from "../shared/constant.js";
-import { a2s, s2a } from "../shared/utils.js";
+import { DEFAULT } from "../../shared/constant.js";
+import { a2s, s2a } from "../../shared/utils.js";
 import { divRoute } from "./utils.js";
 /** This function should divide numbers (as string). */
 export var div = function (strs, limit) {

package/src/mathOperations/div/types.d.ts

@@ -0,0 +1,3 @@
+import type { InputData } from "../../types.d.ts";
+export type Division = (L: [number[], number], R: [number[], number], isNegative: boolean, initLimit: number) => InputData;
+export type DivRoute = (input: InputData[], initValue: InputData, limit: number) => InputData;

package/src/mathOperations/div/utils.d.ts

@@ -0,0 +1,3 @@
+import type { Division, DivRoute } from "./types.d.ts";
+export declare const division: Division;
+export declare const divRoute: DivRoute;

package/src/{mul → mathOperations/mul}/index.js

@@ -1,5 +1,5 @@
-import { DEFAULT } from "../shared/constant.js";
-import { a2s, s2a } from "../shared/utils.js";
+import { DEFAULT } from "../../shared/constant.js";
+import { a2s, s2a } from "../../shared/utils.js";
 import { mulRoute } from "./utils.js";
 /** This function multiplies numbers (as string). */
 export var mul = function (strs) {

package/src/{mul → mathOperations/mul}/types.d.ts

@@ -1,2 +1,2 @@
-import type { InputData } from "../types.d.ts";
+import type { InputData } from "../../types.d.ts";
 export type Multiplication = (arrL: [number[], number], arrR: [number[], number], isNegative: boolean) => InputData;

package/src/{mul → mathOperations/mul}/utils.d.ts

@@ -1,5 +1,5 @@
-import type { InputData } from "../types.d.ts";
+import type { Route } from "../../types.d.ts";
 import type { Multiplication } from "./types.d.ts";
 /** This function multiplies 2 numbers (as array). */
 export declare const multiplication: Multiplication;
-export declare const mulRoute: (input: InputData[], initValue: InputData) => InputData;
+export declare const mulRoute: Route;

package/src/{sub → mathOperations/sub}/index.js

@@ -1,5 +1,5 @@
-import { DEFAULT } from "../shared/constant.js";
-import { a2s, s2a } from "../shared/utils.js";
+import { DEFAULT } from "../../shared/constant.js";
+import { a2s, s2a } from "../../shared/utils.js";
 import { subRoute } from "./utils.js";
 /** This function subtracts numbers (as string). */
 export function sub(strs) {

package/src/{sub → mathOperations/sub}/types.d.ts

@@ -1,2 +1,2 @@
-import type { InputData } from "../types.d.ts";
+import type { InputData } from "../../types.d.ts";
 export type Subtract = (L: [number[], number], R: [number[], number]) => InputData;

package/src/{sub → mathOperations/sub}/utils.d.ts

@@ -1,5 +1,5 @@
-import type { InputData } from "../types.d.ts";
+import type { Route } from "../../types.d.ts";
 import type { Subtract } from "./types.d.ts";
 /** This function subtracts 2 numbers (as array). */
 export declare const subtract: Subtract;
-export declare const subRoute: (input: InputData[], initValue: InputData) => InputData;
+export declare const subRoute: Route;

package/src/pipe/main.js

@@ -1,9 +1,9 @@
-import { addRoute } from "../add/utils.js";
-import { divRoute } from "../div/utils.js";
-import { mulRoute } from "../mul/utils.js";
 import { DEFAULT } from "../shared/constant.js";
 import { a2s, s2a } from "../shared/utils.js";
-import { subRoute } from "../sub/utils.js";
+import { subRoute } from "../mathOperations/sub/utils.js";
+import { addRoute } from "../mathOperations/add/utils.js";
+import { divRoute } from "../mathOperations/div/utils.js";
+import { mulRoute } from "../mathOperations/mul/utils.js";
 var Pipe = /** @class */ (function () {
     function Pipe() {
         this.result = DEFAULT;

package/src/quartile/main.d.ts

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

package/src/quartile/main.js

@@ -0,0 +1,19 @@
+import { pipe } from "../pipe/main.js";
+var mean = function (idx, array) {
+    return pipe.add([array[idx], array[idx - 1]]).div(["2"]).calc();
+};
+export var quartile = function (array) {
+    if (array.length < 3) {
+        throw Error("To calculate quartile you need at least 3 elements");
+    }
+    var length = array.length;
+    var Q2Idx = length >> 1;
+    var Q1Idx = Q2Idx >> 1;
+    var Q3Idx = length - Q1Idx;
+    var isEvenHalf = Q2Idx % 2 !== 0;
+    return {
+        Q1: isEvenHalf ? array[Q1Idx] : mean(Q1Idx, array),
+        Q2: length % 2 !== 0 ? array[Q2Idx] : mean(Q2Idx, array),
+        Q3: isEvenHalf ? array[Q3Idx - 1] : mean(Q3Idx, array),
+    };
+};

package/src/quartile/types.d.ts

@@ -0,0 +1,6 @@
+export type Quartile = (array: string[]) => {
+    Q1: string;
+    Q2: string;
+    Q3: string;
+};
+export type Mean = (index: number, array: string[]) => string;

package/src/types.d.ts

@@ -4,3 +4,4 @@ export type InputData = {
     isNegative: boolean;
     isFloat: boolean;
 };
+export type Route = (input: InputData[], initValue: InputData) => InputData;

package/src/add/utils.d.ts

@@ -1,5 +0,0 @@
-import type { InputData } from "../types.d.ts";
-import type { Addition } from "./types.d.ts";
-/** This function adds 2 numbers (as array). */
-export declare const addition: Addition;
-export declare const addRoute: (input: InputData[], initValue: InputData) => InputData;

package/src/div/types.d.ts

@@ -1,2 +0,0 @@
-import type { InputData } from "../types.d.ts";
-export type Division = (L: [number[], number], R: [number[], number], isNegative: boolean, initLimit: number) => InputData;

package/src/div/utils.d.ts

@@ -1,4 +0,0 @@
-import type { InputData } from "../types.d.ts";
-import type { Division } from "./types.d.ts";
-export declare const division: Division;
-export declare const divRoute: (input: InputData[], initValue: InputData, limit: number) => InputData;