wgblas 1.2.1 → 2.1.0

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [2026] [manit2004]
+   Copyright [2026] [Manit Roy]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,60 +1,8 @@
 # wgblas
 
-`wgblas` is an initiative to implement all the standard level 1, 2, 3 BLAS functions on the top of webgpu.
-
-## Available Functions
-
-- [sscal](https://manit2004.github.io/wgblas/functions/docs.sscal.html)
-- [sswap](https://manit2004.github.io/wgblas/functions/docs.sswap.html)
-- [saxpy](https://manit2004.github.io/wgblas/functions/docs.saxpy.html)
-- [scopy](https://manit2004.github.io/wgblas/functions/docs.scopy.html)
-- [sdot](https://manit2004.github.io/wgblas/functions/docs.sdot.html)
-- [sasum](https://manit2004.github.io/wgblas/functions/docs.sasum.html)
-- [snrm2](https://manit2004.github.io/wgblas/functions/docs.snrm2.html)
-- [isamax](https://manit2004.github.io/wgblas/functions/docs.isamax.html)
-- [srot](https://manit2004.github.io/wgblas/functions/docs.srot.html)
-- [srotm](https://manit2004.github.io/wgblas/functions/docs.srotm.html)
-- [sgemv](https://manit2004.github.io/wgblas/functions/docs.sgemv.html)
-- [ssymv](https://manit2004.github.io/wgblas/functions/docs.ssymv.html)
-- [strmv](https://manit2004.github.io/wgblas/functions/docs.strmv.html)
-- [strsv](https://manit2004.github.io/wgblas/functions/docs.strsv.html)
-- [sger](https://manit2004.github.io/wgblas/functions/docs.sger.html)
-- [ssyr](https://manit2004.github.io/wgblas/functions/docs.ssyr.html)
-- [ssyr2](https://manit2004.github.io/wgblas/functions/docs.ssyr2.html)
-   
-## Browser Support
+[![Tests](https://github.com/manit2004/wgblas/actions/workflows/test-gpu.yml/badge.svg)](https://github.com/manit2004/wgblas/actions/workflows/test-gpu.yml)
 
-wgblas runs in any browser with WebGPU enabled. Check if it's working in your browser at [webgpureport.org](https://webgpureport.org).
-
-### Chrome (recommended)
-
-For full WebGPU control, enable all three flags at `chrome://flags` and relaunch:
-
-| Flag | What it does |
-|------|--------------|
-| `#enable-unsafe-webgpu` | Enables WebGPU |
-| `#force-enable-webgpu-interop` | Uses the real GPU via Vulkan (Linux) — without this Chrome may fall back to SwiftShader, a CPU-based software renderer |
-| `#enable-webgpu-developer-features` | Unlocks additional GPU features |
-
-You can verify which GPU is being used at [webgpureport.org](https://webgpureport.org) — if the adapter name shows **SwiftShader**, the real GPU is not being used.
-
-### Firefox
-
-WebGPU must be enabled manually via `about:config`. Search for each preference and set it:
-
-| Preference | Value | What it does |
-|------------|-------|--------------|
-| `dom.webgpu.enabled` | `true` | Enables WebGPU |
-| `dom.webgpu.wgpu-backend` | `vulkan` | Forces the real GPU via Vulkan — without this Firefox may use a software renderer |
-| `gfx.webgpu.ignore-blocklist` | `true` | Bypasses the GPU blocklist |
-
-Note: `dom.webgpu.wgpu-backend` is a **string** preference — click the pencil icon to edit it and type `vulkan`.
-
-Restart Firefox after making changes.
-
-> **Note:** Firefox's WebGPU implementation is incomplete and some routines may not work correctly. Chrome is recommended.
->
-> **Multi-GPU:** Firefox only exposes one WebGPU adapter (the display GPU, typically integrated) even on dual-GPU systems — verified via `about:support` → Graphics → WebGPU Default Adapter. Chrome picks the discrete GPU via `powerPreference: "high-performance"`; Firefox does not.
+`wgblas` implements all the standard single-precision level 1, 2, and 3 BLAS routines on top of WebGPU. Next up: double-precision routines, and single- and double-precision complex routines.
 
 ## Requirements
 
@@ -71,18 +19,18 @@ npm install wgblas
 ### Example Code Snippet
 
 ```js
-import { init, cleanup, randomFloat32Array } from "wgblas";
+import { init, cleanup } from "wgblas";
 import { sscal } from "wgblas/sscal";
 
 const device = await init();
 
-const n = 10;
-const alpha = 2.0;
-const x = randomFloat32Array(n, -10, 10);
+const n = 5;
+const alpha = 3;
+const x = new Float32Array([1, 2, 3, 4, 5]);
 
 console.log("before:", x);
-const result = await sscal(device, n, alpha, x, 1);
-console.log("after: ", result);
+const { x: result } = await sscal(device, n, alpha, x, 1);
+console.log("after: ", result); // [3, 6, 9, 12, 15]
 cleanup();
 ```
 
@@ -101,18 +49,18 @@ No bundler needed. Load the pre-built browser bundle from the CDN and use `windo
   <body>
     <pre id="out">Running…</pre>
     <script>
-      const { init, sscal, randomFloat32Array, cleanup } = window.wgblas;
+      const { init, sscal, cleanup } = window.wgblas;
 
       (async () => {
         const device = await init();
 
-        const n = 10;
-        const alpha = 2.0;
-        const x = randomFloat32Array(n, -10, 10);
+        const n = 5;
+        const alpha = 3;
+        const x = new Float32Array([1, 2, 3, 4, 5]);
 
         const xBefore = Array.from(x).map(v => v.toFixed(4)).join(", ");
 
-        const result = await sscal(device, n, alpha, x, 1);
+        const { x: result } = await sscal(device, n, alpha, x, 1);
 
         document.getElementById("out").textContent =
           "before: " + xBefore +
@@ -130,18 +78,18 @@ No bundler needed. Load the pre-built browser bundle from the CDN and use `windo
 `GpuVector` keeps data resident on the GPU between operations — upload once, chain any number of operations, read back once. This eliminates the redundant uploads and readbacks between steps, which are often more expensive than the compute itself.
 
 ```js
-import { init, cleanup, randomFloat32Array } from "wgblas";
+import { init, cleanup } from "wgblas";
 import { saxpy } from "wgblas/saxpy";
 import { sscal } from "wgblas/sscal";
 import { GpuVector } from "wgblas/classes/GpuVector";
 
 const device = await init();
 
-const n = 10;
+const n = 5;
 const alpha = 2;
 const scale = 0.5;
-const x = randomFloat32Array(n, -10, 10);
-const y = randomFloat32Array(n, -10, 10);
+const x = new Float32Array([1, 2, 3, 4, 5]);
+const y = new Float32Array([10, 20, 30, 40, 50]);
 
 const xGpu = GpuVector.from(x);
 const yGpu = GpuVector.from(y);
@@ -150,15 +98,49 @@ console.log("x:      ", x);
 console.log("y:      ", y);
 
 // results stay in the GPU.
-await saxpy(device, n, alpha, xGpu, 1, yGpu, 1);
-await sscal(device, n, scale, yGpu, 1);
+await saxpy(device, n, alpha, xGpu, 1, yGpu, 1); // y = 2x + y = [12, 24, 36, 48, 60]
+await sscal(device, n, scale, yGpu, 1);          // y = 0.5y = [6, 12, 18, 24, 30]
 
 // single readback
 const result = await yGpu.read();
-console.log("result: ", result);
+console.log("result: ", result); // [6, 12, 18, 24, 30]
 
 xGpu.destroy();
 yGpu.destroy();
 
 cleanup();
 ```
+
+## Browser Support
+
+wgblas runs in any browser with WebGPU enabled. Check if it's working in your browser at [webgpureport.org](https://webgpureport.org).
+
+### Chrome (recommended)
+
+For full WebGPU control, enable all three flags at `chrome://flags` and relaunch:
+
+| Flag | What it does |
+|------|--------------|
+| `#enable-unsafe-webgpu` | Enables WebGPU |
+| `#force-enable-webgpu-interop` | Uses the real GPU via Vulkan (Linux) — without this Chrome may fall back to SwiftShader, a CPU-based software renderer |
+| `#enable-webgpu-developer-features` | Unlocks additional GPU features |
+
+You can verify which GPU is being used at [webgpureport.org](https://webgpureport.org) — if the adapter name shows **SwiftShader**, the real GPU is not being used.
+
+### Firefox
+
+WebGPU must be enabled manually via `about:config`. Search for each preference and set it:
+
+| Preference | Value | What it does |
+|------------|-------|--------------|
+| `dom.webgpu.enabled` | `true` | Enables WebGPU |
+| `dom.webgpu.wgpu-backend` | `vulkan` | Forces the real GPU via Vulkan — without this Firefox may use a software renderer |
+| `gfx.webgpu.ignore-blocklist` | `true` | Bypasses the GPU blocklist |
+
+Note: `dom.webgpu.wgpu-backend` is a **string** preference — click the pencil icon to edit it and type `vulkan`.
+
+Restart Firefox after making changes.
+
+> **Note:** Firefox's WebGPU implementation is incomplete and some routines may not work correctly. Chrome is recommended.
+>
+> **Multi-GPU:** Firefox only exposes one WebGPU adapter (the display GPU, typically integrated) even on dual-GPU systems — verified via `about:support` → Graphics → WebGPU Default Adapter. Chrome picks the discrete GPU via `powerPreference: "high-performance"`; Firefox does not.