Added rounding mode param to divide method (#135)

royNiladri · Jun 25, 2024 · efbe456 · efbe456
1 parent 5a47b16
commit efbe456
Show file tree

Hide file tree

Showing 13 changed files with 49 additions and 35 deletions.
diff --git a/dist/esm/big-decimal.d.ts b/dist/esm/big-decimal.d.ts
@@ -1,4 +1,4 @@
-import { RoundingModes as Modes } from "./roundingModes";
+import { RoundingModes as Modes, RoundingModes } from "./roundingModes";
 declare class bigDecimal {
     private value;
     static RoundingModes: typeof Modes;
@@ -22,8 +22,8 @@ declare class bigDecimal {
     subtract(number: bigDecimal): bigDecimal;
     static multiply(number1: any, number2: any): string;
     multiply(number: bigDecimal): bigDecimal;
-    static divide(number1: any, number2: any, precision?: number): string;
-    divide(number: bigDecimal, precision?: number): bigDecimal;
+    static divide(number1: any, number2: any, precision?: number, mode?: RoundingModes): string;
+    divide(number: bigDecimal, precision?: number, mode?: RoundingModes): bigDecimal;
     static modulus(number1: any, number2: any): string;
     modulus(number: bigDecimal): bigDecimal;
     static compareTo(number1: any, number2: any): 0 | 1 | -1;

diff --git a/dist/esm/big-decimal.js b/dist/esm/big-decimal.js
diff --git a/dist/esm/big-decimal.js.map b/dist/esm/big-decimal.js.map
diff --git a/dist/esm/divide.d.ts b/dist/esm/divide.d.ts
@@ -1 +1,2 @@
-export declare function divide(dividend: any, divisor: any, precission?: number): string;
+import { RoundingModes } from './roundingModes';
+export declare function divide(dividend: any, divisor: any, precission?: number, mode?: RoundingModes): string;
diff --git a/dist/node/big-decimal.d.ts b/dist/node/big-decimal.d.ts
@@ -1,4 +1,4 @@
-import { RoundingModes as Modes } from "./roundingModes";
+import { RoundingModes as Modes, RoundingModes } from "./roundingModes";
 declare class bigDecimal {
     private value;
     static RoundingModes: typeof Modes;
@@ -22,8 +22,8 @@ declare class bigDecimal {
     subtract(number: bigDecimal): bigDecimal;
     static multiply(number1: any, number2: any): string;
     multiply(number: bigDecimal): bigDecimal;
-    static divide(number1: any, number2: any, precision?: number): string;
-    divide(number: bigDecimal, precision?: number): bigDecimal;
+    static divide(number1: any, number2: any, precision?: number, mode?: RoundingModes): string;
+    divide(number: bigDecimal, precision?: number, mode?: RoundingModes): bigDecimal;
     static modulus(number1: any, number2: any): string;
     modulus(number: bigDecimal): bigDecimal;
     static compareTo(number1: any, number2: any): 0 | 1 | -1;

diff --git a/dist/node/js-big-decimal.js b/dist/node/js-big-decimal.js
@@ -224,8 +224,10 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.divide = void 0;
 var add_1 = __webpack_require__(217);
 var round_1 = __webpack_require__(350);
-function divide(dividend, divisor, precission) {
+var roundingModes_1 = __webpack_require__(916);
+function divide(dividend, divisor, precission, mode) {
     if (precission === void 0) { precission = 8; }
+    if (mode === void 0) { mode = roundingModes_1.RoundingModes.HALF_EVEN; }
     if (divisor == 0) {
         throw new Error('Cannot divide by 0');
     }
@@ -304,7 +306,7 @@ function divide(dividend, divisor, precission) {
             dividend = dividend.substring(1);
         }
     }
-    return ((neg == 1) ? '-' : '') + (0, add_1.trim)((0, round_1.roundOff)(quotent, precission - 2));
+    return ((neg == 1) ? '-' : '') + (0, add_1.trim)((0, round_1.roundOff)(quotent, precission - 2, mode));
 }
 exports.divide = divide;
 
@@ -878,13 +880,13 @@ var bigDecimal = /** @class */ (function () {
     bigDecimal.prototype.multiply = function (number) {
         return new bigDecimal((0, multiply_1.multiply)(this.value, number.getValue()));
     };
-    bigDecimal.divide = function (number1, number2, precision) {
+    bigDecimal.divide = function (number1, number2, precision, mode) {
         number1 = bigDecimal.validate(number1);
         number2 = bigDecimal.validate(number2);
-        return (0, divide_1.divide)(number1, number2, precision);
+        return (0, divide_1.divide)(number1, number2, precision, mode);
     };
-    bigDecimal.prototype.divide = function (number, precision) {
-        return new bigDecimal((0, divide_1.divide)(this.value, number.getValue(), precision));
+    bigDecimal.prototype.divide = function (number, precision, mode) {
+        return new bigDecimal((0, divide_1.divide)(this.value, number.getValue(), precision, mode));
     };
     bigDecimal.modulus = function (number1, number2) {
         number1 = bigDecimal.validate(number1);

diff --git a/dist/node/js-big-decimal.min.js b/dist/node/js-big-decimal.min.js
diff --git a/dist/web/js-big-decimal.js b/dist/web/js-big-decimal.js
@@ -215,8 +215,10 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.divide = void 0;
 var add_1 = __webpack_require__(217);
 var round_1 = __webpack_require__(350);
-function divide(dividend, divisor, precission) {
+var roundingModes_1 = __webpack_require__(916);
+function divide(dividend, divisor, precission, mode) {
     if (precission === void 0) { precission = 8; }
+    if (mode === void 0) { mode = roundingModes_1.RoundingModes.HALF_EVEN; }
     if (divisor == 0) {
         throw new Error('Cannot divide by 0');
     }
@@ -295,7 +297,7 @@ function divide(dividend, divisor, precission) {
             dividend = dividend.substring(1);
         }
     }
-    return ((neg == 1) ? '-' : '') + (0, add_1.trim)((0, round_1.roundOff)(quotent, precission - 2));
+    return ((neg == 1) ? '-' : '') + (0, add_1.trim)((0, round_1.roundOff)(quotent, precission - 2, mode));
 }
 exports.divide = divide;
 
@@ -869,13 +871,13 @@ var bigDecimal = /** @class */ (function () {
     bigDecimal.prototype.multiply = function (number) {
         return new bigDecimal((0, multiply_1.multiply)(this.value, number.getValue()));
     };
-    bigDecimal.divide = function (number1, number2, precision) {
+    bigDecimal.divide = function (number1, number2, precision, mode) {
         number1 = bigDecimal.validate(number1);
         number2 = bigDecimal.validate(number2);
-        return (0, divide_1.divide)(number1, number2, precision);
+        return (0, divide_1.divide)(number1, number2, precision, mode);
     };
-    bigDecimal.prototype.divide = function (number, precision) {
-        return new bigDecimal((0, divide_1.divide)(this.value, number.getValue(), precision));
+    bigDecimal.prototype.divide = function (number, precision, mode) {
+        return new bigDecimal((0, divide_1.divide)(this.value, number.getValue(), precision, mode));
     };
     bigDecimal.modulus = function (number1, number2) {
         number1 = bigDecimal.validate(number1);

diff --git a/dist/web/js-big-decimal.min.js b/dist/web/js-big-decimal.min.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "js-big-decimal",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "description": "Work with large numbers on the client side. Round them off to any required precision.",
   "main": "dist/node/js-big-decimal",
   "types": "dist/node/big-decimal",

diff --git a/src/big-decimal.ts b/src/big-decimal.ts
@@ -177,14 +177,14 @@ class bigDecimal {
     return new bigDecimal(multiply(this.value, number.getValue()));
   }
 
-  static divide(number1, number2, precision?: number) {
+  static divide(number1, number2, precision?: number, mode?: RoundingModes) {
     number1 = bigDecimal.validate(number1);
     number2 = bigDecimal.validate(number2);
-    return divide(number1, number2, precision);
+    return divide(number1, number2, precision, mode);
   }
 
-  divide(number: bigDecimal, precision?: number) {
-    return new bigDecimal(divide(this.value, number.getValue(), precision));
+  divide(number: bigDecimal, precision?: number, mode?: RoundingModes) {
+    return new bigDecimal(divide(this.value, number.getValue(), precision, mode));
   }
 
   static modulus(number1, number2) {

diff --git a/src/divide.spec.ts b/src/divide.spec.ts
@@ -1,4 +1,5 @@
 import bigDecimal from "./big-decimal";
+import { RoundingModes } from "./roundingModes";
 const divide = bigDecimal.divide;
 
 describe("divide", function () {
@@ -100,4 +101,10 @@ describe("divide", function () {
   it(".102 / .0383292 = 2.66115651", function () {
     expect(divide(".102", ".0383292", 8)).toBe("2.66115651");
   });
+  it("division of 27.999972 by 128 with precision of 10 should return 0.2187497812", function() {
+    expect(divide(27.999972, 128, 10)).toBe("0.2187497812");
+  })
+  it("division of 27.999972 by 128 with precision of 10 and rounded by HALF_UP mode should return 0.2187497813", function() {
+    expect(divide(27.999972, 128, 10, RoundingModes['HALF_UP'])).toBe("0.2187497813");
+  })
 });
diff --git a/src/divide.ts b/src/divide.ts
@@ -1,7 +1,8 @@
 import { add, trim } from './add';
 import { roundOff } from './round';
+import { RoundingModes } from './roundingModes';
 
-export function divide(dividend, divisor, precission = 8) {
+export function divide(dividend, divisor, precission = 8, mode = RoundingModes.HALF_EVEN) {
     if (divisor == 0) {
         throw new Error('Cannot divide by 0');
     }
@@ -90,5 +91,5 @@ export function divide(dividend, divisor, precission = 8) {
         }
     }
 
-    return ((neg == 1) ? '-' : '') + trim(roundOff(quotent, precission - 2));
+    return ((neg == 1) ? '-' : '') + trim(roundOff(quotent, precission - 2, mode));
 }