@khanacademy/kmath 0.0.8 → 0.1.0

package/dist/number.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Number Utils
+ * A number is a js-number, e.g. 5.12
+ */
+export declare const DEFAULT_TOLERANCE = 1e-9;
+export declare const EPSILON: number;
+export declare function is(x: any): boolean;
+export declare function equal(x: number, y: number, tolerance?: number): boolean;
+export declare function sign(x: number, tolerance?: number): number;
+export declare function isInteger(num: number, tolerance?: number): boolean;
+export declare function round(num: number, precision: number): number;
+export declare function roundTo(num: number, increment: number): number;
+export declare function floorTo(num: number, increment: number): number;
+export declare function ceilTo(num: number, increment: number): number;
+/**
+ * toFraction
+ *
+ * Returns a [numerator, denominator] array rational representation
+ * of `decimal`
+ *
+ * See http://en.wikipedia.org/wiki/Continued_fraction for implementation
+ * details
+ *
+ * toFraction(4/8) => [1, 2]
+ * toFraction(0.66) => [33, 50]
+ * toFraction(0.66, 0.01) => [2/3]
+ * toFraction(283 + 1/3) => [850, 3]
+ */
+export declare function toFraction(decimal: number, tolerance?: number, maxDenominator?: number): [number, number];

package/dist/number.js.flow

@@ -0,0 +1,44 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * Number Utils
+ * A number is a js-number, e.g. 5.12
+ */
+declare export var DEFAULT_TOLERANCE: 1e-9;
+declare export var EPSILON: number;
+declare export function is(x: any): boolean;
+declare export function equal(
+  x: number,
+  y: number,
+  tolerance?: number
+): boolean;
+declare export function sign(x: number, tolerance?: number): number;
+declare export function isInteger(num: number, tolerance?: number): boolean;
+declare export function round(num: number, precision: number): number;
+declare export function roundTo(num: number, increment: number): number;
+declare export function floorTo(num: number, increment: number): number;
+declare export function ceilTo(num: number, increment: number): number;
+
+/**
+ * toFraction
+ *
+ * Returns a [numerator, denominator] array rational representation
+ * of `decimal`
+ *
+ * See http://en.wikipedia.org/wiki/Continued_fraction for implementation
+ * details
+ *
+ * toFraction(4/8) => [1, 2]
+ * toFraction(0.66) => [33, 50]
+ * toFraction(0.66, 0.01) => [2/3]
+ * toFraction(283 + 1/3) => [850, 3]
+ */
+declare export function toFraction(
+  decimal: number,
+  tolerance?: number,
+  maxDenominator?: number
+): [number, number];

package/dist/point.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Point Utils
+ * A point is an array of two numbers e.g. [0, 0].
+ */
+import * as kvector from "./vector";
+export type Point = ReadonlyArray<number>;
+export declare function rotateRad(point: Point, theta: number, center?: Point): Point;
+export declare function rotateDeg(point: Point, theta: number, center?: Point): Point;
+export declare function distanceToPoint(point1: Point, point2: Point): number;
+export declare function distanceToLine(point: Point, line: [Point, Point]): number;
+export declare function reflectOverLine<P extends Point>(point: P, line: [P, P]): P;
+/**
+ * Compares two points, returning -1, 0, or 1, for use with
+ * Array.prototype.sort
+ *
+ * Note: This technically doesn't satisfy the total-ordering
+ * requirements of Array.prototype.sort unless equalityTolerance
+ * is 0. In some cases very close points that compare within a
+ * few equalityTolerances could appear in the wrong order.
+ */
+export declare function compare(point1: Point, point2: Point, equalityTolerance?: number): number;
+export declare const is: typeof kvector.is;
+export declare const addVector: typeof kvector.add;
+export declare const addVectors: typeof kvector.add;
+export declare const subtractVector: typeof kvector.subtract;
+export declare const equal: typeof kvector.equal;
+export declare const polarRadFromCart: typeof kvector.polarRadFromCart;
+export declare const polarDegFromCart: typeof kvector.polarDegFromCart;
+export declare const cartFromPolarRad: typeof kvector.cartFromPolarRad;
+export declare const cartFromPolarDeg: typeof kvector.cartFromPolarDeg;
+export declare const round: typeof kvector.round;
+export declare const roundTo: typeof kvector.roundTo;
+export declare const floorTo: typeof kvector.floorTo;
+export declare const ceilTo: typeof kvector.ceilTo;

package/dist/point.js.flow

