diff --git a/CHANGELOG.md b/CHANGELOG.md index f8b4f48..e72e8a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@
+- [`0f8ee58`](https://github.com/stdlib-js/stdlib/commit/0f8ee58b842adebc77aeb2e6aebb41054ad6f3cd) - **docs:** fix overwriting of variables _(by Athan Reines)_ - [`929a224`](https://github.com/stdlib-js/stdlib/commit/929a2241acc3b3714fb01fcb4a9e295810df5bf5) - **feat:** add `blas/base/saxpy-wasm` [(#2956)](https://github.com/stdlib-js/stdlib/pull/2956) _(by Aman Bhansali, Athan Reines)_
diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 4f1625a..a09406b 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -46,11 +46,11 @@ interface ModuleConstructor { * }); * * // Create a BLAS routine: - * var saxpy = new saxpy.Module( mem ); + * var mod = new saxpy.Module( mem ); * // returns * * // Initialize the routine: - * saxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float32'; @@ -63,11 +63,11 @@ interface ModuleConstructor { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * saxpy.write( xptr, oneTo( N, dtype ) ); - * saxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = saxpy.main( N, 5.0, xptr, 1, yptr, 1 ); + * var ptr = mod.main( N, 5.0, xptr, 1, yptr, 1 ); * // returns * * var bool = ( ptr === yptr ); @@ -75,7 +75,7 @@ interface ModuleConstructor { * * // Read out the results: * var view = zeros( N, dtype ); - * saxpy.read( yptr, view ); + * mod.read( yptr, view ); * // view => [ 6.0, 11.0, 16.0, 21.0, 26.0 ] */ new( mem: Memory ): Module; // newable @@ -100,11 +100,11 @@ interface ModuleConstructor { * }); * * // Create a BLAS routine: - * var saxpy = saxpy.Module( mem ); + * var mod = saxpy.Module( mem ); * // returns * * // Initialize the routine: - * saxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float32'; @@ -117,11 +117,11 @@ interface ModuleConstructor { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * saxpy.write( xptr, oneTo( N, dtype ) ); - * saxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = saxpy.main( N, 5.0, xptr, 1, yptr, 1 ); + * var ptr = mod.main( N, 5.0, xptr, 1, yptr, 1 ); * // returns * * var bool = ( ptr === yptr ); @@ -129,7 +129,7 @@ interface ModuleConstructor { * * // Read out the results: * var view = zeros( N, dtype ); - * saxpy.read( yptr, view ); + * mod.read( yptr, view ); * // view => [ 6.0, 11.0, 16.0, 21.0, 26.0 ] */ ( mem: Memory ): Module; // callable @@ -164,11 +164,11 @@ interface Module extends ModuleWrapper { * }); * * // Create a BLAS routine: - * var saxpy = new Module( mem ); + * var mod = new saxpy.Module( mem ); * // returns * * // Initialize the routine: - * saxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float32'; @@ -181,11 +181,11 @@ interface Module extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * saxpy.write( xptr, oneTo( N, dtype ) ); - * saxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = saxpy.main( N, 5.0, xptr, 1, yptr, 1 ); + * var ptr = mod.main( N, 5.0, xptr, 1, yptr, 1 ); * // returns * * var bool = ( ptr === yptr ); @@ -193,7 +193,7 @@ interface Module extends ModuleWrapper { * * // Read out the results: * var view = zeros( N, dtype ); - * saxpy.read( yptr, view ); + * mod.read( yptr, view ); * // view => [ 6.0, 11.0, 16.0, 21.0, 26.0 ] */ main( N: number, alpha: number, xptr: number, strideX: number, yptr: number, strideY: number ): number; @@ -225,11 +225,11 @@ interface Module extends ModuleWrapper { * }); * * // Create a BLAS routine: - * var saxpy = new Module( mem ); + * var mod = new saxpy.Module( mem ); * // returns * * // Initialize the routine: - * saxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float32'; @@ -242,11 +242,11 @@ interface Module extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * saxpy.write( xptr, oneTo( N, dtype ) ); - * saxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = saxpy.ndarray( N, 5.0, xptr, 1, 0, yptr, 1, 0 ); + * var ptr = mod.ndarray( N, 5.0, xptr, 1, 0, yptr, 1, 0 ); * // returns * * var bool = ( ptr === yptr ); @@ -254,7 +254,7 @@ interface Module extends ModuleWrapper { * * // Read out the results: * var view = zeros( N, dtype ); - * saxpy.read( yptr, view ); + * mod.read( yptr, view ); * // view => [ 6.0, 11.0, 16.0, 21.0, 26.0 ] */ ndarray( N: number, alpha: number, xptr: number, strideX: number, offsetX: number, yptr: number, strideY: number, offsetY: number ): number; @@ -330,11 +330,11 @@ interface Routine extends ModuleWrapper { * }); * * // Create a BLAS routine: - * var saxpy = new saxpy.Module( mem ); + * var mod = new saxpy.Module( mem ); * // returns * * // Initialize the routine: - * saxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float32'; @@ -347,11 +347,11 @@ interface Routine extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * saxpy.write( xptr, oneTo( N, dtype ) ); - * saxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = saxpy.main( N, 5.0, xptr, 1, yptr, 1 ); + * var ptr = mod.main( N, 5.0, xptr, 1, yptr, 1 ); * // returns * * var bool = ( ptr === yptr ); @@ -359,7 +359,7 @@ interface Routine extends ModuleWrapper { * * // Read out the results: * var view = zeros( N, dtype ); - * saxpy.read( yptr, view ); + * mod.read( yptr, view ); * // view => [ 6.0, 11.0, 16.0, 21.0, 26.0 ] */ Module: ModuleConstructor;