fix: update paths, descriptions, and examples

aman-095 · web-flow · commit 6b0d3fc30e73 · 2024-06-26T17:22:49.000-07:00
PR-URL: stdlib-js#2457 Reviewed-by: Athan Reines <kgryte@gmail.com>
diff --git a/lib/node_modules/@stdlib/blas/base/scnrm2/README.md b/lib/node_modules/@stdlib/blas/base/scnrm2/README.md
@@ -128,7 +128,7 @@ var norm = scnrm2.ndarray( 2, cx, 1, 1 );
 ```javascript
 var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
 var filledarrayBy = require( '@stdlib/array/filled-by' );
-var Complex64 = require( '@stdlib/complex/float32' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
 var scnrm2 = require( '@stdlib/blas/base/scnrm2' );
 
 function rand() {
diff --git a/lib/node_modules/@stdlib/blas/base/scnrm2/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/scnrm2/docs/types/index.d.ts
@@ -75,17 +75,17 @@ interface Routine {
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 *
-* var cx = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2, 2.0, 3.0 ] );
+* var cx = new Complex64Array( [ 0.3, 0.1, 5.0, 8.0, 0.5, 0.0, 6.0, 9.0, 0.0, 0.5, 8.0, 3.0, 0.0, 0.2, 9.0, 4.0 ] );
 *
-* var norm = scnrm2( 4, cx, 1 );
+* var norm = scnrm2( 4, cx, 2 );
 * // returns ~0.8
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 *
-* var cx = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2, 2.0, 3.0 ] );
+* var cx = new Complex64Array( [ 0.3, 0.1, 5.0, 8.0, 0.5, 0.0, 6.0, 9.0, 0.0, 0.5, 8.0, 3.0, 0.0, 0.2, 9.0, 4.0 ] );
 *
-* var norm = scnrm2.ndarray( 4, cx, 1, 0 );
+* var norm = scnrm2.ndarray( 4, cx, 2, 0 );
 * // returns ~0.8
 */
 declare var scnrm2: Routine;
diff --git a/lib/node_modules/@stdlib/blas/base/scnrm2/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/scnrm2/test/test.ndarray.js
@@ -108,7 +108,7 @@ tape( 'the function computes the L2-norm', function test( t ) {
 	t.end();
 });
 
-tape( 'if provided an `N` parameter less than `1`, the function returns `0.0`', function test( t ) {
+tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0.0`', function test( t ) {
 	var expected;
 	var actual;
 	var cx;
diff --git a/lib/node_modules/@stdlib/blas/base/scnrm2/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/base/scnrm2/test/test.ndarray.native.js
@@ -117,7 +117,7 @@ tape( 'the function computes the L2-norm', opts, function test( t ) {
 	t.end();
 });
 
-tape( 'if provided an `N` parameter less than `1`, the function returns `0.0`', opts, function test( t ) {
+tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0.0`', opts, function test( t ) {
 	var expected;
 	var actual;
 	var cx;
diff --git a/lib/node_modules/@stdlib/blas/base/scnrm2/test/test.scnrm2.js b/lib/node_modules/@stdlib/blas/base/scnrm2/test/test.scnrm2.js
@@ -108,7 +108,7 @@ tape( 'the function computes the L2-norm', function test( t ) {
 	t.end();
 });
 
-tape( 'if provided an `N` parameter less than `1`, the function returns `0.0`', function test( t ) {
+tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0.0`', function test( t ) {
 	var expected;
 	var actual;
 	var cx;
diff --git a/lib/node_modules/@stdlib/blas/base/scnrm2/test/test.scnrm2.native.js b/lib/node_modules/@stdlib/blas/base/scnrm2/test/test.scnrm2.native.js
@@ -117,7 +117,7 @@ tape( 'the function computes the L2-norm', opts, function test( t ) {
 	t.end();
 });
 
-tape( 'if provided an `N` parameter less than `1`, the function returns `0.0`', opts, function test( t ) {
+tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `0.0`', opts, function test( t ) {
 	var expected;
 	var actual;
 	var cx;

Original file line number	Diff line number	Diff line change
`@@ -75,17 +75,17 @@ interface Routine {`
`75`	`75`	`* @example`
`76`	`76`	`* var Complex64Array = require( '@stdlib/array/complex64' );`
`77`	`77`	`*`
`78`		`-* var cx = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2, 2.0, 3.0 ] );`
	`78`	`+* var cx = new Complex64Array( [ 0.3, 0.1, 5.0, 8.0, 0.5, 0.0, 6.0, 9.0, 0.0, 0.5, 8.0, 3.0, 0.0, 0.2, 9.0, 4.0 ] );`
`79`	`79`	`*`
`80`		`-* var norm = scnrm2( 4, cx, 1 );`
	`80`	`+* var norm = scnrm2( 4, cx, 2 );`
`81`	`81`	`* // returns ~0.8`
`82`	`82`	`*`
`83`	`83`	`* @example`
`84`	`84`	`* var Complex64Array = require( '@stdlib/array/complex64' );`
`85`	`85`	`*`
`86`		`-* var cx = new Complex64Array( [ 0.3, 0.1, 0.5, 0.0, 0.0, 0.5, 0.0, 0.2, 2.0, 3.0 ] );`
	`86`	`+* var cx = new Complex64Array( [ 0.3, 0.1, 5.0, 8.0, 0.5, 0.0, 6.0, 9.0, 0.0, 0.5, 8.0, 3.0, 0.0, 0.2, 9.0, 4.0 ] );`
`87`	`87`	`*`
`88`		`-* var norm = scnrm2.ndarray( 4, cx, 1, 0 );`
	`88`	`+* var norm = scnrm2.ndarray( 4, cx, 2, 0 );`
`89`	`89`	`* // returns ~0.8`
`90`	`90`	`*/`
`91`	`91`	`declare var scnrm2: Routine;`