@@ -0,0 +1,52 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import * as kvector from "./vector";
+export type Point = $ReadOnlyArray<number>;
+declare export function rotateRad(
+  point: Point,
+  theta: number,
+  center?: Point
+): Point;
+declare export function rotateDeg(
+  point: Point,
+  theta: number,
+  center?: Point
+): Point;
+declare export function distanceToPoint(point1: Point, point2: Point): number;
+declare export function distanceToLine(
+  point: Point,
+  line: [Point, Point]
+): number;
+declare export function reflectOverLine<P: Point>(point: P, line: [P, P]): P;
+
+/**
+ * Compares two points, returning -1, 0, or 1, for use with
+ * Array.prototype.sort
+ *
+ * Note: This technically doesn't satisfy the total-ordering
+ * requirements of Array.prototype.sort unless equalityTolerance
+ * is 0. In some cases very close points that compare within a
+ * few equalityTolerances could appear in the wrong order.
+ */
+declare export function compare(
+  point1: Point,
+  point2: Point,
+  equalityTolerance?: number
+): number;
+declare export var is: typeof kvector.is;
+declare export var addVector: typeof kvector.add;
+declare export var addVectors: typeof kvector.add;
+declare export var subtractVector: typeof kvector.subtract;
+declare export var equal: typeof kvector.equal;
+declare export var polarRadFromCart: typeof kvector.polarRadFromCart;
+declare export var polarDegFromCart: typeof kvector.polarDegFromCart;
+declare export var cartFromPolarRad: typeof kvector.cartFromPolarRad;
+declare export var cartFromPolarDeg: typeof kvector.cartFromPolarDeg;
+declare export var round: typeof kvector.round;
+declare export var roundTo: typeof kvector.roundTo;
+declare export var floorTo: typeof kvector.floorTo;
+declare export var ceilTo: typeof kvector.ceilTo;

package/dist/ray.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Ray Utils
+ * A ray (→) is an array of an endpoint and another point along the ray.
+ * For example, [[0, 0], [1, 0]] is the ray starting at the origin and
+ * traveling along the positive x-axis.
+ */
+import type { Point } from "./point";
+export type Ray = [Point, Point];
+export declare function equal(ray1: Ray, ray2: Ray, tolerance?: number): boolean;

package/dist/ray.js.flow

@@ -0,0 +1,13 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+import type { Point } from "./point";
+export type Ray = [Point, Point];
+declare export function equal(
+  ray1: Ray,
+  ray2: Ray,
+  tolerance?: number
+): boolean;

package/dist/vector.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Vector Utils
+ * A vector is an array of numbers e.g. [0, 3, 4].
+ */
+type Vector = ReadonlyArray<number>;
+/**
+ * Checks if the given vector contains only numbers and, optionally, is of the
+ * right dimension (length).
+ *
+ * is([1, 2, 3]) -> true
+ * is([1, "Hello", 3]) -> false
+ * is([1, 2, 3], 1) -> false
+ */
+export declare function is<T>(vec: ReadonlyArray<T>, dimension?: number): boolean;
+export declare function normalize<V extends Vector>(v: V): V;
+export declare function length(v: Vector): number;
+export declare function dot(a: Vector, b: Vector): number;
+export declare function add<V extends Vector>(...vecs: ReadonlyArray<V>): V;
+export declare function subtract<V extends Vector>(v1: V, v2: V): V;
+export declare function negate<V extends Vector>(v: V): V;
+export declare function scale<V extends Vector>(v1: V, scalar: number): V;
+export declare function equal(v1: Vector, v2: Vector, tolerance?: number): boolean;
+export declare function codirectional(v1: Vector, v2: Vector, tolerance?: number): boolean;
+export declare function collinear(v1: Vector, v2: Vector, tolerance?: number): boolean;
+export declare function polarRadFromCart(v: ReadonlyArray<number>): ReadonlyArray<number>;
+export declare function polarDegFromCart(v: ReadonlyArray<number>): ReadonlyArray<number>;
+export declare function cartFromPolarRad(radius: number, theta?: number): ReadonlyArray<number>;
+export declare function cartFromPolarDeg(radius: number, theta?: number): ReadonlyArray<number>;
+export declare function rotateRad(v: ReadonlyArray<number>, theta: number): ReadonlyArray<number>;
+export declare function rotateDeg(v: ReadonlyArray<number>, theta: number): ReadonlyArray<number>;
+export declare function angleRad(v1: Vector, v2: Vector): number;
+export declare function angleDeg(v1: Vector, v2: Vector): number;
+export declare function projection<V extends Vector>(v1: V, v2: V): V;
+export declare function round<V extends Vector>(vec: V, precision: V | number): V;
+export declare function roundTo<V extends Vector>(vec: V, increment: V | number): V;
+export declare function floorTo<V extends Vector>(vec: V, increment: V | number): V;
+export declare function ceilTo<V extends Vector>(vec: V, increment: V | number): V;
+export {};

