@lakuna/umath 1.3.9 → 1.4.2

package/src/linalg/SlowMatrix.ts

@@ -5,7 +5,8 @@ import epsilon from "../utility/epsilon.js";
 
 /**
  * A variable-size matrix.
- * @see [Matrix](https://en.wikipedia.org/wiki/Matrix_(mathematics))
+ * @see {@link https://en.wikipedia.org/wiki/Matrix_(mathematics) | Matrix}
+ * @public
  */
 export default class SlowMatrix extends Float32Array implements Matrix {
 	/**
@@ -41,7 +42,7 @@ export default class SlowMatrix extends Float32Array implements Matrix {
 
 	/**
 	 * Get the Frobenius norm of this matrix.
-	 * @see [Matrix norm](https://en.wikipedia.org/wiki/Matrix_norm)
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_norm | Matrix norm}
 	 */
 	public get frob(): number {
 		return Math.hypot(...this);
@@ -51,7 +52,7 @@ export default class SlowMatrix extends Float32Array implements Matrix {
 	 * Add two matrices of the same size.
 	 * @param matrix - The other matrix.
 	 * @returns The sum of the matrices.
-	 * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
 	 */
 	public add(matrix: MatrixLike): SlowMatrix {
 		const matrixWidth = "width" in matrix ? (matrix.width as number) : 1;
@@ -170,7 +171,7 @@ export default class SlowMatrix extends Float32Array implements Matrix {
 	 * Multiply this matrix by another.
 	 * @param matrix - The other matrix.
 	 * @returns The product of the matrices.
-	 * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_multiplication | Matrix multiplication}
 	 */
 	public multiply(matrix: MatrixLike): SlowMatrix {
 		const matrixWidth = "width" in matrix ? (matrix.width as number) : 1;
@@ -206,7 +207,7 @@ export default class SlowMatrix extends Float32Array implements Matrix {
 	 * Multiply this matrix by a scalar value.
 	 * @param scalar - The scalar value.
 	 * @returns The product of the matrix and the scalar value.
-	 * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_multiplication | Matrix multiplication}
 	 */
 	public multiplyScalar(scalar: number): SlowMatrix {
 		const out = this.clone();
@@ -226,8 +227,8 @@ export default class SlowMatrix extends Float32Array implements Matrix {
 	 * @param matrix - The other matrix.
 	 * @param scalar - The scalar.
 	 * @returns The sum.
-	 * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
-	 * @see [Matrix multiplication](https://en.wikipedia.org/wiki/Matrix_multiplication)
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_multiplication | Matrix multiplication}
 	 */
 	public multiplyScalarAndAdd(matrix: MatrixLike, scalar: number): SlowMatrix {
 		if (!("multiplyScalar" in matrix)) {
@@ -242,7 +243,7 @@ export default class SlowMatrix extends Float32Array implements Matrix {
 	 * Subtract another matrix from this one.
 	 * @param matrix - The other matrix.
 	 * @returns The difference between the matrices.
-	 * @see [Matrix addition](https://en.wikipedia.org/wiki/Matrix_addition)
+	 * @see {@link https://en.wikipedia.org/wiki/Matrix_addition | Matrix addition}
 	 */
 	public subtract(matrix: MatrixLike): SlowMatrix {
 		const matrixWidth = "width" in matrix ? (matrix.width as number) : 1;
@@ -269,7 +270,7 @@ export default class SlowMatrix extends Float32Array implements Matrix {
 	/**
 	 * Transpose this matrix.
 	 * @returns The transpose of this matrix.
-	 * @see [Transpose](https://en.wikipedia.org/wiki/Transpose)
+	 * @see {@link https://en.wikipedia.org/wiki/Transpose | Transpose}
 	 */
 	public transpose(): SlowMatrix {
 		const cols: number[][] = [];

package/src/linalg/SlowSquareMatrix.ts

@@ -5,7 +5,8 @@ import type SquareMatrix from "./SquareMatrix.js";
 
 /**
  * A variable-size matrix with the same number of rows and columns.
- * @see [Square matrix](https://en.wikipedia.org/wiki/Square_matrix)
+ * @see {@link https://en.wikipedia.org/wiki/Square_matrix | Square matrix}
+ * @public
  */
 export default class SlowSquareMatrix
 	extends SlowMatrix
@@ -14,7 +15,7 @@ export default class SlowSquareMatrix
 	/**
 	 * Create a variable-size matrix with the same number of rows and columns from the given columns.
 	 * @param cols - The columns in the matrix.
-	 * @see [Square matrix](https://en.wikipedia.org/wiki/Square_matrix)
+	 * @see {@link https://en.wikipedia.org/wiki/Square_matrix | Square matrix}
 	 */
 	public constructor(...cols: number[][]) {
 		super(...cols);
@@ -30,7 +31,7 @@ export default class SlowSquareMatrix
 
 	/**
 	 * Get the determinant of this matrix.
-	 * @see [Determinant](https://en.wikipedia.org/wiki/Determinant)
+	 * @see {@link https://en.wikipedia.org/wiki/Determinant | Determinant}
 	 */
 	public get determinant(): number {
 		if (this.length < 1) {
@@ -56,7 +57,7 @@ export default class SlowSquareMatrix
 	/**
 	 * Calculate the adjugate of this matrix.
 	 * @returns The adjugate of this matrix.
-	 * @see [Adjugate matrix](https://en.wikipedia.org/wiki/Adjugate_matrix)
+	 * @see {@link https://en.wikipedia.org/wiki/Adjugate_matrix | Adjugate matrix}
 	 */
 	public adjoint(): SlowSquareMatrix {
 		return this.cofactor().transpose();
@@ -84,7 +85,7 @@ export default class SlowSquareMatrix
 	/**
 	 * Calculate the cofactor of this matrix.
 	 * @returns The cofactor.
-	 * @see [Minor](https://en.wikipedia.org/wiki/Minor_(linear_algebra))
+	 * @see {@link https://en.wikipedia.org/wiki/Minor_(linear_algebra) | Minor}
 	 */
 	public cofactor(): SlowSquareMatrix {
 		const out: number[][] = [];
@@ -102,7 +103,7 @@ export default class SlowSquareMatrix
 	/**
 	 * Reset this matrix to identity.
 	 * @returns This matrix.
-	 * @see [Identity matrix](https://en.wikipedia.org/wiki/Identity_matrix)
+	 * @see {@link https://en.wikipedia.org/wiki/Identity_matrix | Identity matrix}
 	 */
 	public identity(): this {
 		for (let i = 0; i < this.width; i++) {
@@ -117,7 +118,7 @@ export default class SlowSquareMatrix
 	/**
 	 * Invert this matrix.
 	 * @returns The inverted matrix.
-	 * @see [Invertible matrix](https://en.wikipedia.org/wiki/Invertible_matrix)
+	 * @see {@link https://en.wikipedia.org/wiki/Invertible_matrix | Invertible matrix}
 	 */
 	public invert(): SlowSquareMatrix {
 		const dim = this.width;
@@ -188,7 +189,7 @@ export default class SlowSquareMatrix
 	 * @param row - The row to remove.
 	 * @param col - The column to remove.
 	 * @returns The minor.
-	 * @see [Minor](https://en.wikipedia.org/wiki/Minor_(linear_algebra))
+	 * @see {@link https://en.wikipedia.org/wiki/Minor_(linear_algebra) | Minor}
 	 */
 	public minor(row: number, col: number): number {
 		return this.submatrix(row, col).determinant;
@@ -228,7 +229,7 @@ export default class SlowSquareMatrix
 	/**
 	 * Transpose this matrix.
 	 * @returns The transpose of this matrix.
-	 * @see [Transpose](https://en.wikipedia.org/wiki/Transpose)
+	 * @see {@link https://en.wikipedia.org/wiki/Transpose | Transpose}
 	 */
 	public override transpose(): SlowSquareMatrix {
 		const cols: number[][] = [];

package/src/linalg/SquareMatrix.ts

@@ -2,33 +2,34 @@ import type { default as Matrix, MatrixLike } from "./Matrix.js";
 
 /**
  * A matrix with the same number of rows and columns.
- * @see [Square matrix](https://en.wikipedia.org/wiki/Square_matrix)
+ * @see {@link https://en.wikipedia.org/wiki/Square_matrix | Square matrix}
+ * @public
  */
 export default interface SquareMatrix extends Matrix {
 	/**
 	 * Get the determinant of this matrix.
-	 * @see [Determinant](https://en.wikipedia.org/wiki/Determinant)
+	 * @see {@link https://en.wikipedia.org/wiki/Determinant | Determinant}
 	 */
 	get determinant(): number;
 
 	/**
 	 * Calculate the adjugate of this matrix.
 	 * @returns The adjugate of this matrix.
-	 * @see [Adjugate matrix](https://en.wikipedia.org/wiki/Adjugate_matrix)
+	 * @see {@link https://en.wikipedia.org/wiki/Adjugate_matrix | Adjugate matrix}
 	 */
 	adjoint(): MatrixLike;
 
 	/**
 	 * Reset this matrix to identity.
 	 * @returns This matrix.
-	 * @see [Identity matrix](https://en.wikipedia.org/wiki/Identity_matrix)
+	 * @see {@link https://en.wikipedia.org/wiki/Identity_matrix | Identity matrix}
 	 */
 	identity(): this;
 
 	/**
 	 * Invert this matrix.
 	 * @returns The inverted matrix.
-	 * @see [Invertible matrix](https://en.wikipedia.org/wiki/Invertible_matrix)
+	 * @see {@link https://en.wikipedia.org/wiki/Invertible_matrix | Invertible matrix}
 	 */
 	invert(): MatrixLike;
 }

package/src/linalg/Vector.ts

@@ -1,11 +1,15 @@
 import type { Vector4Like } from "./Vector4.js";
 
-/** An object that could be interpreted as a vector. */
+/**
+ * An object that could be interpreted as a vector.
+ * @public
+ */
 export type VectorLike = Record<number, number>;
 
 /**
  * A quantity with magnitude and direction.
- * @see [Wikipedia](https://en.wikipedia.org/wiki/Euclidean_vector)
+ * @see {@link https://en.wikipedia.org/wiki/Euclidean_vector | Euclidean vector}
+ * @public
  */
 export default interface Vector extends VectorLike {
 	/**
@@ -145,7 +149,7 @@ export default interface Vector extends VectorLike {
 	/**
 	 * Normalize this vector.
 	 * @returns The normalized vector.
-	 * @see [Unit vector](https://en.wikipedia.org/wiki/Unit_vector)
+	 * @see {@link https://en.wikipedia.org/wiki/Unit_vector | Unit vector}
 	 */
 	normalize(): VectorLike;
 
@@ -153,7 +157,7 @@ export default interface Vector extends VectorLike {
 	 * Calculate the dot product of this and another vector.
 	 * @param vector - The other vector.
 	 * @returns The dot product.
-	 * @see [Dot product](https://en.wikipedia.org/wiki/Dot_product)
+	 * @see {@link https://en.wikipedia.org/wiki/Dot_product | Dot product}
 	 */
 	dot(vector: Vector4Like): number;