@siteimprove/alfa-math 0.108.2 → 0.110.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @siteimprove/alfa-math
 
+## 0.110.0
+
+## 0.109.0
+
+### Patch Changes
+
+- **Added:** `Matrix.multiply` now accepts vectors as the left/right operand, which is turned into a single row/column matrix. ([#1944](https://github.com/Siteimprove/alfa/pull/1944))
+
 ## 0.108.2
 
 ## 0.108.1

package/dist/matrix.d.ts

@@ -1,3 +1,4 @@
+import { Vector } from "./vector.js";
 /**
  * {@link https://en.wikipedia.org/wiki/Matrix_(mathematics)}
  *
@@ -23,7 +24,7 @@ export declare namespace Matrix {
     /**
      * {@link https://en.wikipedia.org/wiki/Matrix_multiplication}
      */
-    function multiply(m: Matrix, n: number | Matrix): Matrix;
+    function multiply(m: Matrix | Vector, n: number | Matrix | Vector): Matrix;
     /**
      * Compute the transpose of a matrix.
      *

package/dist/matrix.js

@@ -1,4 +1,5 @@
 import { Real } from "./real.js";
+import { Vector } from "./vector.js";
 /**
  * @public
  */
@@ -63,9 +64,15 @@ export var Matrix;
      * {@link https://en.wikipedia.org/wiki/Matrix_multiplication}
      */
     function multiply(m, n) {
-        return typeof n === "number"
-            ? m.map((r) => r.map((v) => v * n))
-            : m.map((r, i) => n[0].map((_, j) => r.reduce((s, _, k) => s + m[i][k] * n?.[k]?.[j], 0)));
+        // If m is a vector, treat it as a single row matrix.
+        // [a, b, c]  =>  [[a, b, c]]
+        const left = Vector.isVector(m) ? [m] : m;
+        // If n is a vector, treat it as a single column matrix.
+        // [a, b, c]  =>  [[a], [b], [c]]
+        const right = Vector.isVector(n) ? n.map((x) => [x]) : n;
+        return typeof right === "number"
+            ? left.map((r) => r.map((v) => v * right))
+            : left.map((r, i) => right[0].map((_, j) => r.reduce((s, _, k) => s + left[i][k] * right?.[k]?.[j], 0)));
     }
     Matrix.multiply = multiply;
     /**

package/dist/real.d.ts

@@ -17,7 +17,8 @@ export declare namespace Real {
      *
      * @remarks
      * The modulo operation is different from the remainder operation supported
-     * natively in JavaScript through the % operator.
+     * natively in JavaScript through the `%` operator. The modulo operation
+     * always returns a result with the same sign as the divisor.
      */
     function modulo(p: number, d: number): number;
     /**

package/dist/real.js

@@ -33,7 +33,8 @@ export var Real;
      *
      * @remarks
      * The modulo operation is different from the remainder operation supported
-     * natively in JavaScript through the % operator.
+     * natively in JavaScript through the `%` operator. The modulo operation
+     * always returns a result with the same sign as the divisor.
      */
     function modulo(p, d) {
         return ((p % d) + d) % d;

package/package.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/package",
   "name": "@siteimprove/alfa-math",
   "homepage": "https://alfa.siteimprove.com",
-  "version": "0.108.2",
+  "version": "0.110.0",
   "license": "MIT",
   "description": "Functionality for working with numbers and mathematical structures, such as vectors and matrices",
   "repository": {
@@ -22,7 +22,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "@siteimprove/alfa-test": "^0.108.2"
+    "@siteimprove/alfa-test": "^0.110.0"
   },
   "publishConfig": {
     "access": "public",