Refactor @stdlib/blas/base/sswap (#794)

* refactor readme

* refactor src/

* update readme

* update manifest.json and package.json

* refactor lib/

* refactor examples

* refactor benchmarks

* refactor tests

* refactor docs/

Author: Pranavchiku

lib/node_modules/@stdlib/blas/base/sswap/README.md

@@ -2,7 +2,7 @@
 
 @license Apache-2.0
 
-Copyright (c) 2020 The Stdlib Authors.
+Copyright (c) 2023 The Stdlib Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -53,7 +53,7 @@ The function has the following parameters:
 -   **y**: second input [`Float32Array`][mdn-float32array].
 -   **strideY**: index increment for `y`.
 
-The `N` and `stride` parameters determine how values from `x` and `y` are accessed at runtime. For example, to swap in reverse order every other value in `x` with the first `N` elements of `y`,
+The `N` and stride parameters determine how values from the strided arrays are accessed at runtime. For example, to swap in reverse order every other value in `x` with the first `N` elements of `y`,
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -107,7 +107,7 @@ The function has the following additional parameters:
 -   **offsetX**: starting index for `x`.
 -   **offsetY**: starting index for `y`.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offsetX` and `offsetY` parameters support indexing semantics based on starting indices. For example, to swap every other value in `x` starting from the second value with the last `N` elements in `y` where `x[i] = y[n]`, `x[i+2] = y[n-1]`,...,
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the offset parameters support indexing semantics based on starting indices. For example, to swap every other value in `x` starting from the second value with the last `N` elements in `y` where `x[i] = y[n]`, `x[i+2] = y[n-1]`,...,
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -142,22 +142,14 @@ sswap.ndarray( 3, x, 2, 1, y, -1, y.length-1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var randu = require( '@stdlib/random/base/randu' );
-var round = require( '@stdlib/math/base/special/round' );
-var Float32Array = require( '@stdlib/array/float32' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var sswap = require( '@stdlib/blas/base/sswap' );
 
-var x;
-var y;
-var i;
-
-x = new Float32Array( 10 );
-y = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-    x[ i ] = round( randu()*500.0 );
-    y[ i ] = round( randu()*255.0 );
-}
+var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 500 ) );
 console.log( x );
+
+var y = filledarrayBy( x.length, 'float32', discreteUniform( 0, 255 ) );
 console.log( y );
 
 // Swap elements in `x` and `y` starting from the end of `y`:

lib/node_modules/@stdlib/blas/base/sswap/benchmark/benchmark.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* Copyright (c) 2023 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -21,14 +21,19 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var sswap = require( './../lib/sswap.js' );
 
 
+// VARIABLES //
+
+var rand = uniform( -10000.0, 10000.0 );
+
+
 // FUNCTIONS //
 
 /**
@@ -39,15 +44,8 @@ var sswap = require( './../lib/sswap.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var y;
-	var i;
-
-	x = new Float32Array( len );
-	y = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20000.0 ) - 10000.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
+	var y = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	/**

lib/node_modules/@stdlib/blas/base/sswap/benchmark/benchmark.native.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* Copyright (c) 2023 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -22,10 +22,10 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +36,7 @@ var sswap = tryRequire( resolve( __dirname, './../lib/sswap.native.js' ) );
 var opts = {
 	'skip': ( sswap instanceof Error )
 };
+var rand = uniform( -10000.0, 10000.0 );
 
 
 // FUNCTIONS //
@@ -48,15 +49,8 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var y;
-	var i;
-
-	x = new Float32Array( len );
-	y = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20000.0 ) - 10000.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
+	var y = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	/**

lib/node_modules/@stdlib/blas/base/sswap/benchmark/benchmark.ndarray.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* Copyright (c) 2023 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -21,14 +21,19 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var sswap = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var rand = uniform( -10000.0, 10000.0 );
+
+
 // FUNCTIONS //
 
 /**
@@ -39,15 +44,8 @@ var sswap = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var y;
-	var i;
-
-	x = new Float32Array( len );
-	y = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20000.0 ) - 10000.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
+	var y = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	/**

lib/node_modules/@stdlib/blas/base/sswap/benchmark/benchmark.ndarray.native.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* Copyright (c) 2023 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -22,10 +22,10 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +36,7 @@ var sswap = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
 var opts = {
 	'skip': ( sswap instanceof Error )
 };
+var rand = uniform( -10000.0, 10000.0 );
 
 
 // FUNCTIONS //
@@ -48,15 +49,8 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var y;
-	var i;
-
-	x = new Float32Array( len );
-	y = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20000.0 ) - 10000.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
+	var y = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	/**

lib/node_modules/@stdlib/blas/base/sswap/docs/repl.txt

@@ -13,7 +13,7 @@
     Parameters
     ----------
     N: integer
-        Number of values to swap.
+        Number of values.
 
     x: Float32Array
         First input array.
@@ -30,7 +30,7 @@
     Returns
     -------
     y: Float32Array
-        Input array `y`.
+        Second input array.
 
     Examples
     --------
@@ -43,17 +43,15 @@
     // Advanced indexing:
     > x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
     > y = new {{alias:@stdlib/array/float32}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}( N, x, -2, y, 1 )
+    > {{alias}}( 3, x, -2, y, 1 )
     <Float32Array>[ 5.0, 3.0, 1.0, 10.0, 11.0, 12.0 ]
 
     // Using typed array views:
     > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
     > var y0 = new {{alias:@stdlib/array/float32}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
     > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
     > var y1 = new {{alias:@stdlib/array/float32}}( y0.buffer, y0.BYTES_PER_ELEMENT*3 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > {{alias}}( N, x1, -2, y1, 1 )
+    > {{alias}}( 3, x1, -2, y1, 1 )
     <Float32Array>[ 6.0, 4.0, 2.0 ]
     > y0
     <Float32Array>[ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
@@ -64,13 +62,13 @@
     indexing semantics.
 
     While typed array views mandate a view offset based on the underlying
-    buffer, the `offset` parameters support indexing semantics based on starting
+    buffer, the offset parameters support indexing semantics based on starting
     indices.
 
     Parameters
     ----------
     N: integer
-        Number of values to swap.
+        Number of values.
 
     x: Float32Array
         First input array.
@@ -93,7 +91,7 @@
     Returns
     -------
     y: Float32Array
-        Input array `y`.
+        Second input array.
 
     Examples
     --------
@@ -106,8 +104,7 @@
     // Advanced indexing:
     > x = new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
     > y = new {{alias:@stdlib/array/float32}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, x, 2, 1, y, -1, y.length-1 )
+    > {{alias}}.ndarray( 3, x, 2, 1, y, -1, y.length-1 )
     <Float32Array>[ 7.0, 8.0, 9.0, 6.0, 4.0, 2.0 ]
 
     See Also

lib/node_modules/@stdlib/blas/base/sswap/docs/types/index.d.ts

@@ -1,7 +1,7 @@
 /*
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* Copyright (c) 2023 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@ interface Routine {
 	/**
 	* Interchanges two single-precision floating-point vectors.
 	*
-	* @param N - number of values to swap
+	* @param N - number of values
 	* @param x - first input array
 	* @param strideX - `x` stride length
 	* @param y - second input array
@@ -47,7 +47,7 @@ interface Routine {
 	/**
 	* Interchanges two single-precision floating-point vectors using alternative indexing semantics.
 	*
-	* @param N - number of values to swap
+	* @param N - number of values
 	* @param x - first input array
 	* @param strideX - `x` stride length
 	* @param offsetX - starting index for `x`

lib/node_modules/@stdlib/blas/base/sswap/examples/index.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2020 The Stdlib Authors.
+* Copyright (c) 2023 The Stdlib Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -18,22 +18,14 @@
 
 'use strict';
 
-var randu = require( '@stdlib/random/base/randu' );
-var round = require( '@stdlib/math/base/special/round' );
-var Float32Array = require( '@stdlib/array/float32' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var sswap = require( './../lib' );
 
-var x;
-var y;
-var i;
-
-x = new Float32Array( 10 );
-y = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-	x[ i ] = round( randu()*500.0 );
-	y[ i ] = round( randu()*255.0 );
-}
+var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 500 ) );
 console.log( x );
+
+var y = filledarrayBy( x.length, 'float32', discreteUniform( 0, 255 ) );
 console.log( y );
 
 // Swap elements in `x` and `y` starting from the end of `y`: