@utiliread/primitives 1.0.0-146 → 1.0.0-148

package/src/precision-number.spec.ts

@@ -1,251 +1,382 @@
-import { PrecisionNumber } from "./precision-number";
-import { expect } from "chai";
-
-describe("new", () => {
-    it("should create 0", () => {
-        const number = new PrecisionNumber(0);
-        expect(number.value).to.equal(0);
-        expect(number.precision).to.equal(1);
-    });
-
-    it("should create 0.5", () => {
-        const number = new PrecisionNumber(0.5);
-        expect(number.value).to.equal(0.5);
-        expect(number.precision).to.equal(1);
-    });
-
-    it("should create 0.05", () => {
-        const number = new PrecisionNumber(0.05);
-        expect(number.value).to.equal(0.05);
-        expect(number.precision).to.equal(2);
-    });
-
-    it("should create 1.05", () => {
-        const number = new PrecisionNumber(1.05);
-        expect(number.value).to.equal(1.05);
-        expect(number.precision).to.equal(3);
-    });
-
-    it("should create 100", () => {
-        const number = new PrecisionNumber(100);
-        expect(number.value).to.equal(100);
-        expect(number.precision).to.equal(3);
-    });
-});
-
-describe("parse", () => {
-    it("should not parse ''", () => {
-        const number = PrecisionNumber.parse("");
-        expect(Number.isNaN(number.value)).to.equal(true);
-        expect(number.precision).to.equal(0);
-    });
-
-    it("should parse '0'", () => {
-        const number = PrecisionNumber.parse("0");
-        expect(number.value).to.equal(0);
-        expect(number.precision).to.equal(1);
-    });
-
-    it("should parse '0.0'", () => {
-        const number = PrecisionNumber.parse("0.0");
-        expect(number.value).to.equal(0);
-        expect(number.precision).to.equal(1);
-    });
-
-    it("should parse '1'", () => {
-        const number = PrecisionNumber.parse("1");
-        expect(number.value).to.equal(1);
-        expect(number.precision).to.equal(1);
-    });
-
-    it("should parse '1.'", () => {
-        const number = PrecisionNumber.parse("1.");
-        expect(number.value).to.equal(1);
-        expect(number.precision).to.equal(2);
-    });
-
-    it("should parse '1.0'", () => {
-        const number = PrecisionNumber.parse("1.0");
-        expect(number.value).to.equal(1);
-        expect(number.precision).to.equal(2);
-    });
-
-    it("should parse '0.6'", () => {
-        const number = PrecisionNumber.parse("0.6");
-        expect(number.value).to.equal(0.6);
-        expect(number.precision).to.equal(1);
-    });
-
-    it("should parse '.6'", () => {
-        const number = PrecisionNumber.parse(".6");
-        expect(number.value).to.equal(0.6);
-        expect(number.precision).to.equal(1);
-    });
-
-    it("should parse '.06'", () => {
-        const number = PrecisionNumber.parse(".06");
-        expect(number.value).to.equal(0.06);
-        expect(number.precision).to.equal(1);
-    });
-
-    it("should parse with leading zeros '00012'", () => {
-        const number = PrecisionNumber.parse("00012");
-        expect(number.value).to.equal(12);
-        expect(number.precision).to.equal(2);
-    });
-
-    it("should parse with leading zeros '000.12'", () => {
-        const number = PrecisionNumber.parse("000.12");
-        expect(number.value).to.equal(0.12);
-        expect(number.precision).to.equal(2);
-    });
-
-    it("should parse with leading zeros '000.012'", () => {
-        const number = PrecisionNumber.parse("000.012");
-        expect(number.value).to.equal(0.012);
-        expect(number.precision).to.equal(2);
-    });
-
-    it("should parse with leading zeros '00012.3'", () => {
-        const number = PrecisionNumber.parse("00012.3");
-        expect(number.value).to.equal(12.3);
-        expect(number.precision).to.equal(3);
-    });
-});
-
-describe("plus", () => {
-    const data = [
-        [
-            new PrecisionNumber(2, 1),
-            new PrecisionNumber(10, 2),
-            new PrecisionNumber(12, 2),
-        ],
-        [
-            new PrecisionNumber(2, 1),
-            new PrecisionNumber(-10, 2),
-            new PrecisionNumber(-8, 1),
-        ],
-        [
-            new PrecisionNumber(-2, 1),
-            new PrecisionNumber(10, 2),
-            new PrecisionNumber(8, 1),
-        ],
-        [
-            new PrecisionNumber(-2, 1),
-            new PrecisionNumber(-10, 2),
-            new PrecisionNumber(-12, 2),
-        ],
-        [
-            new PrecisionNumber(2, 1),
-            new PrecisionNumber(10, 3),
-            new PrecisionNumber(12, 2),
-        ],
-        [
-            new PrecisionNumber(2, 3),
-            new PrecisionNumber(10, 3),
-            new PrecisionNumber(12, 3),
-        ],
-        [
-            new PrecisionNumber(0.12, 2),
-            new PrecisionNumber(1, 2),
-            new PrecisionNumber(1.12, 2),
-        ],
-        [
-            new PrecisionNumber(0.12, 2),
-            new PrecisionNumber(1, 3),
-            new PrecisionNumber(1.12, 3),
-        ],
-        [
-            new PrecisionNumber(123456, 6),
-            new PrecisionNumber(1, 2),
-            new PrecisionNumber(123457, 6),
-        ],
-        [
-            new PrecisionNumber(1, 1),
-            new PrecisionNumber(1024, 3),
-            new PrecisionNumber(1025, 3),
-        ],
-        [
-            new PrecisionNumber(0, 0),
-            new PrecisionNumber(1024, 3),
-            new PrecisionNumber(1024, 3),
-        ],
-        [
-            new PrecisionNumber(0, 1),
-            new PrecisionNumber(1024, 3),
-            new PrecisionNumber(1024, 3),
-        ],
-    ];
-
-    it("should plus correctly", () => {
-        for (const [left, right, expected] of data) {
-            const result = left.plus(right);
-            expect(result.value).to.equal(expected.value);
-            expect(result.precision).to.equal(expected.precision);
-        }
-    });
-});
-
-describe("minus", () => {
-    const data = [
-        [
-            new PrecisionNumber(132900, 4),
-            new PrecisionNumber(132892, 6),
-            new PrecisionNumber(8, 1),
-        ],
-        [
-            new PrecisionNumber(123, 2),
-            new PrecisionNumber(0, 0),
-            new PrecisionNumber(123, 2),
-        ],
-        [
-            new PrecisionNumber(123, 2),
-            new PrecisionNumber(0, 1),
-            new PrecisionNumber(123, 2),
-        ],
-    ];
-
-    it("should minus correctly", () => {
-        for (const [left, right, expected] of data) {
-            const result = left.minus(right);
-            expect(result.value).to.equal(expected.value);
-            expect(result.precision).to.equal(expected.precision);
-        }
-    });
-});
-
-describe("toString", () => {
-    it("should return a rounded version in toFixed", () => {
-        expect(new PrecisionNumber(2474.581, 6).toFixed()).to.equal("2474.58");
-        expect(new PrecisionNumber(2474.589, 6).toFixed()).to.equal("2474.59");
-        expect(new PrecisionNumber(-2474.581, 6).toFixed()).to.equal(
-            "-2474.58",
-        );
-        expect(new PrecisionNumber(-2474.589, 6).toFixed()).to.equal(
-            "-2474.59",
-        );
-    });
-});
-
-describe("compare", () => {
-    it("should return a rounded version in valueOf", () => {
-        expect(new PrecisionNumber(2474.581, 6).valueOf()).to.equal(2474.58);
-        expect(new PrecisionNumber(2474.589, 6).valueOf()).to.equal(2474.59);
-        expect(new PrecisionNumber(-2474.581, 6).valueOf()).to.equal(-2474.58);
-        expect(new PrecisionNumber(-2474.589, 6).valueOf()).to.equal(-2474.59);
-    });
-
-    it("should compare leq and geq, precision with decimals", () => {
-        const value = new PrecisionNumber(2474.58, 6);
-        expect(value.toPrecision()).to.equal("2474.58");
-        expect(new PrecisionNumber(2474.580078125, 6) <= value).to.equal(true);
-        expect(new PrecisionNumber(2474.580078125, 6) >= value).to.equal(true);
-    });
-
-    it("should compare leq and geq, precision without decimals", () => {
-        const value = new PrecisionNumber(2474.58, 2);
-        expect(value.toPrecision()).to.equal("2.5e+3");
-        expect(new PrecisionNumber(2474.580078125, 2) <= value).to.equal(true);
-        expect(new PrecisionNumber(2474.580078125, 2) >= value).to.equal(true);
-    });
-});
+import { PrecisionNumber } from "./precision-number";
+import { expect } from "chai";
+
+describe("new", () => {
+    it("should create 0", () => {
+        // The precision of zero is its number of decimals
+        const number = new PrecisionNumber(0);
+        expect(number.value).to.equal(0);
+        expect(number.precision).to.equal(0);
+        expect(number.decimals).to.equal(0);
+        expect(number.toFixed()).to.equal("0");
+    });
+
+    it("should create 0.5", () => {
+        const number = new PrecisionNumber(0.5);
+        expect(number.value).to.equal(0.5);
+        expect(number.precision).to.equal(1);
+    });
+
+    it("should create 0.05", () => {
+        const number = new PrecisionNumber(0.05);
+        expect(number.value).to.equal(0.05);
+        expect(number.precision).to.equal(1);
+        expect(number.decimals).to.equal(2);
+    });
+
+    it("should create 1.05", () => {
+        const number = new PrecisionNumber(1.05);
+        expect(number.value).to.equal(1.05);
+        expect(number.precision).to.equal(3);
+    });
+
+    it("should create 100", () => {
+        const number = new PrecisionNumber(100);
+        expect(number.value).to.equal(100);
+        expect(number.precision).to.equal(3);
+    });
+});
+
+describe("parse", () => {
+    it("should not parse ''", () => {
+        const number = PrecisionNumber.parse("");
+        expect(Number.isNaN(number.value)).to.equal(true);
+        expect(number.precision).to.equal(0);
+    });
+
+    it("should parse '0'", () => {
+        const number = PrecisionNumber.parse("0");
+        expect(number.value).to.equal(0);
+        expect(number.precision).to.equal(0);
+        expect(number.toFixed()).to.equal("0");
+    });
+
+    it("should parse '0.0'", () => {
+        const number = PrecisionNumber.parse("0.0");
+        expect(number.value).to.equal(0);
+        expect(number.precision).to.equal(1);
+        expect(number.toFixed()).to.equal("0.0");
+    });
+
+    it("should parse '0.00'", () => {
+        const number = PrecisionNumber.parse("0.00");
+        expect(number.value).to.equal(0);
+        expect(number.precision).to.equal(2);
+        expect(number.toFixed()).to.equal("0.00");
+    });
+
+    it("should parse '0.'", () => {
+        const number = PrecisionNumber.parse("0.");
+        expect(number.value).to.equal(0);
+        expect(number.precision).to.equal(1);
+    });
+
+    it("should parse '-0.0'", () => {
+        const number = PrecisionNumber.parse("-0.0");
+        expect(number.value).to.equal(0);
+        expect(number.precision).to.equal(1);
+    });
+
+    it("should parse '000.00'", () => {
+        const number = PrecisionNumber.parse("000.00");
+        expect(number.value).to.equal(0);
+        expect(number.precision).to.equal(2);
+    });
+
+    it("should parse '1'", () => {
+        const number = PrecisionNumber.parse("1");
+        expect(number.value).to.equal(1);
+        expect(number.precision).to.equal(1);
+    });
+
+    it("should parse '1.'", () => {
+        const number = PrecisionNumber.parse("1.");
+        expect(number.value).to.equal(1);
+        expect(number.precision).to.equal(2);
+    });
+
+    it("should parse '1.0'", () => {
+        const number = PrecisionNumber.parse("1.0");
+        expect(number.value).to.equal(1);
+        expect(number.precision).to.equal(2);
+    });
+
+    it("should parse '0.6'", () => {
+        const number = PrecisionNumber.parse("0.6");
+        expect(number.value).to.equal(0.6);
+        expect(number.precision).to.equal(1);
+    });
+
+    it("should parse '.6'", () => {
+        const number = PrecisionNumber.parse(".6");
+        expect(number.value).to.equal(0.6);
+        expect(number.precision).to.equal(1);
+    });
+
+    it("should parse '.06'", () => {
+        const number = PrecisionNumber.parse(".06");
+        expect(number.value).to.equal(0.06);
+        expect(number.precision).to.equal(1);
+    });
+
+    it("should parse with leading zeros '00012'", () => {
+        const number = PrecisionNumber.parse("00012");
+        expect(number.value).to.equal(12);
+        expect(number.precision).to.equal(2);
+    });
+
+    it("should parse with leading zeros '000.12'", () => {
+        const number = PrecisionNumber.parse("000.12");
+        expect(number.value).to.equal(0.12);
+        expect(number.precision).to.equal(2);
+    });
+
+    it("should parse with leading zeros '000.012'", () => {
+        const number = PrecisionNumber.parse("000.012");
+        expect(number.value).to.equal(0.012);
+        expect(number.precision).to.equal(2);
+    });
+
+    it("should parse with leading zeros '00012.3'", () => {
+        const number = PrecisionNumber.parse("00012.3");
+        expect(number.value).to.equal(12.3);
+        expect(number.precision).to.equal(3);
+    });
+});
+
+describe("plus", () => {
+    const data = [
+        [
+            new PrecisionNumber(2, 1),
+            new PrecisionNumber(10, 2),
+            new PrecisionNumber(12, 2),
+        ],
+        [
+            new PrecisionNumber(2, 1),
+            new PrecisionNumber(-10, 2),
+            new PrecisionNumber(-8, 1),
+        ],
+        [
+            new PrecisionNumber(-2, 1),
+            new PrecisionNumber(10, 2),
+            new PrecisionNumber(8, 1),
+        ],
+        [
+            new PrecisionNumber(-2, 1),
+            new PrecisionNumber(-10, 2),
+            new PrecisionNumber(-12, 2),
+        ],
+        [
+            new PrecisionNumber(2, 1),
+            new PrecisionNumber(10, 3),
+            new PrecisionNumber(12, 2),
+        ],
+        [
+            new PrecisionNumber(2, 3),
+            new PrecisionNumber(10, 3),
+            new PrecisionNumber(12, 3),
+        ],
+        [
+            new PrecisionNumber(0.12, 2),
+            new PrecisionNumber(1, 2),
+            new PrecisionNumber(1.12, 2),
+        ],
+        [
+            new PrecisionNumber(0.12, 2),
+            new PrecisionNumber(1, 3),
+            new PrecisionNumber(1.12, 3),
+        ],
+        [
+            new PrecisionNumber(123456, 6),
+            new PrecisionNumber(1, 2),
+            new PrecisionNumber(123457, 6),
+        ],
+        [
+            new PrecisionNumber(1, 1),
+            new PrecisionNumber(1024, 3),
+            new PrecisionNumber(1025, 3),
+        ],
+        [
+            new PrecisionNumber(0, 0),
+            new PrecisionNumber(1024, 3),
+            new PrecisionNumber(1024, 3),
+        ],
+        [
+            new PrecisionNumber(0, 1),
+            new PrecisionNumber(1024, 3),
+            new PrecisionNumber(1024, 3),
+        ],
+        // "0" is the additive identity
+        [
+            new PrecisionNumber(0, 0),
+            new PrecisionNumber(1.25, 3),
+            new PrecisionNumber(1.25, 3),
+        ],
+        [
+            new PrecisionNumber(1.25, 3),
+            new PrecisionNumber(0, 0),
+            new PrecisionNumber(1.25, 3),
+        ],
+        [
+            new PrecisionNumber(0, 1),
+            new PrecisionNumber(1.26, 3),
+            new PrecisionNumber(1.26, 2),
+        ],
+        // Zero results have the number of decimals as precision
+        [
+            new PrecisionNumber(-1, 1),
+            new PrecisionNumber(1, 1),
+            new PrecisionNumber(0, 0),
+        ],
+        [
+            new PrecisionNumber(-1, 2),
+            new PrecisionNumber(1, 2),
+            new PrecisionNumber(0, 1),
+        ],
+        [
+            new PrecisionNumber(-1.25, 3),
+            new PrecisionNumber(1.25, 3),
+            new PrecisionNumber(0, 2),
+        ],
+        [
+            new PrecisionNumber(1.4, 2),
+            new PrecisionNumber(-1, 1),
+            new PrecisionNumber(0, 0),
+        ],
+        [
+            new PrecisionNumber(0, 2),
+            new PrecisionNumber(0, 1),
+            new PrecisionNumber(0, 1),
+        ],
+        // Sub-1 values
+        [
+            new PrecisionNumber(0.0625, 3),
+            new PrecisionNumber(-0.03125, 1),
+            new PrecisionNumber(0.03125, 1),
+        ],
+    ];
+
+    it("should plus correctly", () => {
+        for (const [left, right, expected] of data) {
+            const result = left.plus(right);
+            expect(result.value).to.equal(expected.value);
+            expect(result.precision).to.equal(expected.precision);
+        }
+    });
+});
+
+describe("minus", () => {
+    const data = [
+        [
+            new PrecisionNumber(132900, 4),
+            new PrecisionNumber(132892, 6),
+            new PrecisionNumber(8, 1),
+        ],
+        [
+            new PrecisionNumber(123, 2),
+            new PrecisionNumber(0, 0),
+            new PrecisionNumber(123, 2),
+        ],
+        [
+            new PrecisionNumber(123, 2),
+            new PrecisionNumber(0, 1),
+            new PrecisionNumber(123, 2),
+        ],
+        [
+            new PrecisionNumber(0, 0),
+            new PrecisionNumber(123, 2),
+            new PrecisionNumber(-123, 2),
+        ],
+        [
+            new PrecisionNumber(123, 3),
+            new PrecisionNumber(123, 3),
+            new PrecisionNumber(0, 0),
+        ],
+        [
+            new PrecisionNumber(1.5, 2),
+            new PrecisionNumber(1.5, 2),
+            new PrecisionNumber(0, 1),
+        ],
+    ];
+
+    it("should minus correctly", () => {
+        for (const [left, right, expected] of data) {
+            const result = left.minus(right);
+            expect(result.value).to.equal(expected.value);
+            expect(result.precision).to.equal(expected.precision);
+        }
+    });
+});
+
+describe("zero", () => {
+    it("should not leave floating point noise", () => {
+        const result = new PrecisionNumber(0.3, 1)
+            .minus(new PrecisionNumber(0.1, 1))
+            .minus(new PrecisionNumber(0.2, 1));
+        expect(result.value).to.equal(0);
+        expect(result.precision).to.equal(1);
+        expect(result.toFixed()).to.equal("0.0");
+    });
+
+    it("should format zero with its number of decimals", () => {
+        expect(new PrecisionNumber(0, 0).toFixed()).to.equal("0");
+        expect(new PrecisionNumber(0, 1).toFixed()).to.equal("0.0");
+        expect(new PrecisionNumber(0, 2).toFixed()).to.equal("0.00");
+        expect(new PrecisionNumber(0, 0).toPrecision()).to.equal("0");
+        expect(new PrecisionNumber(0, 2).toPrecision()).to.equal("0.00");
+    });
+});
+
+describe("decimals", () => {
+    it("should get the number of decimals", () => {
+        expect(new PrecisionNumber(0, 0).decimals).to.equal(0);
+        expect(new PrecisionNumber(0, 2).decimals).to.equal(2);
+        expect(new PrecisionNumber(0.003, 1).decimals).to.equal(3);
+        expect(new PrecisionNumber(0.07, 1).decimals).to.equal(2);
+        expect(new PrecisionNumber(0.099, 1).decimals).to.equal(1);
+        expect(new PrecisionNumber(0.0999, 2).decimals).to.equal(2);
+        expect(new PrecisionNumber(0.1, 3).decimals).to.equal(3);
+        expect(new PrecisionNumber(100, 1).decimals).to.equal(-2);
+        expect(new PrecisionNumber(100, 4).decimals).to.equal(1);
+    });
+
+    it("should keep sub-1 values in valueOf", () => {
+        expect(PrecisionNumber.parse(".06").valueOf()).to.equal(0.06);
+    });
+});
+
+describe("toString", () => {
+    it("should return a rounded version in toFixed", () => {
+        expect(new PrecisionNumber(2474.581, 6).toFixed()).to.equal("2474.58");
+        expect(new PrecisionNumber(2474.589, 6).toFixed()).to.equal("2474.59");
+        expect(new PrecisionNumber(-2474.581, 6).toFixed()).to.equal(
+            "-2474.58",
+        );
+        expect(new PrecisionNumber(-2474.589, 6).toFixed()).to.equal(
+            "-2474.59",
+        );
+    });
+});
+
+describe("compare", () => {
+    it("should return a rounded version in valueOf", () => {
+        expect(new PrecisionNumber(2474.581, 6).valueOf()).to.equal(2474.58);
+        expect(new PrecisionNumber(2474.589, 6).valueOf()).to.equal(2474.59);
+        expect(new PrecisionNumber(-2474.581, 6).valueOf()).to.equal(-2474.58);
+        expect(new PrecisionNumber(-2474.589, 6).valueOf()).to.equal(-2474.59);
+    });
+
+    it("should compare leq and geq, precision with decimals", () => {
+        const value = new PrecisionNumber(2474.58, 6);
+        expect(value.toPrecision()).to.equal("2474.58");
+        expect(new PrecisionNumber(2474.580078125, 6) <= value).to.equal(true);
+        expect(new PrecisionNumber(2474.580078125, 6) >= value).to.equal(true);
+    });
+
+    it("should compare leq and geq, precision without decimals", () => {
+        const value = new PrecisionNumber(2474.58, 2);
+        expect(value.toPrecision()).to.equal("2.5e+3");
+        expect(new PrecisionNumber(2474.580078125, 2) <= value).to.equal(true);
+        expect(new PrecisionNumber(2474.580078125, 2) >= value).to.equal(true);
+    });
+});