@lakuna/umath 1.3.8 → 1.4.0

package/src/types/AxisAngle.ts

@@ -1,6 +1,9 @@
 import type { Vector3Like } from "../linalg/Vector3.js";
 
-/** An axis and an angle to rotate around it. */
+/**
+ * An axis and an angle to rotate around it.
+ * @public
+ */
 export default interface AxisAngle {
 	/** The axis to rotate around. */
 	axis: Vector3Like;

package/src/types/FieldOfView.ts

@@ -1,4 +1,7 @@
-/** A field of view. */
+/**
+ * A field of view.
+ * @public
+ */
 export default interface FieldOfView {
 	/** The angle to the top of the field of view in degrees. */
 	upDegrees: number;

package/src/utility/BigNumber.ts

@@ -1,6 +1,9 @@
 import greatestCommonDivisor from "../algorithms/greatestCommonDivisor.js";
 
-/** A number with no maximum precise size. */
+/**
+ * A number with no maximum precise size.
+ * @public
+ */
 export default class BigNumber {
 	/**
 	 * Create a number.
@@ -30,7 +33,7 @@ export default class BigNumber {
 	 * Simplify this fraction.
 	 * @internal
 	 */
-	private simplify() {
+	private simplify(): void {
 		// Switch signs such that only the dividend can be negative.
 		if (this.divisor < 0) {
 			this.dividend = -this.dividend;
@@ -128,7 +131,7 @@ export default class BigNumber {
 	 * Convert this number to a string.
 	 * @returns A string representation of this number.
 	 */
-	public toString() {
+	public toString(): string {
 		return `${this.dividend.toLocaleString()}/${this.divisor.toLocaleString()}`;
 	}
 }

package/src/utility/MagnitudeError.ts

@@ -1,4 +1,7 @@
-/** An error resulting from using a vector that is too small or too large. */
+/**
+ * An error resulting from using a vector that is too small or too large.
+ * @public
+ */
 export default class MagnitudeError extends Error {
 	/**
 	 * Create an error resulting from using a vector that is too small or too large.

package/src/utility/MatrixSizeError.ts

@@ -1,4 +1,7 @@
-/** An error resulting from trying to use a matrix that is the wrong size. */
+/**
+ * An error resulting from trying to use a matrix that is the wrong size.
+ * @public
+ */
 export default class PartialMatrixError extends Error {
 	/**
 	 * Create an error resulting from trying to use a matrix that is the wrong size.

package/src/utility/PartialMatrixError.ts

@@ -1,4 +1,7 @@
-/** An error resulting from creating a matrix that isn't a perfect rectangle. */
+/**
+ * An error resulting from creating a matrix that isn't a perfect rectangle.
+ * @public
+ */
 export default class PartialMatrixError extends Error {
 	/**
 	 * Create an error resulting from creating a matrix that isn't a perfect rectangle.

package/src/utility/SingularMatrixError.ts

@@ -1,6 +1,7 @@
 /**
  * An error resulting from trying to invert a singular matrix.
- * @see [Invertible matrix](https://en.wikipedia.org/wiki/Invertible_matrix)
+ * @see {@link https://en.wikipedia.org/wiki/Invertible_matrix | Invertible matrix}
+ * @public
  */
 export default class SingularMatrixError extends Error {
 	/**

package/src/utility/epsilon.ts

@@ -1,2 +1,5 @@
-/** The largest difference between two numbers for them to be considered "roughly" equivalent. */
+/**
+ * The largest difference between two numbers for them to be considered "roughly" equivalent.
+ * @public
+ */
 export default 0.000001;