@khanacademy/kmath 0.0.0-PR973-20240207193807 → 0.0.0-PR973-20240207204403

package/.babelrc.js

@@ -0,0 +1,8 @@
+/**
+ * HACK(somewhatabstract): Due to https://github.com/facebook/jest/issues/11741,
+ * we need to have this file, or updating inline snapshots can fail rather
+ * cryptically.
+ *
+ * We should remove this when jest is fixed.
+ */
+module.exports = require("../../config/build/babel.config");

package/.eslintrc.js

@@ -0,0 +1,12 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable import/no-commonjs */
+const path = require("path");
+
+module.exports = {
+    rules: {
+        "import/no-extraneous-dependencies": [
+            "error",
+            {packageDir: [__dirname, path.join(__dirname, "../../")]},
+        ],
+    },
+};

package/CHANGELOG.md

@@ -0,0 +1,130 @@
+# @khanacademy/kmath
+
+## 0.0.0-PR973-20240207204403
+
+### Patch Changes
+
+-   [#973](https://github.com/Khan/perseus/pull/973) [`2ffc6971`](https://github.com/Khan/perseus/commit/2ffc6971e7003cbc64a8a3988337c6ca6019c9db) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Include 'types' key in package.json and move types to 'types' package subdirectory
+
+-   Updated dependencies [[`2ffc6971`](https://github.com/Khan/perseus/commit/2ffc6971e7003cbc64a8a3988337c6ca6019c9db)]:
+    -   @khanacademy/perseus-core@0.0.0-PR973-20240207204403
+
+## 0.1.12
+
+### Patch Changes
+
+-   [#971](https://github.com/Khan/perseus/pull/971) [`90ff7a48`](https://github.com/Khan/perseus/commit/90ff7a483b01552a556c7852427e98153cc20417) Thanks [@benchristel](https://github.com/benchristel)! - Remove source files from the distributed NPM package
+
+-   Updated dependencies [[`90ff7a48`](https://github.com/Khan/perseus/commit/90ff7a483b01552a556c7852427e98153cc20417)]:
+    -   @khanacademy/perseus-core@1.4.2
+
+## 0.1.11
+
+### Patch Changes
+
+-   [#964](https://github.com/Khan/perseus/pull/964) [`d8fbc251`](https://github.com/Khan/perseus/commit/d8fbc25170bd671ad984893553f79f44e3a0d048) Thanks [@benchristel](https://github.com/benchristel)! - Internal: Refactor Movable to be an ES6 class
+
+## 0.1.10
+
+### Patch Changes
+
+-   [#954](https://github.com/Khan/perseus/pull/954) [`43820ff9`](https://github.com/Khan/perseus/commit/43820ff9ce391682b951279a4c6fb9e3db966eb9) Thanks [@benchristel](https://github.com/benchristel)! - Internal: Fix @ts-expect-errors related to Graphie
+
+## 0.1.9
+
+### Patch Changes
+
+-   [#949](https://github.com/Khan/perseus/pull/949) [`59ce1e09`](https://github.com/Khan/perseus/commit/59ce1e0990cecd1123d7b9a671b032fcd03ce1b1) Thanks [@benchristel](https://github.com/benchristel)! - Internal: use built-in JS functions instead of underscore
+
+## 0.1.8
+
+### Patch Changes
+
+-   Updated dependencies [[`1f4e17ba`](https://github.com/Khan/perseus/commit/1f4e17ba77e1491523813655af18a70285a25989), [`8857950b`](https://github.com/Khan/perseus/commit/8857950bdeeb6e13bc3766b1c6545289b21cbe2a)]:
+    -   @khanacademy/perseus-core@1.4.1
+
+## 0.1.7
+
+### Patch Changes
+
+-   [#814](https://github.com/Khan/perseus/pull/814) [`105d2060`](https://github.com/Khan/perseus/commit/105d20603d935d35cff237b17f0bfb57ca751e4c) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Minor build change to how we provide Typescript type definitions (should be no change to build output).
+
+-   Updated dependencies [[`a91c84fe`](https://github.com/Khan/perseus/commit/a91c84fe53827ff4333220777a9918882b7fe9f0), [`105d2060`](https://github.com/Khan/perseus/commit/105d20603d935d35cff237b17f0bfb57ca751e4c)]:
+    -   @khanacademy/perseus-core@1.4.0
+
+## 0.1.6
+
+### Patch Changes
+
+-   Updated dependencies [[`79403e06`](https://github.com/Khan/perseus/commit/79403e06eedb597d7818d6c858bbba6f51ff3fe1)]:
+    -   @khanacademy/perseus-core@1.3.0
+
+## 0.1.5
+
+### Patch Changes
+
+-   Updated dependencies [[`376eb0e4`](https://github.com/Khan/perseus/commit/376eb0e4aaaa4c7a90fd6107a84bb74d382b077c)]:
+    -   @khanacademy/perseus-core@1.2.0
+
+## 0.1.4
+
+### Patch Changes
+
+-   Updated dependencies [22a9c408]
+    -   @khanacademy/perseus-core@1.1.2
+
+## 0.1.3
+
+### Patch Changes
+
+-   55d4cd00: Print package name and version when loaded in the page
+-   Updated dependencies [55d4cd00]
+    -   @khanacademy/perseus-core@1.1.1
+
+## 0.1.2
+
+### Patch Changes
+
+-   ce5e6297: Upgrade wonder-blocks deps to package versions without Flow types
+
+## 0.1.1
+
+### Patch Changes
+
+-   1f062e98: Bump all package versions since the build settings have been updated
+
+## 0.1.0
+
+### Minor Changes
+
+-   53fd3768: Migrate source code to TypeScript
+
+## 0.0.8
+
+### Patch Changes
+
+-   f567f660: Update the eslint config to look at both the package.json for the package and the one from the root
+
+## 0.0.7
+
+### Patch Changes
+
+-   bf180fe1: Fix our use of import/no-extraneous-dependencies
+
+## 0.0.6
+
+### Patch Changes
+
+-   98d283ff: Fix storybook
+
+## 0.0.5
+
+### Patch Changes
+
+-   1c1f7717: Enhance Flow types for kmath's vector and point
+
+## 0.0.4
+
+### Patch Changes
+
+-   a46d62bf: Remove .tgz file that shouldn't be packaged

package/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" width="400" height="400" viewBox="0 0 400 400"><defs/><ellipse cx="200" cy="200" rx="200" ry="200" fill="#28ae7b" stroke="none" style="stroke-width: 2px" stroke-width="2"/><path fill="#ffffff" stroke="#ffffff" d="M 293.05,242.4 C 295.7,226.5 324.85,202.65 332.8,200 C 324.85,197.35 295.7,173.5 293.05,157.6" transform="" style="stroke-width: 25px;stroke-linejoin: round;stroke-linecap: round" stroke-width="25" stroke-linejoin="round" stroke-linecap="round"/><path fill="#ffffff" stroke="#ffffff" d="M 80,200 S 80,200 332.05,200" style="stroke-width: 25px" stroke-width="25"/><path fill="#ffffff" stroke="#ffffff" d="M 200,320 L 200,80" style="stroke-width: 25px" stroke-width="25"/></svg>

package/package.json

@@ -3,7 +3,7 @@
     "description": "Khan Academy's Javascript Numeric Math Utilities",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "0.0.0-PR973-20240207193807",
+    "version": "0.0.0-PR973-20240207204403",
     "publishConfig": {
         "access": "public"
     },
@@ -17,15 +17,12 @@
     "module": "dist/es/index.js",
     "main": "dist/index.js",
     "source": "src/index.ts",
-    "types": "dist/types/index.d.ts",
-    "files": [
-        "dist"
-    ],
+    "types": "dist/index.d.ts",
     "scripts": {
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },
     "dependencies": {
-        "@khanacademy/perseus-core": "0.0.0-PR973-20240207193807"
+        "@khanacademy/perseus-core": "0.0.0-PR973-20240207204403"
     },
     "devDependencies": {
         "perseus-build-settings": "^0.3.0",

package/src/__tests__/line.test.ts

@@ -0,0 +1,117 @@
+import * as line from "../line";
+
+describe("kline", function () {
+    it("finds distance to point", () => {
+        const result = line.distanceToPoint(
+            [
+                [-5, 0],
+                [5, 0],
+            ],
+            [0, 5],
+        );
+        expect(result).toBe(5);
+    });
+
+    it("reflects a point", () => {
+        const result = line.reflectPoint(
+            [
+                [-5, -5],
+                [5, 5],
+            ],
+            [0, 5],
+        );
+        expect(result).toEqual([5, 0]);
+    });
+
+    it("finds the midpoint", () => {
+        const result = line.midpoint([
+            [-5, -5],
+            [5, 5],
+        ]);
+        expect(result).toEqual([0, 0]);
+    });
+
+    it("two identical lines should be equal", function () {
+        const result = line.equal(
+            [
+                [1, 1],
+                [3, 3],
+            ],
+            [
+                [1, 1],
+                [3, 3],
+            ],
+        );
+        expect(result).toBe(true);
+    });
+
+    it("two parallel lines should not be equal", function () {
+        const result = line.equal(
+            [
+                [1, 1],
+                [3, 3],
+            ],
+            [
+                [1, 2],
+                [3, 4],
+            ],
+        );
+        expect(result).toBe(false);
+    });
+
+    it("two intersecting lines should not be equal", function () {
+        const result = line.equal(
+            [
+                [1, 1],
+                [3, 3],
+            ],
+            [
+                [1, 1],
+                [3, 4],
+            ],
+        );
+        expect(result).toBe(false);
+    });
+
+    it("two collinear lines should be equal #1", function () {
+        const result = line.equal(
+            [
+                [1, 1],
+                [3, 3],
+            ],
+            [
+                [0, 0],
+                [5, 5],
+            ],
+        );
+        expect(result).toBe(true);
+    });
+
+    it("two collinear lines should be equal #2", function () {
+        const result = line.equal(
+            [
+                [4, 4],
+                [5, 5],
+            ],
+            [
+                [0, 0],
+                [1, 1],
+            ],
+        );
+        expect(result).toBe(true);
+    });
+
+    it("two collinear lines should be equal #3", function () {
+        const result = line.equal(
+            [
+                [0, 0],
+                [1, 1],
+            ],
+            [
+                [3, 3],
+                [6, 6],
+            ],
+        );
+        expect(result).toBe(true);
+    });
+});

package/src/__tests__/number.test.ts

@@ -0,0 +1,119 @@
+import {describe, it} from "@jest/globals";
+
+import * as number from "../number";
+
+describe("knumber", function () {
+    it.each([3, Math.PI, 6.28, 5e10, 1 / 0])("is a number: %s", (num: any) => {
+        expect(number.is(num)).toBe(true);
+    });
+
+    it.each(["10", 0 / 0, NaN])("is not a number:%s", (num: any) => {
+        expect(number.is(num)).toBe(false);
+    });
+
+    it("two equal numbers should be equal", function () {
+        const result = number.equal(1 / 3, (1 / 90) * 30);
+        expect(result).toBe(true);
+    });
+
+    it("two different numbers should not be equal", function () {
+        const result = number.equal(1 / 3, 1.333333);
+        expect(result).toBe(false);
+    });
+
+    it("Infinity should equal Infinity", function () {
+        const result = number.equal(
+            Number.POSITIVE_INFINITY,
+            Number.POSITIVE_INFINITY,
+        );
+        expect(result).toBe(true);
+    });
+
+    it("+Infinity should not equal -Infinity", function () {
+        const result = number.equal(
+            Number.POSITIVE_INFINITY,
+            Number.NEGATIVE_INFINITY,
+        );
+        expect(result).toBe(false);
+    });
+
+    it("sign(0) should be 0", function () {
+        expect(number.sign(0)).toBe(0);
+    });
+
+    it("sign(-0.0) should be 0", function () {
+        expect(number.sign(-0.0)).toBe(0);
+    });
+
+    it("sign(3.2) should be 1", function () {
+        expect(number.sign(3.2)).toBe(1);
+    });
+
+    it("sign(-2.8) should be -1", function () {
+        expect(number.sign(-2.8)).toBe(-1);
+    });
+
+    it("isInteger(-2.8) should be false", function () {
+        expect(number.isInteger(-2.8)).toBe(false);
+    });
+
+    it("isInteger(-2) should be true", function () {
+        expect(number.isInteger(-2)).toBe(true);
+    });
+
+    it("isInteger(10.0) should be true", () => {
+        expect(number.isInteger(10)).toBe(true);
+    });
+
+    it("rounds to correct precision", () => {
+        expect(number.round(0.06793, 4)).toBe(0.0679);
+        expect(number.round(0.06793, 3)).toBe(0.068);
+    });
+
+    it("rounds to correct interval", () => {
+        expect(number.roundTo(83, 5)).toBe(85);
+        expect(number.roundTo(2.3, 0.5)).toBe(2.5);
+    });
+
+    it("floors to the correct interval", () => {
+        expect(number.floorTo(83, 5)).toBe(80);
+        expect(number.floorTo(2.3, 0.5)).toBe(2);
+    });
+
+    it("ceils to the correct interval", () => {
+        expect(number.ceilTo(81, 5)).toBe(85);
+        expect(number.ceilTo(2.1, 0.5)).toBe(2.5);
+    });
+
+    it("toFraction(-2) should be -2/1", function () {
+        expect(number.toFraction(-2)).toStrictEqual([-2, 1]);
+    });
+
+    it("toFraction(-2.5) should be -5/2", function () {
+        expect(number.toFraction(-2.5)).toStrictEqual([-5, 2]);
+    });
+
+    it("toFraction(2/3) should be 2/3", function () {
+        expect(number.toFraction(2 / 3)).toStrictEqual([2, 3]);
+    });
+
+    it("toFraction(283.33...) should be 850/3", function () {
+        expect(number.toFraction(283 + 1 / 3)).toStrictEqual([850, 3]);
+    });
+
+    it("toFraction(0) should be 0/1", function () {
+        expect(number.toFraction(0)).toStrictEqual([0, 1]);
+    });
+
+    it("toFraction(pi) should be pi/1", function () {
+        expect(number.toFraction(Math.PI)).toStrictEqual([Math.PI, 1]);
+    });
+
+    it("toFraction(0.66) should be 33/50", function () {
+        expect(number.toFraction(0.66)).toStrictEqual([33, 50]);
+    });
+
+    it("toFraction(0.66, 0.01) should be 2/3", function () {
+        expect(number.toFraction(0.66, 0.01)).toStrictEqual([2, 3]);
+    });
+});

package/src/__tests__/point.test.ts

@@ -0,0 +1,48 @@
+import * as point from "../point";
+
+describe("kpoint", function () {
+    it("point.compare should return positive if the first element is larger", function () {
+        const result = point.compare([5, 2], [3, 4]);
+        expect(result).toBeGreaterThan(0);
+    });
+
+    it("point.compare should return negative if the first element is smaller", function () {
+        const result = point.compare([2, 2], [4, 0]);
+        expect(result).toBeLessThan(0);
+    });
+
+    it("point.compare should return positive if the second element is larger", function () {
+        const result = point.compare([5, 2], [5, 1]);
+        expect(result).toBeGreaterThan(0);
+    });
+
+    it("point.compare should return negative if the second element is smaller", function () {
+        const result = point.compare([2, 2], [2, 4]);
+        expect(result).toBeLessThan(0);
+    });
+
+    it("point.compare should return positive if the third element is larger", function () {
+        const result = point.compare([5, 3, -2], [5, 3, -4]);
+        expect(result).toBeGreaterThan(0);
+    });
+
+    it("point.compare should return negative if the third element is smaller", function () {
+        const result = point.compare([2, -1, -4], [2, -1, -2]);
+        expect(result).toBeLessThan(0);
+    });
+
+    it("point.compare should return 0 if the vectors are equal", function () {
+        const result = point.compare([2, 4, 3], [2, 4, 3]);
+        expect(result).toBe(0);
+    });
+
+    it("point.compare should return negative if v1 is shorter than v2", function () {
+        const result = point.compare([2, 4], [2, 4, 3]);
+        expect(result).toBeLessThan(0);
+    });
+
+    it("point.compare should return positive if v1 is longer than v2", function () {
+        const result = point.compare([2, 4, -2], [2, 2]);
+        expect(result).toBeGreaterThan(0);
+    });
+});

package/src/__tests__/vector.test.ts

@@ -0,0 +1,145 @@
+import * as vector from "../vector";
+
+describe("kvector", function () {
+    it("vector.zip should return empty given empty", function () {
+        expect(vector.zip([], [])).toEqual([]);
+    });
+
+    it("vector.zip should create vectors from x and y coords", function () {
+        expect(vector.zip([1, 2], [3, 4])).toEqual([
+            [1, 3],
+            [2, 4],
+        ]);
+    });
+
+    it("vector.zip should ignore extra xs", function () {
+        expect(vector.zip([1, 2, 9], [3, 4])).toEqual([
+            [1, 3],
+            [2, 4],
+        ]);
+    });
+
+    it("vector.zip should ignore extra ys", function () {
+        expect(vector.zip([1, 2], [3, 4, 9])).toEqual([
+            [1, 3],
+            [2, 4],
+        ]);
+    });
+
+    it("vector.map should transform a 2D vector", function () {
+        const double = (x) => x * 2;
+        expect(vector.map([3, 4], double)).toEqual([6, 8]);
+    });
+
+    it("vector.map should pass the index of each element to the callback", function () {
+        expect(vector.map([3, 4], (_, i) => i)).toEqual([0, 1]);
+    });
+
+    it("vector.add should add two 2D vectors", function () {
+        const result = vector.add([1, 2], [3, 4]);
+        expect(result).toStrictEqual([4, 6]);
+    });
+
+    it("vector.add should add two 3D vectors", function () {
+        const result = vector.add([1, 2, 3], [4, 5, 6]);
+        expect(result).toStrictEqual([5, 7, 9]);
+    });
+
+    it("vector.add should add three 2D vectors", function () {
+        const result = vector.add([1, 2], [3, 4], [5, 6]);
+        expect(result).toStrictEqual([9, 12]);
+    });
+
+    it("vector.subtract should subtract two 2D vectors", function () {
+        const result = vector.subtract([1, 2], [3, 4]);
+        expect(result).toStrictEqual([-2, -2]);
+    });
+
+    it("vector.subtract should subtract two 3D vectors", function () {
+        const result = vector.subtract([1, 2, 3], [4, 5, 6]);
+        expect(result).toStrictEqual([-3, -3, -3]);
+    });
+
+    it("vector.dot should take the dot product of 2 2D vectors", function () {
+        const result = vector.dot([1, 2], [3, 4]);
+        expect(result).toBe(3 + 8);
+    });
+
+    it("vector.dot should take the dot product of 2 3D vectors", function () {
+        const result = vector.dot([1, 2, 3], [4, 5, 6]);
+        expect(result).toBe(4 + 10 + 18);
+    });
+
+    it("vector.scale should scale a 2D vector", function () {
+        const result = vector.scale([4, 2], 0.5);
+        expect(result).toStrictEqual([2, 1]);
+    });
+
+    it("vector.scale should scale a 3D vector", function () {
+        const result = vector.scale([1, 2, 3], 2);
+        expect(result).toStrictEqual([2, 4, 6]);
+    });
+
+    it("vector.length should take the length of a 2D vector", function () {
+        const result = vector.length([3, 4]);
+        expect(result).toBe(5);
+    });
+
+    it("vector.length should take the length of a 3D vector", function () {
+        const result = vector.length([4, 0, 3]);
+        expect(result).toBe(5);
+    });
+
+    it("vector.equal should return true on two equal 3D vectors", function () {
+        const result = vector.equal([6, 3, 4], [6, 3, 4]);
+        expect(result).toBe(true);
+    });
+
+    it("vector.equal should return false on two inequal 3D vectors", function () {
+        const result = vector.equal([6, 3, 4], [6, 4, 4]);
+        expect(result).toBe(false);
+    });
+
+    it("vector.equal should return false on a 2D and 3D vector", function () {
+        const result = vector.equal([6, 4], [6, 4, 4]);
+        expect(result).toBe(false);
+    });
+
+    it("vector.equal should return false on a 2D and 3D vector", function () {
+        const result = vector.equal([6, 3, 4], [6, 3]);
+        expect(result).toBe(false);
+    });
+
+    it("vector.equal should return false on a 2D and 3D vector with a trailing 0", function () {
+        const result = vector.equal([6, 3, 0], [6, 3]);
+        expect(result).toBe(false);
+    });
+
+    it(
+        "vector.collinear should return true on two collinear vectors of " +
+            "the same magnitude but different direction",
+        function () {
+            const result = vector.collinear([3, 3], [-3, -3]);
+            expect(result).toBe(true);
+        },
+    );
+
+    it(
+        "vector.collinear should return true on two collinear vectors of " +
+            "different magnitudes",
+        function () {
+            const result = vector.collinear([2, 1], [6, 3]);
+            expect(result).toBe(true);
+        },
+    );
+
+    it("vector.collinear should return false on non-collinear vectors", function () {
+        const result = vector.collinear([1, 2], [-1, 2]);
+        expect(result).toBe(false);
+    });
+
+    it("vector.negate of [-2, 2] is [2, -2]", function () {
+        const result = vector.negate([-2, 2]);
+        expect(result).toStrictEqual([2, -2]);
+    });
+});

package/src/index.ts

@@ -0,0 +1,7 @@
+export {libVersion} from "./version";
+
+export * as number from "./number";
+export * as vector from "./vector";
+export * as point from "./point";
+export * as line from "./line";
+export * as ray from "./ray";

package/src/line.ts

@@ -0,0 +1,42 @@
+/**
+ * Line Utils
+ * A line is an array of two points e.g. [[-5, 0], [5, 0]].
+ */
+
+import * as kpoint from "./point";
+import * as kvector from "./vector";
+
+import type {Point} from "./point";
+
+export type Line = [Point, Point];
+
+export function distanceToPoint(line: Line, point: Point): number {
+    return kpoint.distanceToLine(point, line);
+}
+
+export function reflectPoint(line: Line, point: Point): Point {
+    return kpoint.reflectOverLine(point, line);
+}
+
+export function midpoint(line: Line): Point {
+    return [(line[0][0] + line[1][0]) / 2, (line[0][1] + line[1][1]) / 2];
+}
+
+export function equal(line1: Line, line2: Line, tolerance?: number): boolean {
+    // TODO: A nicer implementation might just check collinearity of
+    // vectors using underscore magick
+    // Compare the directions of the lines
+    const v1 = kvector.subtract(line1[1], line1[0]);
+    const v2 = kvector.subtract(line2[1], line2[0]);
+    if (!kvector.collinear(v1, v2, tolerance)) {
+        return false;
+    }
+    // If the start point is the same for the two lines, then they are the same
+    if (kpoint.equal(line1[0], line2[0])) {
+        return true;
+    }
+    // Make sure that the direction to get from line1 to
+    // line2 is the same as the direction of the lines
+    const line1ToLine2Vector = kvector.subtract(line2[0], line1[0]);
+    return kvector.collinear(v1, line1ToLine2Vector, tolerance);
+}