@khanacademy/kmath 0.0.5 → 0.0.6

package/package.json

@@ -1,10 +1,19 @@
 {
+    "name": "@khanacademy/kmath",
+    "description": "Khan Academy's Javascript Numeric Math Utilities",
+    "author": "Khan Academy",
+    "license": "MIT",
+    "version": "0.0.6",
     "publishConfig": {
         "access": "public"
     },
-    "name": "@khanacademy/kmath",
-    "version": "0.0.5",
-    "description": "Khan Academy's Javascript Numeric Math Utilities",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Khan/kmath.git"
+    },
+    "bugs": {
+        "url": "https://github.com/Khan/perseus/issues"
+    },
     "module": "dist/es/index.js",
     "main": "dist/index.js",
     "source": "src/index.js",
@@ -13,12 +22,11 @@
     },
     "dependencies": {},
     "devDependencies": {
-        "perseus-build-settings": "^0.0.1",
+        "perseus-build-settings": "^0.0.3",
         "underscore": "1.4.4"
     },
     "peerDependencies": {
         "underscore": "1.4.4"
     },
-    "author": "Khan Academy",
-    "license": "MIT"
+    "keywords": []
 }

package/src/logo.js

@@ -1,13 +1,15 @@
+/* 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 flowtype/no-types-missing-file-annotation
+// eslint-disable-next-line ft-flow/no-types-missing-file-annotation
 declare var init: $FlowFixMe;
-// eslint-disable-next-line flowtype/no-types-missing-file-annotation
+// eslint-disable-next-line ft-flow/no-types-missing-file-annotation
 declare var ellipse: $FlowFixMe;
-// eslint-disable-next-line flowtype/no-types-missing-file-annotation
+// eslint-disable-next-line ft-flow/no-types-missing-file-annotation
 declare var line: $FlowFixMe;
 
 const GREEN = "#28AE7B";

package/src/point.js

@@ -6,14 +6,14 @@
 
 import _ from "underscore";
 
-import * as kvector from "./vector.js";
 import * as knumber from "./number.js";
+import * as kvector from "./vector.js";
 
 // A point, in 2D, 3D, or nD space.
 export type Point = $ReadOnlyArray<number>;
 
 // Rotate point (around origin unless a center is specified)
-export function rotateRad(point: Point, theta: number, center: Point): Point {
+export function rotateRad(point: Point, theta: number, center?: Point): Point {
     if (center === undefined) {
         return kvector.rotateRad(point, theta);
     } else {
@@ -24,7 +24,7 @@ export function rotateRad(point: Point, theta: number, center: Point): Point {
     }
 }
 
-export function rotateDeg(point: Point, theta: number, center: Point): Point {
+export function rotateDeg(point: Point, theta: number, center?: Point): Point {
     if (center === undefined) {
         return kvector.rotateDeg(point, theta);
     } else {
@@ -50,7 +50,7 @@ export function distanceToLine(point: Point, line: [Point, Point]): number {
 }
 
 // Reflect point over line
-export function reflectOverLine(point: Point, line: [Point, Point]): Point {
+export function reflectOverLine<P: 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

@@ -6,14 +6,14 @@
  * traveling along the positive x-axis.
  */
 
-import * as kvector from "./vector.js";
 import * as kpoint from "./point.js";
+import * as kvector from "./vector.js";
 
 import type {Point} from "./point";
 
 export type Ray = [Point, Point];
 
-export function equal(ray1: Ray, ray2: Ray, tolerance: number): boolean {
+export function equal(ray1: Ray, ray2: Ray, tolerance?: number): boolean {
     // Compare the directions of the rays
     const v1 = kvector.subtract(ray1[1], ray1[0]);
     const v2 = kvector.subtract(ray2[1], ray2[0]);

package/src/vector.js

@@ -5,6 +5,7 @@
  */
 
 import _ from "underscore";
+
 import * as knumber from "./number.js";
 
 type Vector = $ReadOnlyArray<number>;
@@ -121,6 +122,8 @@ export function collinear(v1: Vector, v2: Vector, tolerance?: number): boolean {
     );
 }
 
+// TODO(jeremy) These coordinate conversion functions really only handle 2D points (ie. [number, number])
+
 // Convert a cartesian coordinate into a radian polar coordinate
 export function polarRadFromCart(
     v: $ReadOnlyArray<number>,
@@ -148,7 +151,6 @@ export function polarDegFromCart(
  *
  * Examples:
  * cartFromPolarRad(5, Math.PI)
- * cartFromPolarRad([5, Math.PI])
  */
 export function cartFromPolarRad(
     radius: number,
@@ -161,7 +163,6 @@ export function cartFromPolarRad(
  *
  * Examples:
  * cartFromPolarDeg(5, 30)
- * cartFromPolarDeg([5, 30])
  */
 export function cartFromPolarDeg(
     radius: number,
@@ -190,25 +191,16 @@ export function rotateDeg(
 }
 
 // Angle between two vectors
-export function angleRad(
-    v1: $ReadOnlyArray<number>,
-    v2: $ReadOnlyArray<number>,
-): number {
+export function angleRad(v1: Vector, v2: Vector): number {
     return Math.acos(dot(v1, v2) / (length(v1) * length(v2)));
 }
 
-export function angleDeg(
-    v1: $ReadOnlyArray<number>,
-    v2: $ReadOnlyArray<number>,
-): number {
+export function angleDeg(v1: Vector, v2: Vector): number {
     return (angleRad(v1, v2) * 180) / Math.PI;
 }
 
 // Vector projection of v1 onto v2
-export function projection(
-    v1: $ReadOnlyArray<number>,
-    v2: $ReadOnlyArray<number>,
-): $ReadOnlyArray<number> {
+export function projection<V: Vector>(v1: V, v2: V): V {
     const scalar = dot(v1, v2) / dot(v2, v2);
     return scale(v2, scalar);
 }