feat: add support for stack for blas/sswap

lib/node_modules/@stdlib/blas/dswap/docs/types/test.ts

@@ -24,12 +24,12 @@ import dswap = require( './index' );
 
 // The function returns an ndarray...
 {
-	dswap( zeros( [ 10 ] ), zeros( [ 10 ] ) ); // $ExpectType float64ndarray
+	dswap( zeros( [ 10 ], { 'dtype': 'float64' } ), zeros( [ 10 ], { 'dtype': 'float64' } ) ); // $ExpectType float64ndarray
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an ndarray...
 {
-	const y = zeros( [ 10 ] );
+	const y = zeros( [ 10 ], { 'dtype': 'float64' } );
 
 	dswap( 10, y ); // $ExpectError
 	dswap( '10', y ); // $ExpectError
@@ -54,7 +54,7 @@ import dswap = require( './index' );
 
 // The compiler throws an error if the function is provided a second argument which is not an ndarray...
 {
-	const x = zeros( [ 10 ] );
+	const x = zeros( [ 10 ], { 'dtype': 'float64' } );
 
 	dswap( x, 10 ); // $ExpectError
 	dswap( x, '10' ); // $ExpectError
@@ -79,8 +79,8 @@ import dswap = require( './index' );
 
 // The compiler throws an error if the function is provided a third argument which is not a number...
 {
-	const x = zeros( [ 10 ] );
-	const y = zeros( [ 10 ] );
+	const x = zeros( [ 10 ], { 'dtype': 'float64' } );
+	const y = zeros( [ 10 ], { 'dtype': 'float64' } );
 
 	dswap( x, y, '10' ); // $ExpectError
 	dswap( x, y, true ); // $ExpectError
@@ -93,8 +93,8 @@ import dswap = require( './index' );
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
 {
-	const x = zeros( [ 10 ] );
-	const y = zeros( [ 10 ] );
+	const x = zeros( [ 10 ], { 'dtype': 'float64' } );
+	const y = zeros( [ 10 ], { 'dtype': 'float64' } );
 
 	dswap(); // $ExpectError
 	dswap( x ); // $ExpectError

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

@@ -36,7 +36,7 @@ limitations under the License.
 var sswap = require( '@stdlib/blas/sswap' );
 ```
 
-#### sswap( x, y )
+#### sswap( x, y\[, dim] )
 
 Interchanges two single-precision floating-point vectors `x` and `y`.
 
@@ -58,8 +58,36 @@ var ybuf = y.data;
 
 The function has the following parameters:
 
--   **x**: a 1-dimensional [`ndarray`][@stdlib/ndarray/array] whose underlying data type is `float32`.
--   **y**: a 1-dimensional [`ndarray`][@stdlib/ndarray/array] whose underlying data type is `float32`.
+-   **x**: a non-zero-dimensional [`ndarray`][@stdlib/ndarray/ctor] whose underlying data type is `float32`. Must have the same shape as `y`.
+-   **y**: a non-zero-dimensional [`ndarray`][@stdlib/ndarray/ctor] whose underlying data type is `float32`. Must have the same shape as `x`.
+-   **dim**: dimension along which to interchange vectors. Must be a negative integer. Negative indices are resolved relative to the last array dimension, with the last dimension corresponding to `-1`. Default: `-1`.
+
+For multi-dimensional input [`ndarrays`][@stdlib/ndarray/ctor], the function performs batched computation, such that the function interchanges each pair of vectors in `x` and `y` according to the specified dimension index.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+var array = require( '@stdlib/ndarray/array' );
+
+var opts = {
+    'shape': [ 2, 3 ]
+};
+var x = array( new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 3.0 ] ), opts );
+var y = array( new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 2.0 ] ), opts );
+
+var v1 = x.get( 0, 0 );
+// returns 4.0
+
+var v2 = y.get( 0, 0 );
+// returns 2.0
+
+sswap( x, y );
+
+v1 = x.get( 0, 0 );
+// returns 2.0
+
+v2 = y.get( 0, 0 );
+// returns 4.0
+```
 
 </section>
 
@@ -69,6 +97,9 @@ The function has the following parameters:
 
 ## Notes
 
+-   Both input [`ndarrays`][@stdlib/ndarray/ctor] must have the same shape.
+-   Negative indices are resolved relative to the last [`ndarray`][@stdlib/ndarray/ctor] dimension, with the last dimension corresponding to `-1`.
+-   For multi-dimensional [`ndarrays`][@stdlib/ndarray/ctor], batched computation effectively means swapping all of `x` with all of `y`; however, the choice of `dim` will significantly affect performance. For best performance, specify a `dim` which best aligns with the [memory layout][@stdlib/ndarray/orders] of provided [`ndarrays`][@stdlib/ndarray/ctor]. 
 -   `sswap()` provides a higher-level interface to the [BLAS][blas] level 1 function [`sswap`][@stdlib/blas/base/sswap].
 
 </section>
@@ -82,28 +113,28 @@ The function has the following parameters:
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
-var Float32Array = require( '@stdlib/array/float32' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 var sswap = require( '@stdlib/blas/sswap' );
 
-var x = array( new Float32Array( 10 ) );
-var y = array( new Float32Array( 10 ) );
+var opts = {
+    'dtype': 'float32'
+};
 
-var rand1 = discreteUniform.factory( 0, 100 );
-var rand2 = discreteUniform.factory( 0, 10 );
+var x = array( discreteUniform( 10, 0, 100, opts ), {
+    'shape': [ 5, 2 ]
+});
+console.log( ndarray2array( x ) );
 
-var i;
-for ( i = 0; i < x.length; i++ ) {
-    x.set( i, rand1() );
-    y.set( i, rand2() );
-}
-console.log( x.data );
-console.log( y.data );
+var y = array( discreteUniform( 10, 0, 10, opts ), {
+    'shape': x.shape
+});
+console.log( ndarray2array( y ) );
 
 sswap( x, y );
-console.log( x.data );
-console.log( y.data );
+console.log( ndarray2array( x ) );
+console.log( ndarray2array( y ) );
 ```
 
 </section>
@@ -114,14 +145,6 @@ console.log( y.data );
 
 <section class="related">
 
-* * *
-
-## See Also
-
--   <span class="package-name">[`@stdlib/blas/base/sswap`][@stdlib/blas/base/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
--   <span class="package-name">[`@stdlib/blas/dswap`][@stdlib/blas/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
--   <span class="package-name">[`@stdlib/blas/gswap`][@stdlib/blas/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
-
 </section>
 
 <!-- /.related -->
@@ -132,18 +155,12 @@ console.log( y.data );
 
 [blas]: http://www.netlib.org/blas
 
-[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
 
-<!-- <related-links> -->
+[@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders
 
 [@stdlib/blas/base/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sswap
 
-[@stdlib/blas/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/dswap
-
-[@stdlib/blas/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/gswap
-
-<!-- </related-links> -->
-
 </section>
 
 <!-- /.links -->

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

@@ -21,15 +21,21 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var Float32Array = require( '@stdlib/array/float32' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var array = require( '@stdlib/ndarray/array' );
 var pkg = require( './../package.json' ).name;
 var sswap = require( './../lib/main.js' );
 
 
+// VARIABLES //
+
+var opts = {
+	'dtype': 'float32'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -40,34 +46,29 @@ var sswap = require( './../lib/main.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 < len; i++ ) {
-		x[ i ] = ( randu()*10.0 ) - 20.0;
-		y[ i ] = ( randu()*10.0 ) - 20.0;
-	}
-	x = array( x );
-	y = array( y );
-
+	var x = array( uniform( len, -100.0, 100.0, opts ) );
+	var y = array( uniform( len, -100.0, 100.0, opts ) );
 	return benchmark;
 
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
 	function benchmark( b ) {
 		var d;
 		var i;
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
 			d = sswap( x, y );
-			if ( isnan( d[ i%x.length ] ) ) {
+			if ( isnan( d.data[ i%len ] ) ) {
 				b.fail( 'should not return NaN' );
 			}
 		}
 		b.toc();
-		if ( isnan( d ) ) {
+		if ( isnan( d.data[ i%len ] ) ) {
 			b.fail( 'should not return NaN' );
 		}
 		b.pass( 'benchmark finished' );

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

@@ -0,0 +1,122 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var numel = require( '@stdlib/ndarray/base/numel' );
+var array = require( '@stdlib/ndarray/array' );
+var pkg = require( './../package.json' ).name;
+var sswap = require( './../lib/main.js' );
+
+
+// VARIABLES //
+
+var OPTS = {
+	'dtype': 'float32'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveIntegerArray} shape - array shape
+* @returns {Function} benchmark function
+*/
+function createBenchmark( shape ) {
+	var x;
+	var y;
+	var N;
+	var o;
+
+	N = numel( shape );
+	o = {
+		'shape': shape
+	};
+	x = array( uniform( N, -100.0, 100.0, OPTS ), o );
+	y = array( uniform( N, -100.0, 100.0, OPTS ), o );
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var d;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			d = sswap( x, y );
+			if ( isnan( d.data[ i%N ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( d.data[ i%N ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var shape;
+	var min;
+	var max;
+	var N;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		N = pow( 10, i );
+
+		shape = [ 2, N/2 ];
+		f = createBenchmark( shape );
+		bench( pkg+'::stacks:size='+N+',ndims='+shape.length+',shape=('+shape.join( ',' )+')', f );
+
+		shape = [ N/2, 2 ];
+		f = createBenchmark( shape );
+		bench( pkg+'::stacks:size='+N+',ndims='+shape.length+',shape=('+shape.join( ',' )+')', f );
+	}
+}
+
+main();