Skip to content

docs: update examples #13846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 5 commits into from
Aug 1, 2026
Merged

docs: update examples #13846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
857df43
docs: update examples
anandkaranubc Aug 1, 2026
afd3f09
docs: remove parentheses
anandkaranubc Aug 1, 2026
b8cabf0
Merge branch 'develop' into docs/update-examples-wxops
anandkaranubc Aug 1, 2026
3e1755c
Merge branch 'develop' into docs/update-examples-wxops
anandkaranubc Aug 1, 2026
07dae21
docs: update examples to match operand order in package names
anandkaranubc Aug 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/cwapx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ var w = new Complex64Array( wbuf.buffer );
var alpha = new Complex64( 5.0, 3.0 );

cwapx( x.length, alpha, x, 1, w, 1 );
logEach( '(%s) + (%s) = %s', x, alpha, w );
logEach( '(%s) + (%s) = %s', alpha, x, w );
```

</section>
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/cwapx/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ var w = new Complex64Array( wbuf.buffer );
var alpha = new Complex64( 5.0, 3.0 );

cwapx( x.length, alpha, x, 1, w, 1 );
logEach( '(%s) + (%s) = %s', x, alpha, w );
logEach( '(%s) + (%s) = %s', alpha, x, w );
6 changes: 2 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dwapx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,19 +153,17 @@ dwapx.ndarray( 3, 5.0, x, 1, x.length-3, w, 1, w.length-3 );

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwapx = require( '@stdlib/blas/ext/base/dwapx' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwapx( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d + %d = %d', 5.0, x, w );
```

