diff --git a/CHANGELOG.md b/CHANGELOG.md index 41fd6ce..dcf2338 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@
+- [`ef474af`](https://github.com/stdlib-js/stdlib/commit/ef474af3b2f1eafffbbbc9e4bcb72541f72970ef) - **docs:** fix overwriting of variables _(by Athan Reines)_ - [`1cd5988`](https://github.com/stdlib-js/stdlib/commit/1cd5988f17e8bd1e3282540d82e05536178423a4) - **docs:** fix copy _(by Athan Reines)_ - [`3095c9a`](https://github.com/stdlib-js/stdlib/commit/3095c9a511ea9d5291e2af2344b239a6101ab31f) - **docs:** add example using little-endian arrays _(by Athan Reines)_ - [`177f16c`](https://github.com/stdlib-js/stdlib/commit/177f16cd80b9072714e7b4e976487e5e6dd19761) - **chore:** update package meta data [(#2933)](https://github.com/stdlib-js/stdlib/pull/2933) _(by stdlib-bot, Athan Reines)_ diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index b2ec06e..d0ae8a2 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -46,11 +46,11 @@ interface ModuleConstructor { * }); * * // Create a BLAS routine: - * var daxpy = new daxpy.Module( mem ); + * var mod = new daxpy.Module( mem ); * // returns * * // Initialize the routine: - * daxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -63,11 +63,11 @@ interface ModuleConstructor { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * daxpy.write( xptr, oneTo( N, dtype ) ); - * daxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = daxpy.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 ); - * daxpy.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 daxpy = daxpy.Module( mem ); + * var mod = daxpy.Module( mem ); * // returns * * // Initialize the routine: - * daxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -117,11 +117,11 @@ interface ModuleConstructor { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * daxpy.write( xptr, oneTo( N, dtype ) ); - * daxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = daxpy.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 ); - * daxpy.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 daxpy = new Module( mem ); + * var mod = new daxpy.Module( mem ); * // returns * * // Initialize the routine: - * daxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -181,11 +181,11 @@ interface Module extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * daxpy.write( xptr, oneTo( N, dtype ) ); - * daxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = daxpy.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 ); - * daxpy.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 daxpy = new Module( mem ); + * var mod = new daxpy.Module( mem ); * // returns * * // Initialize the routine: - * daxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -242,11 +242,11 @@ interface Module extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * daxpy.write( xptr, oneTo( N, dtype ) ); - * daxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = daxpy.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 ); - * daxpy.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 daxpy = new daxpy.Module( mem ); + * var mod = new daxpy.Module( mem ); * // returns * * // Initialize the routine: - * daxpy.initializeSync(); + * mod.initializeSync(); * * // Define a vector data type: * var dtype = 'float64'; @@ -347,11 +347,11 @@ interface Routine extends ModuleWrapper { * var yptr = N * bytesPerElement( dtype ); * * // Write vector values to module memory: - * daxpy.write( xptr, oneTo( N, dtype ) ); - * daxpy.write( yptr, ones( N, dtype ) ); + * mod.write( xptr, oneTo( N, dtype ) ); + * mod.write( yptr, ones( N, dtype ) ); * * // Perform computation: - * var ptr = daxpy.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 ); - * daxpy.read( yptr, view ); + * mod.read( yptr, view ); * // view => [ 6.0, 11.0, 16.0, 21.0, 26.0 ] */ Module: ModuleConstructor;