fix: refactor drev to use arrays API pattern

Author: Amansingh0807

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/README.md

@@ -43,32 +43,26 @@ Reverses the elements of a one-dimensional double-precision floating-point ndarr
 ```javascript
 var Float64Array = require( '@stdlib/array/float64' );
 var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 var xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] );
 var x = new ndarray( 'float64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
 
-drev( x );
+drev( [ x ] );
 // x => <ndarray>[ 3.0, 2.0, 1.0 ]
+
+var arr = ndarray2array( x );
+// returns [ 3.0, 2.0, 1.0 ]
 ```
 
 The function has the following parameters:
 
--   **x**: input ndarray.
+-   **arrays**: array-like object containing a single one-dimensional input ndarray.
 
 </section>
 
 <!-- /.usage -->
 
-<section class="notes">
-
-## Notes
-
--   The function **mutates** the input ndarray.
-
-</section>
-
-<!-- /.notes -->
-
 <section class="examples">
 
 ## Examples
@@ -87,7 +81,7 @@ var xbuf = discreteUniform( 10, -50, 50, {
 var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
 console.log( ndarray2array( x ) );
 
-drev( x );
+drev( [ x ] );
 console.log( ndarray2array( x ) );
 ```
 

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/benchmark/benchmark.js

@@ -58,7 +58,7 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			drev( x );
+			drev( [ x ] );
 			if ( xbuf[ 0 ] !== xbuf[ 0 ] ) {
 				b.fail( 'should not return NaN' );
 			}

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/docs/repl.txt

@@ -1,14 +1,12 @@
 
-{{alias}}( x )
+{{alias}}( arrays )
     Reverses the elements of a one-dimensional double-precision floating-point
     ndarray in-place.
 
-    The function mutates the input ndarray.
-
     Parameters
     ----------
-    x: ndarray
-        Input ndarray.
+    arrays: ArrayLikeObject<ndarray>
+        Array-like object containing a single one-dimensional input ndarray.
 
     Returns
     -------
@@ -18,14 +16,11 @@
     Examples
     --------
     > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0 ] );
-    > var dt = 'float64';
-    > var sh = [ xbuf.length ];
-    > var sx = [ 1 ];
-    > var ox = 0;
-    > var ord = 'row-major';
-    > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
-    > {{alias}}( x )
-    <ndarray>[ 3.0, 2.0, 1.0 ]
+    > var x = {{alias:@stdlib/ndarray/base/ctor}}( 'float64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
+    > {{alias}}( [ x ] )
+    <ndarray>
+    > var data = x.data
+    <Float64Array>[ 3.0, 2.0, 1.0 ]
 
     See Also
     --------

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/docs/types/index.d.ts

@@ -25,7 +25,7 @@ import { float64ndarray } from '@stdlib/types/ndarray';
 /**
 * Reverses the elements of a one-dimensional double-precision floating-point ndarray in-place.
 *
-* @param x - input ndarray
+* @param arrays - array-like object containing a single one-dimensional input ndarray
 * @returns input ndarray
 *
 * @example
@@ -35,10 +35,10 @@ import { float64ndarray } from '@stdlib/types/ndarray';
 * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] );
 * var x = new ndarray( 'float64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
 *
-* drev( x );
+* drev( [ x ] );
 * // x => <ndarray>[ 3.0, 2.0, 1.0 ]
 */
-declare function drev( x: float64ndarray ): float64ndarray;
+declare function drev( arrays: [ float64ndarray ] ): float64ndarray;
 
 
 // EXPORTS //

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/docs/types/test.ts

@@ -16,42 +16,34 @@
 * limitations under the License.
 */
 
-/* eslint-disable space-in-parens */
-
-import zeros = require( '@stdlib/ndarray/zeros' );
+import zeros = require( '@stdlib/ndarray/base/zeros' );
 import drev = require( './index' );
 
 
 // TESTS //
 
 // The function returns an ndarray...
 {
-	const x = zeros( [ 3 ], {
-		'dtype': 'float64'
-	});
-
-	drev( x ); // $ExpectType float64ndarray
+	const x = zeros( 'float64', [ 3 ], 'row-major' );
+	drev( [ x ] ); // $ExpectType float64ndarray
 }
 
-// The compiler throws an error if the function is provided a first argument which is not an ndarray...
+// The compiler throws an error if the function is provided a first argument which is not an array-like object containing ndarrays...
 {
-	drev( '10' ); // $ExpectError
-	drev( 10 ); // $ExpectError
+	drev( 123 ); // $ExpectError
 	drev( true ); // $ExpectError
 	drev( false ); // $ExpectError
 	drev( null ); // $ExpectError
 	drev( undefined ); // $ExpectError
-	drev( [] ); // $ExpectError
+	drev( '5' ); // $ExpectError
+	drev( [ '1', '2' ] ); // $ExpectError
 	drev( {} ); // $ExpectError
 	drev( ( x: number ): number => x ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
 {
-	const x = zeros( [ 3 ], {
-		'dtype': 'float64'
-	});
-
+	const x = zeros( 'float64', [ 3 ], 'row-major' );
 	drev(); // $ExpectError
-	drev( x, {} ); // $ExpectError
+	drev( [ x ], 10 ); // $ExpectError
 }

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/examples/index.js

@@ -29,5 +29,5 @@ var xbuf = discreteUniform( 10, -50, 50, {
 var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
 console.log( ndarray2array( x ) );
 
-drev( x );
+drev( [ x ] );
 console.log( ndarray2array( x ) );

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/lib/index.js

@@ -31,7 +31,7 @@
 * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] );
 * var x = new ndarray( 'float64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
 *
-* drev( x );
+* drev( [ x ] );
 * // x => <ndarray>[ 3.0, 2.0, 1.0 ]
 */
 

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/lib/main.js

@@ -32,7 +32,7 @@ var strided = require( '@stdlib/blas/ext/base/drev' ).ndarray;
 /**
 * Reverses the elements of a one-dimensional double-precision floating-point ndarray in-place.
 *
-* @param {ndarray} x - input ndarray
+* @param {ArrayLikeObject<Object>} arrays - array-like object containing a single one-dimensional input ndarray
 * @returns {ndarray} input ndarray
 *
 * @example
@@ -42,10 +42,11 @@ var strided = require( '@stdlib/blas/ext/base/drev' ).ndarray;
 * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0 ] );
 * var x = new ndarray( 'float64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
 *
-* drev( x );
+* drev( [ x ] );
 * // x => <ndarray>[ 3.0, 2.0, 1.0 ]
 */
-function drev( x ) {
+function drev( arrays ) {
+	var x = arrays[ 0 ];
 	strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len
 	return x;
 }

lib/node_modules/@stdlib/blas/ext/base/ndarray/drev/test/test.js

@@ -63,13 +63,13 @@ tape( 'the function reverses the elements of a one-dimensional ndarray in-place'
 	x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
 	expected = new Float64Array( [ 5.0, 4.0, 3.0, 2.0, 1.0 ] );
 
-	drev( vector( x, 5, 1, 0 ) );
+	drev( [ vector( x, 5, 1, 0 ) ] );
 	t.deepEqual( x, expected, 'returns expected value' );
 
 	x = new Float64Array( [ -1.0, -2.0, -3.0 ] );
 	expected = new Float64Array( [ -3.0, -2.0, -1.0 ] );
 
-	drev( vector( x, 3, 1, 0 ) );
+	drev( [ vector( x, 3, 1, 0 ) ] );
 	t.deepEqual( x, expected, 'returns expected value' );
 
 	t.end();
@@ -80,7 +80,7 @@ tape( 'the function returns the input ndarray', function test( t ) {
 	var y;
 
 	x = vector( new Float64Array( [ 1.0, 2.0, 3.0 ] ), 3, 1, 0 );
-	y = drev( x );
+	y = drev( [ x ] );
 
 	t.strictEqual( y, x, 'returns input ndarray' );
 	t.end();
@@ -93,7 +93,7 @@ tape( 'if provided an empty ndarray, the function leaves the ndarray unchanged',
 	x = new Float64Array( [] );
 	expected = new Float64Array( [] );
 
-	drev( vector( x, 0, 1, 0 ) );
+	drev( [ vector( x, 0, 1, 0 ) ] );
 	t.deepEqual( x, expected, 'returns expected value' );
 
 	t.end();
@@ -106,7 +106,7 @@ tape( 'if provided an ndarray containing a single element, the function leaves t
 	x = new Float64Array( [ 1.0 ] );
 	expected = new Float64Array( [ 1.0 ] );
 
-	drev( vector( x, 1, 1, 0 ) );
+	drev( [ vector( x, 1, 1, 0 ) ] );
 	t.deepEqual( x, expected, 'returns expected value' );
 
 	t.end();
@@ -137,7 +137,7 @@ tape( 'the function supports one-dimensional ndarrays having non-unit strides',
 		8.0
 	]);
 
-	drev( vector( x, 4, 2, 0 ) );
+	drev( [ vector( x, 4, 2, 0 ) ] );
 
 	t.deepEqual( x, expected, 'returns expected value' );
 	t.end();
@@ -168,7 +168,7 @@ tape( 'the function supports one-dimensional ndarrays having negative strides',
 		8.0
 	]);
 
-	drev( vector( x, 4, -2, 6 ) );
+	drev( [ vector( x, 4, -2, 6 ) ] );
 
 	t.deepEqual( x, expected, 'returns expected value' );
 	t.end();
@@ -199,7 +199,7 @@ tape( 'the function supports one-dimensional ndarrays having non-zero offsets',
 		2.0   // reversed: 0 -> 3
 	]);
 
-	drev( vector( x, 4, 2, 1 ) );
+	drev( [ vector( x, 4, 2, 1 ) ] );
 	t.deepEqual( x, expected, 'returns expected value' );
 
 	t.end();