</section>
Expand Down
6 changes: 2 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dwapx/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@
'use strict';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwapx = require( './../lib' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwapx( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d + %d = %d', 5.0, x, w );
6 changes: 2 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dwax/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,19 +153,17 @@ dwax.ndarray( 3, 5.0, x, 1, x.length-3, w, 1, w.length-3 );

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwax = require( '@stdlib/blas/ext/base/dwax' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwax( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d * %d = %d', 5.0, x, w );
```

</section>
Expand Down
6 changes: 2 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dwax/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@
'use strict';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwax = require( './../lib' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwax( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d * %d = %d', 5.0, x, w );
8 changes: 2 additions & 6 deletions lib/node_modules/@stdlib/blas/ext/base/dwxmy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,22 +165,18 @@ dwxmy.ndarray( 3, x, 1, x.length-3, y, 1, y.length-3, w, 1, w.length-3 );

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwxmy = require( '@stdlib/blas/ext/base/dwxmy' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var y = discreteUniform( 10, -100, 100, opts );
console.log( y );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwxmy( x.length, x, 1, y, 1, w, 1 );
console.log( w );
logEach( '%d * %d = %d', x, y, w );
```

</section>
Expand Down
8 changes: 2 additions & 6 deletions lib/node_modules/@stdlib/blas/ext/base/dwxmy/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,15 @@
'use strict';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwxmy = require( './../lib' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var y = discreteUniform( 10, -100, 100, opts );
console.log( y );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwxmy( x.length, x, 1, y, 1, w, 1 );
console.log( w );
logEach( '%d * %d = %d', x, y, w );
8 changes: 2 additions & 6 deletions lib/node_modules/@stdlib/blas/ext/base/dwxpy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,22 +163,18 @@ dwxpy.ndarray( 3, x, 1, x.length-3, y, 1, y.length-3, w, 1, w.length-3 );

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwxpy = require( '@stdlib/blas/ext/base/dwxpy' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var y = discreteUniform( 10, -100, 100, opts );
console.log( y );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwxpy( x.length, x, 1, y, 1, w, 1 );
console.log( w );
logEach( '%d + %d = %d', x, y, w );
```

</section>
Expand Down
8 changes: 2 additions & 6 deletions lib/node_modules/@stdlib/blas/ext/base/dwxpy/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,15 @@
'use strict';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwxpy = require( './../lib' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var y = discreteUniform( 10, -100, 100, opts );
console.log( y );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwxpy( x.length, x, 1, y, 1, w, 1 );
console.log( w );
logEach( '%d + %d = %d', x, y, w );
6 changes: 2 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dwxsa/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,19 +153,17 @@ dwxsa.ndarray( 3, 5.0, x, 1, x.length-3, w, 1, w.length-3 );

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwxsa = require( '@stdlib/blas/ext/base/dwxsa' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwxsa( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d - %d = %d', x, 5.0, w );
```

</section>
Expand Down
6 changes: 2 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dwxsa/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@
'use strict';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwxsa = require( './../lib' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwxsa( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d - %d = %d', x, 5.0, w );
8 changes: 2 additions & 6 deletions lib/node_modules/@stdlib/blas/ext/base/dwxsy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,22 +163,18 @@ dwxsy.ndarray( 3, x, 1, x.length-3, y, 1, y.length-3, w, 1, w.length-3 );

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwxsy = require( '@stdlib/blas/ext/base/dwxsy' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var y = discreteUniform( 10, -100, 100, opts );
console.log( y );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwxsy( x.length, x, 1, y, 1, w, 1 );
console.log( w );
logEach( '%d - %d = %d', x, y, w );
```

</section>
Expand Down
8 changes: 2 additions & 6 deletions lib/node_modules/@stdlib/blas/ext/base/dwxsy/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,15 @@
'use strict';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var dwxsy = require( './../lib' );

var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, -100, 100, opts );
console.log( x );

var y = discreteUniform( 10, -100, 100, opts );
console.log( y );

var w = discreteUniform( 10, -100, 100, opts );
console.log( w );

dwxsy( x.length, x, 1, y, 1, w, 1 );
console.log( w );
logEach( '%d - %d = %d', x, y, w );
15 changes: 6 additions & 9 deletions lib/node_modules/@stdlib/blas/ext/base/gwapx/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,20 +146,17 @@ gwapx.ndarray( 3, 5.0, x, 1, x.length-3, w, 1, w.length-3 );

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var gwapx = require( '@stdlib/blas/ext/base/gwapx' );

var x = discreteUniform( 10, -100, 100, {
var opts = {
'dtype': 'float64'
});
console.log( x );

var w = discreteUniform( 10, -100, 100, {
'dtype': 'float64'
});
console.log( w );
};
var x = discreteUniform( 10, -100, 100, opts );
var w = discreteUniform( 10, -100, 100, opts );

gwapx( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d + %d = %d', 5.0, x, w );
```

</section>
Expand Down
15 changes: 6 additions & 9 deletions lib/node_modules/@stdlib/blas/ext/base/gwapx/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,14 @@
'use strict';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var gwapx = require( './../lib' );

var x = discreteUniform( 10, -100, 100, {
var opts = {
'dtype': 'float64'
});
console.log( x );

var w = discreteUniform( 10, -100, 100, {
'dtype': 'float64'
});
console.log( w );
};
var x = discreteUniform( 10, -100, 100, opts );
var w = discreteUniform( 10, -100, 100, opts );

gwapx( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d + %d = %d', 5.0, x, w );
15 changes: 6 additions & 9 deletions lib/node_modules/@stdlib/blas/ext/base/gwax/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,20 +146,17 @@ gwax.ndarray( 3, 5.0, x, 1, x.length-3, w, 1, w.length-3 );

```javascript
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var gwax = require( '@stdlib/blas/ext/base/gwax' );

var x = discreteUniform( 10, -100, 100, {
var opts = {
'dtype': 'float64'
});
console.log( x );

var w = discreteUniform( 10, -100, 100, {
'dtype': 'float64'
});
console.log( w );
};
var x = discreteUniform( 10, -100, 100, opts );
var w = discreteUniform( 10, -100, 100, opts );

gwax( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d * %d = %d', 5.0, x, w );
```

</section>
Expand Down
15 changes: 6 additions & 9 deletions lib/node_modules/@stdlib/blas/ext/base/gwax/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,14 @@
'use strict';

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEach = require( '@stdlib/console/log-each' );
var gwax = require( './../lib' );

var x = discreteUniform( 10, -100, 100, {
var opts = {
'dtype': 'float64'
});
console.log( x );

var w = discreteUniform( 10, -100, 100, {
'dtype': 'float64'
});
console.log( w );
};
var x = discreteUniform( 10, -100, 100, opts );
var w = discreteUniform( 10, -100, 100, opts );

gwax( x.length, 5.0, x, 1, w, 1 );
console.log( w );
logEach( '%d * %d = %d', 5.0, x, w );
Loading