Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@stdlib-bot
stdlib-bot committed Sep 29, 2024
1 parent a3b60d9 commit dbc2e02
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 30 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

<details>

- [`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)_
Expand Down
60 changes: 30 additions & 30 deletions docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ interface ModuleConstructor {
* });
*
* // Create a BLAS routine:
* var daxpy = new daxpy.Module( mem );
* var mod = new daxpy.Module( mem );
* // returns <Module>
*
* // Initialize the routine:
* daxpy.initializeSync();
* mod.initializeSync();
*
* // Define a vector data type:
* var dtype = 'float64';
Expand All @@ -63,19 +63,19 @@ 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 <number>
*
* var bool = ( ptr === yptr );
* // returns true
*
* // Read out the results:
* var view = zeros( N, dtype );
* daxpy.read( yptr, view );
* mod.read( yptr, view );
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
*/
new( mem: Memory ): Module; // newable
Expand All @@ -100,11 +100,11 @@ interface ModuleConstructor {
* });
*
* // Create a BLAS routine:
* var daxpy = daxpy.Module( mem );
* var mod = daxpy.Module( mem );
* // returns <Module>
*
* // Initialize the routine:
* daxpy.initializeSync();
* mod.initializeSync();
*
* // Define a vector data type:
* var dtype = 'float64';
Expand All @@ -117,19 +117,19 @@ 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 <number>
*
* var bool = ( ptr === yptr );
* // returns true
*
* // Read out the results:
* var view = zeros( N, dtype );
* daxpy.read( yptr, view );
* mod.read( yptr, view );
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
*/
( mem: Memory ): Module; // callable
Expand Down Expand Up @@ -164,11 +164,11 @@ interface Module extends ModuleWrapper {
* });
*
* // Create a BLAS routine:
* var daxpy = new Module( mem );
* var mod = new daxpy.Module( mem );
* // returns <Module>
*
* // Initialize the routine:
* daxpy.initializeSync();
* mod.initializeSync();
*
* // Define a vector data type:
* var dtype = 'float64';
Expand All @@ -181,19 +181,19 @@ 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 <number>
*
* var bool = ( ptr === yptr );
* // returns true
*
* // Read out the results:
* var view = zeros( N, dtype );
* daxpy.read( yptr, view );
* mod.read( yptr, view );
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
*/
main( N: number, alpha: number, xptr: number, strideX: number, yptr: number, strideY: number ): number;
Expand Down Expand Up @@ -225,11 +225,11 @@ interface Module extends ModuleWrapper {
* });
*
* // Create a BLAS routine:
* var daxpy = new Module( mem );
* var mod = new daxpy.Module( mem );
* // returns <Module>
*
* // Initialize the routine:
* daxpy.initializeSync();
* mod.initializeSync();
*
* // Define a vector data type:
* var dtype = 'float64';
Expand All @@ -242,19 +242,19 @@ 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 <number>
*
* var bool = ( ptr === yptr );
* // returns true
*
* // Read out the results:
* var view = zeros( N, dtype );
* daxpy.read( yptr, view );
* mod.read( yptr, view );
* // view => <Float64Array>[ 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;
Expand Down Expand Up @@ -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 <Module>
*
* // Initialize the routine:
* daxpy.initializeSync();
* mod.initializeSync();
*
* // Define a vector data type:
* var dtype = 'float64';
Expand All @@ -347,19 +347,19 @@ 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 <number>
*
* var bool = ( ptr === yptr );
* // returns true
*
* // Read out the results:
* var view = zeros( N, dtype );
* daxpy.read( yptr, view );
* mod.read( yptr, view );
* // view => <Float64Array>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
*/
Module: ModuleConstructor;
Expand Down

0 comments on commit dbc2e02

Please sign in to comment.