@js-draw/math 1.0.0 → 1.0.2

package/src/Vec2.ts

@@ -0,0 +1,49 @@
+import Vec3 from './Vec3';
+
+/**
+ * Utility functions that facilitate treating `Vec3`s as 2D vectors.
+ *
+ * @example
+ * ```ts,runnable,console
+ * import { Vec2 } from '@js-draw/math';
+ * console.log(Vec2.of(1, 2));
+ * ```
+ */
+export namespace Vec2 {
+	/**
+	 * Creates a `Vec2` from an x and y coordinate.
+	 *
+	 * For example,
+	 * ```ts
+	 * const v = Vec2.of(3, 4); // x=3, y=4.
+	 * ```
+	 */
+	export const of = (x: number, y: number): Vec2 => {
+		return Vec3.of(x, y, 0);
+	};
+
+	/**
+	 * Creates a `Vec2` from an object containing x and y coordinates.
+	 *
+	 * For example,
+	 * ```ts
+	 * const v1 = Vec2.ofXY({ x: 3, y: 4.5 });
+	 * const v2 = Vec2.ofXY({ x: -123.4, y: 1 });
+	 * ```
+	 */
+	export const ofXY = ({x, y}: { x: number, y: number }): Vec2 => {
+		return Vec3.of(x, y, 0);
+	};
+
+	/** A vector of length 1 in the X direction (→). */
+	export const unitX = Vec2.of(1, 0);
+
+	/** A vector of length 1 in the Y direction (↑). */
+	export const unitY = Vec2.of(0, 1);
+
+	/** The zero vector: A vector with x=0, y=0. */
+	export const zero = Vec2.of(0, 0);
+}
+
+export type Point2 = Vec3;
+export type Vec2 = Vec3; // eslint-disable-line

package/src/Vec3.test.ts

@@ -0,0 +1,51 @@
+
+import Vec3 from './Vec3';
+
+describe('Vec3', () => {
+	it('.xy should contain the x and y components', () => {
+		const vec = Vec3.of(1, 2, 3);
+		expect(vec.xy).toMatchObject({
+			x: 1,
+			y: 2,
+		});
+	});
+
+	it('should be combinable with other vectors via .zip', () => {
+		const vec1 = Vec3.unitX;
+		const vec2 = Vec3.unitY;
+		expect(vec1.zip(vec2, Math.min)).objEq(Vec3.zero);
+		expect(vec1.zip(vec2, Math.max)).objEq(Vec3.of(1, 1, 0));
+	});
+
+	it('.cross should obey the right hand rule', () => {
+		const vec1 = Vec3.unitX;
+		const vec2 = Vec3.unitY;
+		expect(vec1.cross(vec2)).objEq(Vec3.unitZ);
+		expect(vec2.cross(vec1)).objEq(Vec3.unitZ.times(-1));
+	});
+
+	it('.orthog should return an orthogonal vector', () => {
+		expect(Vec3.unitZ.orthog().dot(Vec3.unitZ)).toBe(0);
+
+		// Should return some orthogonal vector, even if given the zero vector
+		expect(Vec3.zero.orthog().dot(Vec3.zero)).toBe(0);
+	});
+
+	it('.minus should return the difference between two vectors', () => {
+		expect(Vec3.of(1, 2, 3).minus(Vec3.of(4, 5, 6))).objEq(Vec3.of(1 - 4, 2 - 5, 3 - 6));
+	});
+
+	it('.orthog should return a unit vector', () => {
+		expect(Vec3.zero.orthog().magnitude()).toBe(1);
+		expect(Vec3.unitZ.orthog().magnitude()).toBe(1);
+		expect(Vec3.unitX.orthog().magnitude()).toBe(1);
+		expect(Vec3.unitY.orthog().magnitude()).toBe(1);
+	});
+
+	it('.normalizedOrZero should normalize the given vector or return zero', () => {
+		expect(Vec3.zero.normalizedOrZero()).objEq(Vec3.zero);
+		expect(Vec3.unitX.normalizedOrZero()).objEq(Vec3.unitX);
+		expect(Vec3.unitX.times(22).normalizedOrZero()).objEq(Vec3.unitX);
+		expect(Vec3.of(1, 1, 1).times(22).normalizedOrZero().length()).toBeCloseTo(1);
+	});
+});

