docs: update examples

kgryte · kgryte · commit 38a86ef2b647 · 2025-05-04T02:17:49.000-07:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/stats/max/README.md b/lib/node_modules/@stdlib/stats/max/README.md
@@ -35,10 +35,9 @@ var max = require( '@stdlib/stats/max' );
 Computes the maximum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
 
 ```javascript
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 
-var xbuf = [ -1.0, 2.0, -3.0 ];
-var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+var x = array( [ -1.0, 2.0, -3.0 ] );
 
 var y = max( x );
 // returns <ndarray>
@@ -62,10 +61,12 @@ By default, the function performs a reduction over all elements in a provided in
 
 ```javascript
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 
-var xbuf = [ -1.0, 2.0, -3.0, 4.0 ];
-var x = new ndarray( 'generic', xbuf, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
+    'shape': [ 2, 2 ],
+    'order': 'row-major'
+});
 
 var y = max( x, {
     'dims': [ 0 ]
@@ -96,10 +97,12 @@ By default, the function excludes reduced dimensions from the output [ndarray][@
 
 ```javascript
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var array = require( '@stdlib/ndarray/array' );
 
-var xbuf = [ -1.0, 2.0, -3.0, 4.0 ];
-var x = new ndarray( 'generic', xbuf, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
+    'shape': [ 2, 2 ],
+    'order': 'row-major'
+});
 
 var y = max( x, {
     'dims': [ 0 ],
@@ -132,18 +135,19 @@ v = ndarray2array( y );
 By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option.
 
 ```javascript
-var dtype = require( '@stdlib/ndarray/dtype' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var getDType = require( '@stdlib/ndarray/dtype' );
+var array = require( '@stdlib/ndarray/array' );
 
-var xbuf = [ -1.0, 2.0, -3.0 ];
-var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+var x = array( [ -1.0, 2.0, -3.0 ], {
+    'dtype': 'generic'
+});
 
 var y = max( x, {
     'dtype': 'float64'
 });
 // returns <ndarray>
 
-var dt = dtype( y );
+var dt = getDType( y );
 // returns 'float64'
 ```
 
@@ -152,13 +156,11 @@ var dt = dtype( y );
 Computes the maximum value along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].
 
 ```javascript
-var ndarray = require( '@stdlib/ndarray/ctor' );
-
-var xbuf = [ -1.0, 2.0, -3.0 ];
-var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+var array = require( '@stdlib/ndarray/array' );
+var zeros = require( '@stdlib/ndarray/zeros' );
 
-var ybuf = [ 0.0 ];
-var y = new ndarray( 'generic', ybuf, [], [ 0 ], 0, 'row-major' );
+var x = array( [ -1.0, 2.0, -3.0 ] );
+var y = zeros( [] );
 
 var out = max.assign( x, y );
 // returns <ndarray>
diff --git a/lib/node_modules/@stdlib/stats/max/docs/repl.txt b/lib/node_modules/@stdlib/stats/max/docs/repl.txt
@@ -29,13 +29,7 @@
 
     Examples
     --------
-    > var buf = [ -1.0, 2.0, -3.0, -4.0 ];
-    > var dt = 'generic';
-    > var sh = [ buf.length ];
-    > var sx = [ 1 ];
-    > var ox = 0;
-    > var ord = 'row-major';
-    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, buf, sh, sx, ox, ord );
+    > var x = new {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
     > var y = {{alias}}( x );
     > var v = y.get()
     2.0
@@ -68,14 +62,8 @@
 
     Examples
     --------
-    > var buf = [ -1.0, 2.0, -3.0, -4.0 ];
-    > var dt = 'generic';
-    > var sh = [ buf.length ];
-    > var sx = [ 1 ];
-    > var ox = 0;
-    > var ord = 'row-major';
-    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, buf, sh, sx, ox, ord );
-    > var out = {{alias:@stdlib/ndarray/zeros}}( [], { 'dtype': dt } );
+    > var x = new {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
+    > var out = {{alias:@stdlib/ndarray/zeros}}( [] );
     > var y = {{alias}}.assign( x, out )
     <ndarray>
     > var bool = ( out === y )
diff --git a/lib/node_modules/@stdlib/stats/max/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/max/docs/types/index.d.ts
@@ -70,10 +70,9 @@ interface Unary {
 	* @returns output ndarray
 	*
 	* @example
-	* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+	* var array = require( '@stdlib/ndarray/array' );
 	*
-	* var xbuf = [ -1.0, 2.0, -3.0 ];
-	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+	* var x = array( [ -1.0, 2.0, -3.0 ] );
 	*
 	* var y = max( x );
 	* // returns <ndarray>
@@ -92,13 +91,11 @@ interface Unary {
 	* @returns output ndarray
 	*
 	* @example
-	* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+	* var array = require( '@stdlib/ndarray/array' );
+	* var zeros = require( '@stdlib/ndarray/zeros' );
 	*
-	* var xbuf = [ -1.0, 2.0, -3.0 ];
-	* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
-	*
-	* var ybuf = [ 0.0 ];
-	* var y = new ndarray( 'generic', ybuf, [], [ 0 ], 0, 'row-major' );
+	* var x = array( [ -1.0, 2.0, -3.0 ] );
+	* var y = zeros( [] );
 	*
 	* var out = max.assign( x, y );
 	* // returns <ndarray>
@@ -120,10 +117,9 @@ interface Unary {
 * @returns output ndarray
 *
 * @example
-* var ndarray = require( '@stdlib/ndarray/base/ctor' );
+* var array = require( '@stdlib/ndarray/array' );
 *
-* var xbuf = [ -1.0, 2.0, -3.0 ];
-* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+* var x = array( [ -1.0, 2.0, -3.0 ] )
 *
 * var y = max( x );
 * // returns <ndarray>
@@ -132,13 +128,11 @@ interface Unary {
 * // returns 2.0
 *
 * @example
-* var ndarray = require( '@stdlib/ndarray/base/ctor' );
-*
-* var xbuf = [ -1.0, 2.0, -3.0 ];
-* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
+* var array = require( '@stdlib/ndarray/array' );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
-* var ybuf = [ 0.0 ];
-* var y = new ndarray( 'generic', ybuf, [], [ 0 ], 0, 'row-major' );
+* var x = array( [ -1.0, 2.0, -3.0 ] )
+* var y = zeros( [] );
 *
 * var out = max.assign( x, y );
 * // returns <ndarray>
diff --git a/lib/node_modules/@stdlib/stats/max/lib/index.js b/lib/node_modules/@stdlib/stats/max/lib/index.js
@@ -29,7 +29,7 @@
 * var max = require( '@stdlib/stats/max' );
 *
 * // Create a data buffer:
-* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var xbuf = new Float64Array( [ 0.0, 2.0, 3.0, 0.0, 0.0, 6.0, 7.0, 0.0, 0.0, 10.0, 11.0, 0.0 ] );
 *
 * // Define the shape of the input array:
 * var sh = [ 3, 1, 2 ];
diff --git a/lib/node_modules/@stdlib/stats/max/lib/main.js b/lib/node_modules/@stdlib/stats/max/lib/main.js
@@ -72,7 +72,7 @@ var table = {
 * var ndarray = require( '@stdlib/ndarray/ctor' );
 *
 * // Create a data buffer:
-* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
+* var xbuf = new Float64Array( [ 0.0, 2.0, 3.0, 0.0, 0.0, 6.0, 7.0, 0.0, 0.0, 10.0, 11.0, 0.0 ] );
 *
 * // Define the shape of the input array:
 * var sh = [ 3, 1, 2 ];

Original file line number	Diff line number	Diff line change
`@@ -70,10 +70,9 @@ interface Unary {`
`70`	`70`	`* @returns output ndarray`
`71`	`71`	`*`
`72`	`72`	`* @example`
`73`		`- * var ndarray = require( '@stdlib/ndarray/base/ctor' );`
	`73`	`+ * var array = require( '@stdlib/ndarray/array' );`
`74`	`74`	`*`
`75`		`- * var xbuf = [ -1.0, 2.0, -3.0 ];`
`76`		`- * var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );`
	`75`	`+ * var x = array( [ -1.0, 2.0, -3.0 ] );`
`77`	`76`	`*`
`78`	`77`	`* var y = max( x );`
`79`	`78`	`* // returns <ndarray>`
`@@ -92,13 +91,11 @@ interface Unary {`
`92`	`91`	`* @returns output ndarray`
`93`	`92`	`*`
`94`	`93`	`* @example`
`95`		`- * var ndarray = require( '@stdlib/ndarray/base/ctor' );`
	`94`	`+ * var array = require( '@stdlib/ndarray/array' );`
	`95`	`+ * var zeros = require( '@stdlib/ndarray/zeros' );`
`96`	`96`	`*`
`97`		`- * var xbuf = [ -1.0, 2.0, -3.0 ];`
`98`		`- * var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );`
`99`		`- *`
`100`		`- * var ybuf = [ 0.0 ];`
`101`		`- * var y = new ndarray( 'generic', ybuf, [], [ 0 ], 0, 'row-major' );`
	`97`	`+ * var x = array( [ -1.0, 2.0, -3.0 ] );`
	`98`	`+ * var y = zeros( [] );`
`102`	`99`	`*`
`103`	`100`	`* var out = max.assign( x, y );`
`104`	`101`	`* // returns <ndarray>`
`@@ -120,10 +117,9 @@ interface Unary {`
`120`	`117`	`* @returns output ndarray`
`121`	`118`	`*`
`122`	`119`	`* @example`
`123`		`-* var ndarray = require( '@stdlib/ndarray/base/ctor' );`
	`120`	`+* var array = require( '@stdlib/ndarray/array' );`
`124`	`121`	`*`
`125`		`-* var xbuf = [ -1.0, 2.0, -3.0 ];`
`126`		`-* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );`
	`122`	`+* var x = array( [ -1.0, 2.0, -3.0 ] )`
`127`	`123`	`*`
`128`	`124`	`* var y = max( x );`
`129`	`125`	`* // returns <ndarray>`
`@@ -132,13 +128,11 @@ interface Unary {`
`132`	`128`	`* // returns 2.0`
`133`	`129`	`*`
`134`	`130`	`* @example`
`135`		`-* var ndarray = require( '@stdlib/ndarray/base/ctor' );`
`136`		`-*`
`137`		`-* var xbuf = [ -1.0, 2.0, -3.0 ];`
`138`		`-* var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );`
	`131`	`+* var array = require( '@stdlib/ndarray/array' );`
	`132`	`+* var zeros = require( '@stdlib/ndarray/zeros' );`
`139`	`133`	`*`
`140`		`-* var ybuf = [ 0.0 ];`
`141`		`-* var y = new ndarray( 'generic', ybuf, [], [ 0 ], 0, 'row-major' );`
	`134`	`+* var x = array( [ -1.0, 2.0, -3.0 ] )`
	`135`	`+* var y = zeros( [] );`
`142`	`136`	`*`
`143`	`137`	`* var out = max.assign( x, y );`
`144`	`138`	`* // returns <ndarray>`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`* var max = require( '@stdlib/stats/max' );`
`30`	`30`	`*`
`31`	`31`	`* // Create a data buffer:`
`32`		`-* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );`
	`32`	`+* var xbuf = new Float64Array( [ 0.0, 2.0, 3.0, 0.0, 0.0, 6.0, 7.0, 0.0, 0.0, 10.0, 11.0, 0.0 ] );`
`33`	`33`	`*`
`34`	`34`	`* // Define the shape of the input array:`
`35`	`35`	`* var sh = [ 3, 1, 2 ];`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ var table = {`
`72`	`72`	`* var ndarray = require( '@stdlib/ndarray/ctor' );`
`73`	`73`	`*`
`74`	`74`	`* // Create a data buffer:`
`75`		`-* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );`
	`75`	`+* var xbuf = new Float64Array( [ 0.0, 2.0, 3.0, 0.0, 0.0, 6.0, 7.0, 0.0, 0.0, 10.0, 11.0, 0.0 ] );`
`76`	`76`	`*`
`77`	`77`	`* // Define the shape of the input array:`
`78`	`78`	`* var sh = [ 3, 1, 2 ];`