Auto-generated commit

Author: stdlib-bot

.gitignore

@@ -25,6 +25,7 @@ package.json.copy
 ###############
 build/
 downloads/
+plans/
 reports/
 tmp/
 
@@ -175,6 +176,10 @@ acs-*.bib
 *.ind
 *.ist
 
+# Git #
+#######
+.worktrees
+
 # Visual Studio #
 #################
 .vscode/

CHANGELOG.md

@@ -4,14 +4,15 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2026-04-12)
+## Unreleased (2026-04-23)
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`0779fd4`](https://github.com/stdlib-js/stdlib/commit/0779fd40d190cee898a170518996788f07d1e755) - **chore:** modernize examples and benchmarks _(by Athan Reines)_
 -   [`39db70f`](https://github.com/stdlib-js/stdlib/commit/39db70f0446038735b98e82abc26b369ac34938f) - **bench:** refactor to use string interpolation in `@stdlib/blas` [(#11397)](https:-/github.com/stdlib-js/stdlib/pull/11397) _(by Karan Anand)_
 -   [`04fd54f`](https://github.com/stdlib-js/stdlib/commit/04fd54f42c8c1b0af88660d7ce791f71891a2187) - **refactor:** improve type specificity in `blas/base/ndarray/gdot` [(#11245)](https://github.com/stdlib-js/stdlib/pull/11245) _(by Kaustubh Patange)_
 
@@ -25,8 +26,9 @@
 
 ### Contributors
 
-A total of 2 people contributed to this release. Thank you to the following contributors:
+A total of 3 people contributed to this release. Thank you to the following contributors:
 
+-   Athan Reines
 -   Karan Anand
 -   Kaustubh Patange
 

README.md

@@ -89,21 +89,21 @@ var gdot = require( '@stdlib/blas-base-ndarray-gdot' );
 Computes the dot product of two one-dimensional ndarrays.
 
 ```javascript
-var ndarray = require( '@stdlib/ndarray-base-ctor' );
+var vector = require( '@stdlib/ndarray-vector-ctor' );
 
-var xbuf = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
-var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
-
-var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
-var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
+var x = vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ], 'generic' );
+var y = vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ], 'generic' );
 
 var z = gdot( [ x, y ] );
 // returns -5.0
 ```
 
 The function has the following parameters:
 
--   **arrays**: array-like object containing two one-dimensional input ndarrays.
+-   **arrays**: array-like object containing the following ndarrays in order:
+
+    -   first input ndarray
+    -   second input ndarray
 
 </section>
 
@@ -122,21 +122,18 @@ The function has the following parameters:
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
-var ndarray = require( '@stdlib/ndarray-base-ctor' );
+var discreteUniform = require( '@stdlib/random-discrete-uniform' );
 var ndarray2array = require( '@stdlib/ndarray-to-array' );
 var gdot = require( '@stdlib/blas-base-ndarray-gdot' );
 
 var opts = {
     'dtype': 'generic'
 };
 
-var xbuf = discreteUniform( 10, 0, 500, opts );
-var x = new ndarray( opts.dtype, xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+var x = discreteUniform( [ 10 ], 0, 500, opts );
 console.log( ndarray2array( x ) );
 
-var ybuf = discreteUniform( 10, 0, 255, opts );
-var y = new ndarray( opts.dtype, ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
+var y = discreteUniform( [ 10 ], 0, 255, opts );
 console.log( ndarray2array( y ) );
 
 var out = gdot( [ x, y ] );

benchmark/benchmark.js

@@ -21,10 +21,9 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-var uniform = require( '@stdlib/random-array-uniform' );
+var uniform = require( '@stdlib/random-uniform' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pow = require( '@stdlib/math-base-special-pow' );
-var ndarray = require( '@stdlib/ndarray-base-ctor' );
 var format = require( '@stdlib/string-format' );
 var pkg = require( './../package.json' ).name;
 var gdot = require( './../lib' );
@@ -47,17 +46,8 @@ var options = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var xbuf;
-	var ybuf;
-	var x;
-	var y;
-
-	xbuf = uniform( len, -100.0, 100.0, options );
-	x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
-
-	ybuf = uniform( len, -100.0, 100.0, options );
-	y = new ndarray( options.dtype, ybuf, [ len ], [ 1 ], 0, 'row-major' );
-
+	var x = uniform( [ len ], -100.0, 100.0, options );
+	var y = uniform( [ len ], -100.0, 100.0, options );
 	return benchmark;
 
 	/**

dist/index.js.map

@@ -16,15 +16,8 @@
 
     Examples
     --------
-    > var xbuf = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
-    > var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
-    > var dt = 'generic';
-    > var sh = [ xbuf.length ];
-    > var st = [ 1 ];
-    > var oo = 0;
-    > var ord = 'row-major';
-    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord );
-    > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord );
+    > var x = {{alias:@stdlib/ndarray/vector/ctor}}( [ 4.0, 2.0, -3.0, 5.0, -1.0 ], 'generic' );
+    > var y = {{alias:@stdlib/ndarray/vector/ctor}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ], 'generic' );
     > {{alias}}( [ x, y ] )
     -5.0
 

docs/repl.txt

@@ -29,13 +29,10 @@ import { typedndarray } from '@stdlib/types/ndarray';
 * @returns dot product
 *
 * @example
-* var ndarray = require( '@stdlib/ndarray-base-ctor' );
+* var vector = require( '@stdlib/ndarray-vector-ctor' );
 *
-* var xbuf = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
-* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
-*
-* var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
-* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
+* var x = vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ], 'generic' );
+* var y = vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ], 'generic' );
 *
 * var z = gdot( [ x, y ] );
 * // returns -5.0

docs/types/index.d.ts

@@ -18,21 +18,18 @@
 
 'use strict';
 
-var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
-var ndarray = require( '@stdlib/ndarray-base-ctor' );
+var discreteUniform = require( '@stdlib/random-discrete-uniform' );
 var ndarray2array = require( '@stdlib/ndarray-to-array' );
 var gdot = require( './../lib' );
 
 var opts = {
 	'dtype': 'generic'
 };
 
-var xbuf = discreteUniform( 10, 0, 500, opts );
-var x = new ndarray( opts.dtype, xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+var x = discreteUniform( [ 10 ], 0, 500, opts );
 console.log( ndarray2array( x ) );
 
-var ybuf = discreteUniform( 10, 0, 255, opts );
-var y = new ndarray( opts.dtype, ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' );
+var y = discreteUniform( [ 10 ], 0, 255, opts );
 console.log( ndarray2array( y ) );
 
 var out = gdot( [ x, y ] );

examples/index.js

@@ -24,14 +24,11 @@
 * @module @stdlib/blas-base-ndarray-gdot
 *
 * @example
-* var ndarray = require( '@stdlib/ndarray-base-ctor' );
+* var vector = require( '@stdlib/ndarray-vector-ctor' );
 * var gdot = require( '@stdlib/blas-base-ndarray-gdot' );
 *
-* var xbuf = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
-* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
-*
-* var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
-* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
+* var x = vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ], 'generic' );
+* var y = vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ], 'generic' );
 *
 * var z = gdot( [ x, y ] );
 * // returns -5.0

lib/index.js

@@ -36,13 +36,10 @@ var strided = require( '@stdlib/blas-base-gdot' ).ndarray;
 * @returns {number} dot product
 *
 * @example
-* var ndarray = require( '@stdlib/ndarray-base-ctor' );
+* var vector = require( '@stdlib/ndarray-vector-ctor' );
 *
-* var xbuf = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
-* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
-*
-* var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
-* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
+* var x = vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ], 'generic' );
+* var y = vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ], 'generic' );
 *
 * var z = gdot( [ x, y ] );
 * // returns -5.0