package/dist/vector.js.flow

@@ -0,0 +1,74 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+/**
+ * Vector Utils
+ * A vector is an array of numbers e.g. [0, 3, 4].
+ */
+declare type Vector = $ReadOnlyArray<number>;
+/**
+ * Checks if the given vector contains only numbers and, optionally, is of the
+ * right dimension (length).
+ *
+ * is([1, 2, 3]) -> true
+ * is([1, "Hello", 3]) -> false
+ * is([1, 2, 3], 1) -> false
+ */
+declare export function is<T>(
+  vec: $ReadOnlyArray<T>,
+  dimension?: number
+): boolean;
+declare export function normalize<V: Vector>(v: V): V;
+declare export function length(v: Vector): number;
+declare export function dot(a: Vector, b: Vector): number;
+declare export function add<V: Vector>(...vecs: $ReadOnlyArray<V>): V;
+declare export function subtract<V: Vector>(v1: V, v2: V): V;
+declare export function negate<V: Vector>(v: V): V;
+declare export function scale<V: Vector>(v1: V, scalar: number): V;
+declare export function equal(
+  v1: Vector,
+  v2: Vector,
+  tolerance?: number
+): boolean;
+declare export function codirectional(
+  v1: Vector,
+  v2: Vector,
+  tolerance?: number
+): boolean;
+declare export function collinear(
+  v1: Vector,
+  v2: Vector,
+  tolerance?: number
+): boolean;
+declare export function polarRadFromCart(
+  v: $ReadOnlyArray<number>
+): $ReadOnlyArray<number>;
+declare export function polarDegFromCart(
+  v: $ReadOnlyArray<number>
+): $ReadOnlyArray<number>;
+declare export function cartFromPolarRad(
+  radius: number,
+  theta?: number
+): $ReadOnlyArray<number>;
+declare export function cartFromPolarDeg(
+  radius: number,
+  theta?: number
+): $ReadOnlyArray<number>;
+declare export function rotateRad(
+  v: $ReadOnlyArray<number>,
+  theta: number
+): $ReadOnlyArray<number>;
+declare export function rotateDeg(
+  v: $ReadOnlyArray<number>,
+  theta: number
+): $ReadOnlyArray<number>;
+declare export function angleRad(v1: Vector, v2: Vector): number;
+declare export function angleDeg(v1: Vector, v2: Vector): number;
+declare export function projection<V: Vector>(v1: V, v2: V): V;
+declare export function round<V: Vector>(vec: V, precision: V | number): V;
+declare export function roundTo<V: Vector>(vec: V, increment: V | number): V;
+declare export function floorTo<V: Vector>(vec: V, increment: V | number): V;
+declare export function ceilTo<V: Vector>(vec: V, increment: V | number): V;

package/package.json

@@ -3,7 +3,7 @@
     "description": "Khan Academy's Javascript Numeric Math Utilities",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "0.0.8",
+    "version": "0.1.0",
     "publishConfig": {
         "access": "public"
     },
@@ -16,7 +16,7 @@
     },
     "module": "dist/es/index.js",
     "main": "dist/index.js",
-    "source": "src/index.js",
+    "source": "src/index.ts",
     "scripts": {
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },

package/src/__tests__/{line.test.js → line.test.ts}

