Merge remote-tracking branch 'origin/main' into improve-performance-mmul

Author: targos

.babelrc.json

@@ -3,12 +3,12 @@ name: Node.js CI
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 
 jobs:
   nodejs:
     # Documentation: https://github.com/zakodium/workflows#nodejs-ci
     uses: zakodium/workflows/.github/workflows/nodejs.yml@nodejs-v1
     with:
-      node-version-matrix: '[12, 14, 16]'
+      lint-check-types: true

.eslintrc.yml

@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   release:
@@ -14,4 +14,3 @@ jobs:
     secrets:
       github-token: ${{ secrets.BOT_TOKEN }}
       npm-token: ${{ secrets.NPM_BOT_TOKEN }}
-

.github/workflows/documentationjs.yml

@@ -0,0 +1,32 @@
+name: Deploy TypeDoc on GitHub pages
+
+on:
+  workflow_dispatch:
+  release:
+    types: [published]
+
+env:
+  NODE_VERSION: 22.x
+  ENTRY_FILE: 'src/index.js'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Install dependencies
+        run: npm install
+      - name: Build documentation
+        uses: zakodium/typedoc-action@v2
+        with:
+          entry: ${{ env.ENTRY_FILE }}
+      - name: Deploy to GitHub pages
+        uses: JamesIves/github-pages-deploy-action@releases/v4
+        with:
+          token: ${{ secrets.BOT_TOKEN }}
+          branch: gh-pages
+          folder: docs
+          clean: true

.github/workflows/nodejs.yml

@@ -0,0 +1 @@
+CHANGELOG.md

.github/workflows/release.yml

@@ -1,5 +1,29 @@
 # Changelog
 
+## [3.0.1](https://github.com/mljs/sparse-matrix/compare/v3.0.0...v3.0.1) (2025-06-20)
+
+
+### Bug Fixes
+
+* improve types by defining all methods and removing `eval` ([#15](https://github.com/mljs/sparse-matrix/issues/15)) ([a9a5894](https://github.com/mljs/sparse-matrix/commit/a9a5894bd8202723395933b3c89feb0263a41eb5))
+
+## [3.0.0](https://github.com/mljs/sparse-matrix/compare/v2.1.0...v3.0.0) (2025-05-25)
+
+
+### ⚠ BREAKING CHANGES
+
+* migrate to TypeScript and ESM
+
+### Bug Fixes
+
+* remove docs and build on gh-pages ([9197b3c](https://github.com/mljs/sparse-matrix/commit/9197b3c1eba1a9c2e2f894bdaa5b066563d047c9))
+* remove travis ([4ff4567](https://github.com/mljs/sparse-matrix/commit/4ff45677d1308976a52bc8f583f4772983a5a0f0))
+
+
+### Code Refactoring
+
+* migrate to TypeScript and ESM ([d197546](https://github.com/mljs/sparse-matrix/commit/d19754622b6b96afe3699553bbea8e7e939ce899))
+
 ## [2.1.0](https://github.com/mljs/sparse-matrix/compare/v2.0.0...v2.1.0) (2021-03-03)
 
 
@@ -49,6 +73,3 @@
 
 <a name="0.1.0"></a>
 # 0.1.0 (2016-05-18)
-
-
-

.github/workflows/typedoc.yml

@@ -1,4 +1,4 @@
-# sparse-matrix
+# ml-sparse-matrix
 
 [![NPM version][npm-image]][npm-url]
 [![coverage status][codecov-image]][codecov-url]
@@ -13,7 +13,7 @@ Sparse matrix library.
 ## Usage
 
 ```js
-import { SparseMatrix } from "ml-sparse-matrix";
+import { SparseMatrix } from 'ml-sparse-matrix';
 
 const matrix1 = new SparseMatrix([
   [1, 2],

.prettierignore

@@ -1,7 +1,10 @@
-import { SparseMatrix } from '../src/index.js';
+import fs from 'node:fs';
+
 import { Matrix } from 'ml-matrix';
+
+import { SparseMatrix } from '../src/index.js';
+
 import { SparseMatrix as SparseMatrixOld } from './class/SparseMatrixOld.js';
-import fs from 'fs';
 
 function randomSparseMatrix(rows, cols, density = 0.01) {
   const matrix = [];
@@ -176,15 +179,17 @@ function runSizeSweepBenchmark() {
               3,
             );
 
-            const denseAvg = benchmark(() => {
-              denseA.mmul(denseB), 'denseMatrix', 3;
-            });
+            const denseAvg = benchmark(
+              () => denseA.mmul(denseB),
+              'denseMatrix',
+              3,
+            );
 
             results.push({
               densityA,
               densityB,
-              A_shape: [m, n],
-              B_shape: [n, p],
+              aShape: [m, n],
+              bShape: [n, p],
               dense: denseAvg,
               mmulNew: mmulNewAvg,
               mmul: mmulAvg,