refactor: update blas/ext/base/srev to follow current project conve…

…ntions Closes: #1533 Ref: #1152 PR-URL: #1700 Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Snehil Shah <[email protected]>
stdlib-js · Mar 5, 2024 · 7c23a54 · 7c23a54 · stdlib-bot · Mar 5, 2024
1 parent e330815
commit 7c23a54
Show file tree

Hide file tree

Showing 18 changed files with 149 additions and 259 deletions.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/README.md b/lib/node_modules/@stdlib/blas/ext/base/srev/README.md
@@ -49,34 +49,30 @@ The function has the following parameters:
 -   **x**: input [`Float32Array`][@stdlib/array/float32].
 -   **stride**: index increment.
 
-The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to reverse every other element
+The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to reverse every other element
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
-var N = floor( x.length / 2 );
 
-srev( N, x, 2 );
+srev( 4, x, 2 );
 // x => <Float32Array>[ -1.0, 1.0, 4.0, -5.0, 3.0, 0.0, -2.0, -3.0 ]
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
-var floor = require( '@stdlib/math/base/special/floor' );
 
 // Initial array...
 var x0 = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
 
 // Create an offset view...
 var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
-var N = floor( x0.length/2 );
 
 // Reverse every other element...
-srev( N, x1, 2 );
+srev( 3, x1, 2 );
 // x0 => <Float32Array>[ 1.0, -6.0, 3.0, -4.0, 5.0, -2.0 ]
 ```
 
@@ -97,7 +93,7 @@ The function has the following additional parameters:
 
 -   **offset**: starting index.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of `x`
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of the strided array
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
@@ -116,7 +112,7 @@ srev.ndarray( 3, x, 1, x.length-3 );
 
 ## Notes
 
--   If `N <= 0`, both functions return `x` unchanged.
+-   If `N <= 0`, both functions return the strided array unchanged.
 -   Where possible, one should "reverse" a strided array by negating its stride, which is an `O(1)` operation, in contrast to performing an in-place reversal, which is `O(N)`. However, in certain circumstances, this is not tenable, particularly when interfacing with libraries which assume and/or expect a specific memory layout (e.g., strided array elements arranged in memory in ascending order). In general, when working with strided arrays, only perform an in-place reversal when strictly necessary.
 
 </section>
@@ -130,27 +126,13 @@ srev.ndarray( 3, x, 1, x.length-3 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var round = require( '@stdlib/math/base/special/round' );
-var randu = require( '@stdlib/random/base/randu' );
-var Float32Array = require( '@stdlib/array/float32' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var srev = require( '@stdlib/blas/ext/base/srev' );
 
-var rand;
-var sign;
-var x;
-var i;
-
-x = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-    rand = round( randu()*100.0 );
-    sign = randu();
-    if ( sign < 0.5 ) {
-        sign = -1.0;
-    } else {
-        sign = 1.0;
-    }
-    x[ i ] = sign * rand;
-}
+var rand = discreteUniform( -100, 100 );
+
+var x = filledarrayBy( 10, 'float32', rand );
 console.log( x );
 
 srev( x.length, x, 1 );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/srev/benchmark/benchmark.js
@@ -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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var srev = require( './../lib/srev.js' );
 
 
+// VARIABLES //
+
+var rand = uniform( -10.0, 10.0 );
+
+
 // FUNCTIONS //
 
 /**
@@ -39,13 +44,7 @@ var srev = require( './../lib/srev.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < len; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/srev/benchmark/benchmark.native.js
@@ -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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 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 srev = tryRequire( resolve( __dirname, './../lib/srev.native.js' ) );
 var opts = {
 	'skip': ( srev instanceof Error )
 };
+var rand = uniform( -10.0, 10.0 );
 
 
 // FUNCTIONS //
@@ -48,13 +49,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < len; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/srev/benchmark/benchmark.ndarray.js
@@ -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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var srev = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var rand = uniform( -10.0, 10.0 );
+
+
 // FUNCTIONS //
 
 /**
@@ -39,13 +44,7 @@ var srev = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < len; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/srev/benchmark/benchmark.ndarray.native.js
@@ -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 isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 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 srev = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
 var opts = {
 	'skip': ( srev instanceof Error )
 };
+var rand = uniform( -10.0, 10.0 );
 
 
 // FUNCTIONS //
@@ -48,13 +49,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < len; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = filledarrayBy( len, 'float32', rand );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/srev/docs/repl.txt
@@ -2,8 +2,8 @@
 {{alias}}( N, x, stride )
     Reverses a single-precision floating-point strided array in-place.
 
-    The `N` and `stride` parameters determine which elements in `x` are accessed
-    at runtime.
+    The `N` and `stride` parameters determine which elements in the strided
+    array are accessed at runtime.
 
     Indexing is relative to the first index. To introduce an offset, use typed
     array views.
@@ -24,7 +24,7 @@
     Returns
     -------
     x: Float32Array
-        Input array `x`.
+        Input array.
 
     Examples
     --------
@@ -35,19 +35,18 @@
 
     // Using `N` and `stride` parameters:
     > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}( N, x, 2 )
+    > {{alias}}( 3, x, 2 )
     <Float32Array>[ 4.0, 1.0, 3.0, -5.0, -2.0, -1.0, -3.0 ]
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
     > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > {{alias}}( N, x1, 2 )
+    > {{alias}}( 3, x1, 2 )
     <Float32Array>[ -6.0, 3.0, -4.0, 5.0, -2.0 ]
     > x0
     <Float32Array>[ 1.0, -6.0, 3.0, -4.0, 5.0, -2.0 ]
 
+
 {{alias}}.ndarray( N, x, stride, offset )
     Reverses a single-precision floating-point strided array in-place using
     alternative indexing semantics.
@@ -73,7 +72,7 @@
     Returns
     -------
     x: Float32Array
-        Input array `x`.
+        Input array.
 
     Examples
     --------
@@ -84,8 +83,7 @@
 
     // Using an index offset:
     > x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, x, 2, 1 )
+    > {{alias}}.ndarray( 3, x, 2, 1 )
     <Float32Array>[ 1.0, -6.0, 3.0, -4.0, 5.0, -2.0 ]
 
     See Also

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/srev/docs/types/index.d.ts
@@ -28,7 +28,7 @@ interface Routine {
 	* @param N - number of indexed elements
 	* @param x - input array
 	* @param stride - stride length
-	* @returns `x`
+	* @returns input array
 	*
 	* @example
 	* var Float32Array = require( '@stdlib/array/float32' );
@@ -47,7 +47,7 @@ interface Routine {
 	* @param x - input array
 	* @param stride - stride length
 	* @param offset - starting index
-	* @returns `x`
+	* @returns input array
 	*
 	* @example
 	* var Float32Array = require( '@stdlib/array/float32' );
@@ -66,7 +66,7 @@ interface Routine {
 * @param N - number of indexed elements
 * @param x - input array
 * @param stride - stride length
-* @returns `x`
+* @returns input array
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/srev/examples/index.js
@@ -18,27 +18,13 @@
 
 'use strict';
 
-var round = require( '@stdlib/math/base/special/round' );
-var randu = require( '@stdlib/random/base/randu' );
-var Float32Array = require( '@stdlib/array/float32' );
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filledarrayBy = require( '@stdlib/array/filled-by' );
 var srev = require( './../lib' );
 
-var rand;
-var sign;
-var x;
-var i;
+var rand = discreteUniform( -100, 100 );
 
-x = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-	rand = round( randu()*100.0 );
-	sign = randu();
-	if ( sign < 0.5 ) {
-		sign = -1.0;
-	} else {
-		sign = 1.0;
-	}
-	x[ i ] = sign * rand;
-}
+var x = filledarrayBy( 10, 'float32', rand );
 console.log( x );
 
 srev( x.length, x, 1 );

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/srev/include.gypi
@@ -36,7 +36,7 @@
 
     # Source files:
     'src_files': [
-      '<(src_dir)/addon.cpp',
+      '<(src_dir)/addon.c',
       '<!@(node -e "var arr = require(\'@stdlib/utils/library-manifest\')(\'./manifest.json\',{},{\'basedir\':process.cwd(),\'paths\':\'posix\'}).src; for ( var i = 0; i < arr.length; i++ ) { console.log( arr[ i ] ); }")',
     ],
 

diff --git a/lib/node_modules/@stdlib/blas/ext/base/srev/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/srev/lib/ndarray.native.js
@@ -20,7 +20,8 @@
 
 // MODULES //
 
-var Float32Array = require( '@stdlib/array/float32' );
+var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' );
+var offsetView = require( '@stdlib/strided/base/offset-view' );
 var addon = require( './srev.native.js' );
 
 
@@ -45,10 +46,10 @@ var addon = require( './srev.native.js' );
 */
 function srev( N, x, stride, offset ) {
 	var view;
-	if ( stride < 0 ) {
-		offset += (N-1) * stride;
-	}
-	view = new Float32Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len
+
+	offset = minViewBufferIndex( N, stride, offset );
+	view = offsetView( x, offset );
+
 	addon( N, view, stride );
 	return x;
 }