@@ -1,6 +1,4 @@
-// @flow
-
-import * as line from "../line.js";
+import * as line from "../line";
 
 describe("kline", function () {
     it("finds distance to point", () => {

package/src/__tests__/{number.test.js → number.test.ts}

@@ -1,13 +1,13 @@
-// @flow
+import {describe, it} from "@jest/globals";
 
-import * as number from "../number.js";
+import * as number from "../number";
 
 describe("knumber", function () {
-    it.each([3, Math.PI, 6.28, 5e10, 1 / 0])("is a number: %s", (num) => {
+    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) => {
+    it.each(["10", 0 / 0, NaN])("is not a number:%s", (num: any) => {
         expect(number.is(num)).toBe(false);
     });
 

package/src/__tests__/{point.test.js → point.test.ts}

@@ -1,6 +1,4 @@
-// @flow
-
-import * as point from "../point.js";
+import * as point from "../point";
 
 describe("kpoint", function () {
     it("point.compare should return positive if the first element is larger", function () {

package/src/__tests__/{vector.test.js → vector.test.ts}

@@ -1,6 +1,4 @@
-// @flow
-
-import * as vector from "../vector.js";
+import * as vector from "../vector";
 
 describe("kvector", function () {
     it("vector.add should add two 2D vectors", function () {

package/src/index.ts

@@ -0,0 +1,5 @@
+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.js → line.ts}

@@ -1,13 +1,12 @@
-// @flow
 /**
  * Line Utils
  * A line is an array of two points e.g. [[-5, 0], [5, 0]].
  */
 
-import * as kpoint from "./point.js";
-import * as kvector from "./vector.js";
+import * as kpoint from "./point";
+import * as kvector from "./vector";
 
-import type {Point} from "./point.js";
+import type {Point} from "./point";
 
 export type Line = [Point, Point];
 

package/src/{logo.js → logo.ts}

@@ -1,16 +1,12 @@
 /* eslint-disable import/no-default-export */
-// @flow
 // This file describes the graphie source code of the kmath logo
 // currently used on khan.github.io.
 //
 // Also located at http://ka-perseus-graphie.s3.amazonaws.com/42ef3cbadc3e6464124533191728c3c5c55c7355.svg
 
-// eslint-disable-next-line ft-flow/no-types-missing-file-annotation
-declare var init: $FlowFixMe;
-// eslint-disable-next-line ft-flow/no-types-missing-file-annotation
-declare var ellipse: $FlowFixMe;
-// eslint-disable-next-line ft-flow/no-types-missing-file-annotation
-declare var line: $FlowFixMe;
+declare let init: any;
+declare let ellipse: any;
+declare let line: any;
 
 const GREEN = "#28AE7B";
 

package/src/{number.js → number.ts}

@@ -1,4 +1,3 @@
-// @flow
 /**
  * Number Utils
  * A number is a js-number, e.g. 5.12
@@ -6,7 +5,7 @@
 
 import _ from "underscore";
 
-export const DEFAULT_TOLERANCE: number = 1e-9;
+export const DEFAULT_TOLERANCE = 1e-9;
 
 // TODO: Should this just be Number.Epsilon
 export const EPSILON: number = Math.pow(2, -42);
@@ -78,8 +77,9 @@ export function ceilTo(num: number, increment: number): number {
  */
 export function toFraction(
     decimal: number,
-    tolerance: number = EPSILON, // can't be 0
-    maxDenominator: number = 1000,
+    // can't be 0
+    tolerance: number = EPSILON,
+    maxDenominator = 1000,
 ): [number, number] {
     // Initialize everything to compute successive terms of
     // continued-fraction approximations via recurrence relation

package/src/{point.js → point.ts}

@@ -1,4 +1,3 @@
-// @flow
 /**
  * Point Utils
  * A point is an array of two numbers e.g. [0, 0].
@@ -6,11 +5,11 @@
 
 import _ from "underscore";
 
-import * as knumber from "./number.js";
-import * as kvector from "./vector.js";
+import * as knumber from "./number";
+import * as kvector from "./vector";
 
 // A point, in 2D, 3D, or nD space.
-export type Point = $ReadOnlyArray<number>;
+export type Point = ReadonlyArray<number>;
 
 // Rotate point (around origin unless a center is specified)
 export function rotateRad(point: Point, theta: number, center?: Point): Point {
@@ -50,7 +49,7 @@ export function distanceToLine(point: Point, line: [Point, Point]): number {
 }
 
 // Reflect point over line
-export function reflectOverLine<P: Point>(point: P, line: [P, P]): P {
+export function reflectOverLine<P extends Point>(point: P, line: [P, P]): P {
     const lv = kvector.subtract(line[1], line[0]);
     const pv = kvector.subtract(point, line[0]);
     const projectedPv = kvector.projection(pv, lv);

package/src/{ray.js → ray.ts}

@@ -1,4 +1,3 @@
-// @flow
 /**
  * Ray Utils
  * A ray (→) is an array of an endpoint and another point along the ray.
@@ -6,8 +5,8 @@
  * traveling along the positive x-axis.
  */
 
-import * as kpoint from "./point.js";
-import * as kvector from "./vector.js";
+import * as kpoint from "./point";
+import * as kvector from "./vector";
 
 import type {Point} from "./point";