package/src/Vec3.ts

@@ -0,0 +1,245 @@
+
+
+/**
+ * A vector with three components, $\begin{pmatrix} x \\ y \\ z \end{pmatrix}$.
+ * Can also be used to represent a two-component vector.
+ *
+ * A `Vec3` is immutable.
+ *
+ * @example
+ *
+ * ```ts,runnable,console
+ * import { Vec3 } from '@js-draw/math';
+ *
+ * console.log('Vector addition:', Vec3.of(1, 2, 3).plus(Vec3.of(0, 1, 0)));
+ * console.log('Scalar multiplication:', Vec3.of(1, 2, 3).times(2));
+ * console.log('Cross products:', Vec3.unitX.cross(Vec3.unitY));
+ * console.log('Magnitude:', Vec3.of(1, 2, 3).length(), 'or', Vec3.of(1, 2, 3).magnitude());
+ * console.log('Square Magnitude:', Vec3.of(1, 2, 3).magnitudeSquared());
+ * console.log('As an array:', Vec3.unitZ.asArray());
+ * ```
+ */
+export class Vec3 {
+	private constructor(
+		public readonly x: number,
+		public readonly y: number,
+		public readonly z: number
+	) {
+	}
+
+	/** Returns the x, y components of this. */
+	public get xy(): { x: number; y: number } {
+		// Useful for APIs that behave differently if .z is present.
+		return {
+			x: this.x,
+			y: this.y,
+		};
+	}
+
+	/** Construct a vector from three components. */
+	public static of(x: number, y: number, z: number): Vec3 {
+		return new Vec3(x, y, z);
+	}
+
+	/** Returns this' `idx`th component. For example, `Vec3.of(1, 2, 3).at(1) → 2`. */
+	public at(idx: number): number {
+		if (idx === 0) return this.x;
+		if (idx === 1) return this.y;
+		if (idx === 2) return this.z;
+
+		throw new Error(`${idx} out of bounds!`);
+	}
+
+	/** Alias for this.magnitude. */
+	public length(): number {
+		return this.magnitude();
+	}
+
+	public magnitude(): number {
+		return Math.sqrt(this.dot(this));
+	}
+
+	public magnitudeSquared(): number {
+		return this.dot(this);
+	}
+
+	/**
+	 * Return this' angle in the XY plane (treats this as a Vec2).
+	 *
+	 * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+	 */
+	public angle(): number {
+		return Math.atan2(this.y, this.x);
+	}
+
+	/**
+	 * Returns a unit vector in the same direction as this.
+	 *
+	 * If `this` has zero length, the resultant vector has `NaN` components.
+	 */
+	public normalized(): Vec3 {
+		const norm = this.magnitude();
+		return Vec3.of(this.x / norm, this.y / norm, this.z / norm);
+	}
+
+	/**
+	 * Like {@link normalized}, except returns zero if this has zero magnitude.
+	 */
+	public normalizedOrZero(): Vec3 {
+		if (this.eq(Vec3.zero)) {
+			return Vec3.zero;
+		}
+
+		return this.normalized();
+	}
+
+	/** @returns A copy of `this` multiplied by a scalar. */
+	public times(c: number): Vec3 {
+		return Vec3.of(this.x * c, this.y * c, this.z * c);
+	}
+
+	public plus(v: Vec3): Vec3 {
+		return Vec3.of(this.x + v.x, this.y + v.y, this.z + v.z);
+	}
+
+	public minus(v: Vec3): Vec3 {
+		return Vec3.of(this.x - v.x, this.y - v.y, this.z - v.z);
+	}
+
+	public dot(other: Vec3): number {
+		return this.x * other.x + this.y * other.y + this.z * other.z;
+	}
+
+	public cross(other: Vec3): Vec3 {
+		// | i  j  k |
+		// | x1 y1 z1| = (i)(y1z2 - y2z1) - (j)(x1z2 - x2z1) + (k)(x1y2 - x2y1)
+		// | x2 y2 z2|
+		return Vec3.of(
+			this.y * other.z - other.y * this.z,
+			other.x * this.z - this.x * other.z,
+			this.x * other.y - other.x * this.y
+		);
+	}
+
+	/**
+	 * If `other` is a `Vec3`, multiplies `this` component-wise by `other`. Otherwise,
+	 * if `other is a `number`, returns the result of scalar multiplication.
+	 *
+	 * @example
+	 * ```
+	 * Vec3.of(1, 2, 3).scale(Vec3.of(2, 4, 6)); // → Vec3(2, 8, 18)
+	 * ```
+	 */
+	public scale(other: Vec3|number): Vec3 {
+		if (typeof other === 'number') {
+			return this.times(other);
+		}
+
+		return Vec3.of(
+			this.x * other.x,
+			this.y * other.y,
+			this.z * other.z,
+		);
+	}
+
+	/**
+	 * Returns a vector orthogonal to this. If this is a Vec2, returns `this` rotated
+	 * 90 degrees counter-clockwise.
+	 */
+	public orthog(): Vec3 {
+		// If parallel to the z-axis
+		if (this.dot(Vec3.unitX) === 0 && this.dot(Vec3.unitY) === 0) {
+			return this.dot(Vec3.unitX) === 0 ? Vec3.unitX : this.cross(Vec3.unitX).normalized();
+		}
+
+		return this.cross(Vec3.unitZ.times(-1)).normalized();
+	}
+
+	/** Returns this plus a vector of length `distance` in `direction`. */
+	public extend(distance: number, direction: Vec3): Vec3 {
+		return this.plus(direction.normalized().times(distance));
+	}
+
+	/** Returns a vector `fractionTo` of the way to target from this. */
+	public lerp(target: Vec3, fractionTo: number): Vec3 {
+		return this.times(1 - fractionTo).plus(target.times(fractionTo));
+	}
+
+	/**
+	 * `zip` Maps a component of this and a corresponding component of
+	 * `other` to a component of the output vector.
+	 *
+	 * @example
+	 * ```
+	 * const a = Vec3.of(1, 2, 3);
+	 * const b = Vec3.of(0.5, 2.1, 2.9);
+	 *
+	 * const zipped = a.zip(b, (aComponent, bComponent) => {
+	 *   return Math.min(aComponent, bComponent);
+	 * });
+	 *
+	 * console.log(zipped.toString()); // → Vec(0.5, 2, 2.9)
+	 * ```
+	 */
+	public zip(
+		other: Vec3, zip: (componentInThis: number, componentInOther: number)=> number
+	): Vec3 {
+		return Vec3.of(
+			zip(other.x, this.x),
+			zip(other.y, this.y),
+			zip(other.z, this.z)
+		);
+	}
+
+	/**
+	 * Returns a vector with each component acted on by `fn`.
+	 *
+	 * @example
+	 * ```
+	 * console.log(Vec3.of(1, 2, 3).map(val => val + 1)); // → Vec(2, 3, 4)
+	 * ```
+	 */
+	public map(fn: (component: number, index: number)=> number): Vec3 {
+		return Vec3.of(
+			fn(this.x, 0), fn(this.y, 1), fn(this.z, 2)
+		);
+	}
+
+	public asArray(): [ number, number, number ] {
+		return [this.x, this.y, this.z];
+	}
+
+	/**
+	 * [fuzz] The maximum difference between two components for this and [other]
+	 * to be considered equal.
+	 *
+	 * @example
+	 * ```
+	 * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 100);  // → true
+	 * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 0.1);  // → false
+	 * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3);    // → true
+	 * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3.01); // → true
+	 * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 2.99); // → false
+	 * ```
+	 */
+	public eq(other: Vec3, fuzz: number = 1e-10): boolean {
+		for (let i = 0; i < 3; i++) {
+			if (Math.abs(other.at(i) - this.at(i)) > fuzz) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	public toString(): string {
+		return `Vec(${this.x}, ${this.y}, ${this.z})`;
+	}
+
+
+	public static unitX = Vec3.of(1, 0, 0);
+	public static unitY = Vec3.of(0, 1, 0);
+	public static unitZ = Vec3.of(0, 0, 1);
+	public static zero = Vec3.of(0, 0, 0);
+}
+export default Vec3;

package/src/lib.ts

@@ -0,0 +1,42 @@
+/**
+ * ```ts,runnable,console
+ * import { Vec2, Mat33, Rect2 } from '@js-draw/math';
+ *
+ * // Example: Rotate a vector 90 degrees about the z-axis
+ * const rotate90Degrees = Mat33.zRotation(Math.PI/2); // π/2 radians = 90 deg
+ * const moveUp = Mat33.translation(Vec2.of(1, 0));
+ * const moveUpThenRotate = rotate90Degrees.rightMul(moveUp);
+ * console.log(moveUpThenRotate.transformVec2(Vec2.of(1, 2)));
+ *
+ * // Example: Bounding box of some points
+ * console.log(Rect2.bboxOf([
+ *   Vec2.of(1, 2), Vec2.of(3, 4), Vec2.of(-100, 1000),
+ * ]));
+ * ```
+ *
+ * @packageDocumentation
+ */
+
+export { LineSegment2 } from './shapes/LineSegment2';
+export {
+	Path,
+
+	PathCommandType,
+	PathCommand,
+	LinePathCommand,
+	MoveToPathCommand,
+	QuadraticBezierPathCommand,
+	CubicBezierPathCommand,
+} from './shapes/Path';
+export { Rect2 } from './shapes/Rect2';
+export { QuadraticBezier } from './shapes/QuadraticBezier';
+
+export { Mat33, Mat33Array } from './Mat33';
+export { Point2, Vec2 } from './Vec2';
+export { Vec3 } from './Vec3';
+export { Color4 } from './Color4';
+export { toRoundedString } from './rounding';
+
+
+// Note: All above exports cannot use `export { default as ... } from "..."` because this
+// breaks TypeDoc -- TypeDoc otherwise labels any imports of these classes as `default`.

package/src/polynomial/solveQuadratic.test.ts

@@ -0,0 +1,39 @@
+
+import solveQuadratic from './solveQuadratic';
+
+describe('solveQuadratic', () => {
+	it('should solve linear equations', () => {
+		expect(solveQuadratic(0, 1, 2)).toMatchObject([ -2, -2 ]);
+		expect(solveQuadratic(0, 0, 2)[0]).toBeNaN();
+	});
+
+	it('should return both solutions to quadratic equations', () => {
+		type TestCase = [[number, number, number], [number, number]];
+
+		const testCases: TestCase[] = [
+			[ [ 1, 0, 0 ], [ 0, 0 ] ],
+			[ [ 2, 0, 0 ], [ 0, 0 ] ],
+
+			[ [ 1, 0, -1 ], [ 1, -1 ] ],
+			[ [ 1, 0, -4 ], [ 2, -2 ] ],
+			[ [ 1, 0, 4 ], [ NaN, NaN ] ],
+
+			[ [ 1, 1, 0 ], [ 0, -1 ] ],
+			[ [ 1, 2, 0 ], [ 0, -2 ] ],
+
+			[ [ 1, 2, 1 ], [ -1, -1 ] ],
+			[ [ -9, 2, 1/3 ], [ 1/3, -1/9 ] ],
+		];
+
+		for (const [ testCase, solution ] of testCases) {
+			const foundSolutions = solveQuadratic(...testCase);
+			for (let i = 0; i < 2; i++) {
+				if (isNaN(solution[i]) && isNaN(foundSolutions[i])) {
+					expect(foundSolutions[i]).toBeNaN();
+				} else {
+					expect(foundSolutions[i]).toBeCloseTo(solution[i]);
+				}
+			}
+		}
+	});
+});

package/src/polynomial/solveQuadratic.ts

@@ -0,0 +1,43 @@
+
+/**
+ * Solves an equation of the form ax² + bx + c = 0.
+ * The larger solution is returned first.
+ *
+ * If there are no solutions, returns `[NaN, NaN]`. If there is one solution,
+ * repeats the solution twice in the result.
+ */
+const solveQuadratic = (a: number, b: number, c: number): [number, number] => {
+	// See also https://en.wikipedia.org/wiki/Quadratic_formula
+
+	if (a === 0) {
+		let solution;
+
+		if (b === 0) {
+			solution = c === 0 ? 0 : NaN;
+		} else {
+			// Then we have bx + c = 0
+			// which implies bx = -c.
+			// Thus, x = -c/b
+			solution = -c / b;
+		}
+
+		return [ solution, solution ];
+	}
+
+	const discriminant = b * b - 4 * a * c;
+
+	if (discriminant < 0) {
+		return [ NaN, NaN ];
+	}
+
+	const rootDiscriminant = Math.sqrt(discriminant);
+	const solution1 = (-b + rootDiscriminant) / (2 * a);
+	const solution2 = (-b - rootDiscriminant) / (2 * a);
+
+	if (solution1 > solution2) {
+		return [ solution1, solution2 ];
+	} else {
+		return [ solution2, solution1 ];
+	}
+};
+export default solveQuadratic;

package/src/rounding.test.ts

@@ -0,0 +1,65 @@
+import { cleanUpNumber, toRoundedString, toStringOfSamePrecision } from './rounding';
+
+describe('toRoundedString', () => {
+	it('should round up numbers endings similar to .999999999999999', () => {
+		expect(toRoundedString(0.999999999)).toBe('1');
+		expect(toRoundedString(0.899999999)).toBe('.9');
+		expect(toRoundedString(9.999999999)).toBe('10');
+		expect(toRoundedString(-10.999999999)).toBe('-11');
+	});
+
+	it('should round up numbers similar to 10.999999998', () => {
+		expect(toRoundedString(10.999999998)).toBe('11');
+	});
+
+	it('should round strings with multiple digits after the ending decimal points', () => {
+		expect(toRoundedString(292.2 - 292.8)).toBe('-.6');
+		expect(toRoundedString(4.06425600000023)).toBe('4.064256');
+	});
+
+	it('should round down strings ending endings similar to .00000001', () => {
+		expect(toRoundedString(10.00000001)).toBe('10');
+		expect(toRoundedString(-30.00000001)).toBe('-30');
+		expect(toRoundedString(-14.20000000000002)).toBe('-14.2');
+	});
+
+	it('should not round numbers insufficiently close to the next', () => {
+		expect(toRoundedString(-10.9999)).toBe('-10.9999');
+		expect(toRoundedString(-10.0001)).toBe('-10.0001');
+		expect(toRoundedString(-10.123499)).toBe('-10.123499');
+		expect(toRoundedString(0.00123499)).toBe('.00123499');
+	});
+});
+
+it('toStringOfSamePrecision', () => {
+	expect(toStringOfSamePrecision(1.23456, '1.12')).toBe('1.23');
+	expect(toStringOfSamePrecision(1.23456, '1.120')).toBe('1.235');
+	expect(toStringOfSamePrecision(1.23456, '1.1')).toBe('1.2');
+	expect(toStringOfSamePrecision(1.23456, '1.1', '5.32')).toBe('1.23');
+	expect(toStringOfSamePrecision(-1.23456, '1.1', '5.32')).toBe('-1.23');
+	expect(toStringOfSamePrecision(-1.99999, '1.1', '5.32')).toBe('-2');
+	expect(toStringOfSamePrecision(1.99999, '1.1', '5.32')).toBe('2');
+	expect(toStringOfSamePrecision(1.89999, '1.1', '5.32')).toBe('1.9');
+	expect(toStringOfSamePrecision(9.99999999, '-1.1234')).toBe('10');
+	expect(toStringOfSamePrecision(9.999999998999996, '100')).toBe('10');
+	expect(toStringOfSamePrecision(0.000012345, '0.000012')).toBe('.000012');
+	expect(toStringOfSamePrecision(0.000012645, '.000012')).toBe('.000013');
+	expect(toStringOfSamePrecision(-0.09999999999999432, '291.3')).toBe('-.1');
+	expect(toStringOfSamePrecision(-0.9999999999999432, '291.3')).toBe('-1');
+	expect(toStringOfSamePrecision(9998.9, '.1', '-11')).toBe('9998.9');
+	expect(toStringOfSamePrecision(-14.20000000000002, '.000001', '-11')).toBe('-14.2');
+});
+
+it('cleanUpNumber', () => {
+	expect(cleanUpNumber('000.0000')).toBe('0');
+	expect(cleanUpNumber('-000.0000')).toBe('0');
+	expect(cleanUpNumber('0.0000')).toBe('0');
+	expect(cleanUpNumber('0.001')).toBe('.001');
+	expect(cleanUpNumber('-0.001')).toBe('-.001');
+	expect(cleanUpNumber('-0.000000001')).toBe('-.000000001');
+	expect(cleanUpNumber('-0.00000000100')).toBe('-.000000001');
+	expect(cleanUpNumber('1234')).toBe('1234');
+	expect(cleanUpNumber('1234.5')).toBe('1234.5');
+	expect(cleanUpNumber('1234.500')).toBe('1234.5');
+	expect(cleanUpNumber('1.1368683772161603e-13')).toBe('0');
+});

package/src/rounding.ts

@@ -0,0 +1,167 @@
+// @packageDocumentation @internal
+
+// Clean up stringified numbers
+export const cleanUpNumber = (text: string) => {
+	// Regular expression substitions can be somewhat expensive. Only do them
+	// if necessary.
+
+	if (text.indexOf('e') > 0) {
+		// Round to zero.
+		if (text.match(/[eE][-]\d{2,}$/)) {
+			return '0';
+		}
+	}
+
+	const lastChar = text.charAt(text.length - 1);
+	if (lastChar === '0' || lastChar === '.') {
+		// Remove trailing zeroes
+		text = text.replace(/([.]\d*[^0]+)0+$/, '$1');
+		text = text.replace(/[.]0+$/, '.');
+
+		// Remove trailing period
+		text = text.replace(/[.]$/, '');
+	}
+
+	const firstChar = text.charAt(0);
+	if (firstChar === '0' || firstChar === '-') {
+		// Remove unnecessary leading zeroes.
+		text = text.replace(/^(0+)[.]/, '.');
+		text = text.replace(/^-(0+)[.]/, '-.');
+		text = text.replace(/^(-?)0+$/, '$10');
+	}
+
+	if (text === '-0') {
+		return '0';
+	}
+
+	return text;
+};
+
+/**
+ * Converts `num` to a string, removing trailing digits that were likely caused by
+ * precision errors.
+ *
+ * @example
+ * ```ts,runnable,console
+ * import { toRoundedString } from '@js-draw/math';
+ *
+ * console.log('Rounded: ', toRoundedString(1.000000011));
+ * ```
+ */
+export const toRoundedString = (num: number): string => {
+	// Try to remove rounding errors. If the number ends in at least three/four zeroes
+	// (or nines) just one or two digits, it's probably a rounding error.
+	const fixRoundingUpExp = /^([-]?\d*\.\d{3,})0{4,}\d{1,4}$/;
+	const hasRoundingDownExp = /^([-]?)(\d*)\.(\d{3,}9{4,})\d{1,4}$/;
+
+	let text = num.toString(10);
+	if (text.indexOf('.') === -1) {
+		return text;
+	}
+
+	const roundingDownMatch = hasRoundingDownExp.exec(text);
+	if (roundingDownMatch) {
+		const negativeSign = roundingDownMatch[1];
+		const postDecimalString = roundingDownMatch[3];
+		const lastDigit = parseInt(postDecimalString.charAt(postDecimalString.length - 1), 10);
+		const postDecimal = parseInt(postDecimalString, 10);
+		const preDecimal = parseInt(roundingDownMatch[2], 10);
+
+		const origPostDecimalString = roundingDownMatch[3];
+
+		let newPostDecimal = (postDecimal + 10 - lastDigit).toString();
+		let carry = 0;
+		if (newPostDecimal.length > postDecimal.toString().length) {
+			// Left-shift
+			newPostDecimal = newPostDecimal.substring(1);
+			carry = 1;
+		}
+
+		// parseInt(...).toString() removes leading zeroes. Add them back.
+		while (newPostDecimal.length < origPostDecimalString.length) {
+			newPostDecimal = carry.toString(10) + newPostDecimal;
+			carry = 0;
+		}
+
+		text = `${negativeSign + (preDecimal + carry).toString()}.${newPostDecimal}`;
+	}
+
+	text = text.replace(fixRoundingUpExp, '$1');
+
+	return cleanUpNumber(text);
+};
+
+const numberExp = /^([-]?)(\d*)[.](\d+)$/;
+export const getLenAfterDecimal = (numberAsString: string) => {
+	const numberMatch = numberExp.exec(numberAsString);
+	if (!numberMatch) {
+		// If not a match, either the number is exponential notation (or is something
+		// like NaN or Infinity)
+		if (numberAsString.search(/[eE]/) !== -1 || /^[a-zA-Z]+$/.exec(numberAsString)) {
+			return -1;
+		// Or it has no decimal point
+		} else {
+			return 0;
+		}
+	}
+
+	const afterDecimalLen = numberMatch[3].length;
+	return afterDecimalLen;
+};
+
+// [reference] should be a string representation of a base-10 number (no exponential (e.g. 10e10))
+export const toStringOfSamePrecision = (num: number, ...references: string[]): string => {
+	const text = num.toString(10);
+	const textMatch = numberExp.exec(text);
+	if (!textMatch) {
+		return text;
+	}
+
+	let decimalPlaces = -1;
+	for (const reference of references) {
+		decimalPlaces = Math.max(getLenAfterDecimal(reference), decimalPlaces);
+	}
+
+	if (decimalPlaces === -1) {
+		return toRoundedString(num);
+	}
+
+	// Make text's after decimal length match [afterDecimalLen].
+	let postDecimal = textMatch[3].substring(0, decimalPlaces);
+	let preDecimal = textMatch[2];
+	const nextDigit = textMatch[3].charAt(decimalPlaces);
+
+	if (nextDigit !== '') {
+		const asNumber = parseInt(nextDigit, 10);
+		if (asNumber >= 5) {
+			// Don't attempt to parseInt() an empty string.
+			if (postDecimal.length > 0) {
+				const leadingZeroMatch = /^(0+)(\d*)$/.exec(postDecimal);
+
+				let leadingZeroes = '';
+				let postLeading = postDecimal;
+				if (leadingZeroMatch) {
+					leadingZeroes = leadingZeroMatch[1];
+					postLeading = leadingZeroMatch[2];
+				}
+
+				postDecimal = (parseInt(postDecimal) + 1).toString();
+
+				// If postDecimal got longer, remove leading zeroes if possible
+				if (postDecimal.length > postLeading.length && leadingZeroes.length > 0) {
+					leadingZeroes = leadingZeroes.substring(1);
+				}
+
+				postDecimal = leadingZeroes + postDecimal;
+			}
+
+			if (postDecimal.length === 0 || postDecimal.length > decimalPlaces) {
+				preDecimal = (parseInt(preDecimal) + 1).toString();
+				postDecimal = postDecimal.substring(1);
+			}
+		}
+	}
+
+	const negativeSign = textMatch[1];
+	return cleanUpNumber(`${negativeSign}${preDecimal}.${postDecimal}`);
+};