Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -6,12 +6,23 @@
 
 ## Unreleased (2024-11-17)
 
+<section class="features">
+
+### Features
+
+-   [`953e73d`](https://github.com/stdlib-js/stdlib/commit/953e73d1fd1c06babf0ed16dcc94430152abf5a8) - update JavaScript implementation and add C `ndarray` implementation for `blas/base/cswap` [(#3064)](https://github.com/stdlib-js/stdlib/pull/3064)
+
+</section>
+
+<!-- /.features -->
+
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`953e73d`](https://github.com/stdlib-js/stdlib/commit/953e73d1fd1c06babf0ed16dcc94430152abf5a8) - **feat:** update JavaScript implementation and add C `ndarray` implementation for `blas/base/cswap` [(#3064)](https://github.com/stdlib-js/stdlib/pull/3064) _(by Aman Bhansali, Athan Reines)_
 -   [`38656e4`](https://github.com/stdlib-js/stdlib/commit/38656e4893257726e3c3276ff3cead5f2f02c5c5) - **docs:** fix example _(by Athan Reines)_
 -   [`adbee81`](https://github.com/stdlib-js/stdlib/commit/adbee8105b6903730d070261f36127b5744cabbb) - **docs:** fix description _(by Athan Reines)_
 -   [`ed44fee`](https://github.com/stdlib-js/stdlib/commit/ed44feecb9eaa5e0849d1a533e5415624d0aa338) - **style:** use imperative in package.json description and end with period _(by Philipp Burckhardt)_
@@ -27,8 +38,9 @@
 
 ### Contributors
 
-A total of 2 people contributed to this release. Thank you to the following contributors:
+A total of 3 people contributed to this release. Thank you to the following contributors:
 
+-   Aman Bhansali
 -   Athan Reines
 -   Philipp Burckhardt
 

README.md

@@ -339,6 +339,31 @@ The function accepts the following arguments:
 void c_cswap( const CBLAS_INT N, void *X, const CBLAS_INT strideX, void *Y, const CBLAS_INT strideY );
 ```
 
+#### c_cswap_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY )
+
+Interchanges two complex single-precision floating-point vectors using alternative indexing semantics.
+
+```c
+float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; // interleaved real and imaginary components
+float y[] = { 5.0f, 6.0f, 7.0f, 8.0f };
+
+c_cswap_ndarray( 2, (void *)x, 1, 0, (void *)y, 1, 0 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **X**: `[inout] void*` first input array.
+-   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+-   **Y**: `[inout] void*` second input array.
+-   **strideY**: `[in] CBLAS_INT` index increment for `Y`.
+-   **offsetY**: `[in] CBLAS_INT` starting index for `Y`.
+
+```c
+void c_cswap_ndarray( const CBLAS_INT N, void *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, void *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
+```
+
 </section>
 
 <!-- /.usage -->

benchmark/c/benchmark.length.c

@@ -94,7 +94,7 @@ static float rand_float( void ) {
 * @param len          array length
 * @return elapsed time in seconds
 */
-static double benchmark( int iterations, int len ) {
+static double benchmark1( int iterations, int len ) {
 	double elapsed;
 	float x[ len*2 ];
 	float y[ len*2 ];
@@ -122,6 +122,41 @@ static double benchmark( int iterations, int len ) {
 	return elapsed;
 }
 
+/**
+* Runs a benchmark.
+*
+* @param iterations   number of iterations
+* @param len          array length
+* @return elapsed time in seconds
+*/
+static double benchmark2( int iterations, int len ) {
+	double elapsed;
+	float x[ len*2 ];
+	float y[ len*2 ];
+	double t;
+	int i;
+
+	for ( i = 0; i < len; i++ ) {
+		x[ i ] = ( rand_float()*10000.0f ) - 5000.0f;
+		x[ i+1 ] = ( rand_float()*10000.0f ) - 5000.0f;
+		y[ i ] = 0.0f;
+		y[ i+1 ] = 0.0f;
+	}
+	t = tic();
+	for ( i = 0; i < iterations; i++ ) {
+		c_cswap_ndarray( len, (void *)x, 1, 0, (void *)y, 1, 0 );
+		if ( y[ 0 ] != y[ 0 ] ) {
+			printf( "should not return NaN\n" );
+			break;
+		}
+	}
+	elapsed = tic() - t;
+	if ( y[ 0 ] != y[ 0 ] ) {
+		printf( "should not return NaN\n" );
+	}
+	return elapsed;
+}
+
 /**
 * Main execution sequence.
 */
@@ -144,7 +179,14 @@ int main( void ) {
 		for ( j = 0; j < REPEATS; j++ ) {
 			count += 1;
 			printf( "# c::%s:len=%d\n", NAME, len );
-			elapsed = benchmark( iter, len );
+			elapsed = benchmark1( iter, len );
+			print_results( iter, elapsed );
+			printf( "ok %d benchmark finished\n", count );
+		}
+		for ( j = 0; j < REPEATS; j++ ) {
+			count += 1;
+			printf( "# c::%s:ndarray:len=%d\n", NAME, len );
+			elapsed = benchmark2( iter, len );
 			print_results( iter, elapsed );
 			printf( "ok %d benchmark finished\n", count );
 		}

dist/index.js

@@ -31,12 +31,21 @@ int main( void ) {
 	const int strideX = 1;
 	const int strideY = -1;
 
-	// Copy elements:
+	// Swap elements:
 	c_cswap( N, (void *)x, strideX, (void *)y, strideY );
 
 	// Print the result:
 	for ( int i = 0; i < N; i++ ) {
 		printf( "x[ %i ] = %f + %fj\n", i, x[ i*2 ], x[ (i*2)+1 ] );
 		printf( "y[ %i ] = %f + %fj\n", i, y[ i*2 ], y[ (i*2)+1 ] );
 	}
+
+	// Swap elements using alternative indexing semantics:
+	c_cswap_ndarray( N, (void *)x, -strideX, N-1, (void *)y, strideY, N-1 );
+
+	// Print the result:
+	for ( int i = 0; i < N; i++ ) {
+		printf( "x[ %i ] = %f + %fj\n", i, x[ i*2 ], x[ (i*2)+1 ] );
+		printf( "y[ %i ] = %f + %fj\n", i, y[ i*2 ], y[ (i*2)+1 ] );
+	}
 }

dist/index.js.map

@@ -36,6 +36,11 @@ extern "C" {
 */
 void API_SUFFIX(c_cswap)( const CBLAS_INT N, void *X, const CBLAS_INT strideX, void *Y, const CBLAS_INT strideY );
 
+/**
+* Interchanges two complex single-precision floating-point vectors.
+*/
+void API_SUFFIX(c_cswap_ndarray)( const CBLAS_INT N, void *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, void *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY );
+
 #ifdef __cplusplus
 }
 #endif

examples/c/example.c

@@ -20,7 +20,8 @@
 
 // MODULES //
 
-var reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
+var stride2offset = require( '@stdlib/strided-base-stride2offset' );
+var ndarray = require( './ndarray.js' );
 
 
 // MAIN //
@@ -64,59 +65,9 @@ var reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
 * // returns 8.0
 */
 function cswap( N, x, strideX, y, strideY ) {
-	var viewX;
-	var viewY;
-	var tmp;
-	var sx;
-	var sy;
-	var ix;
-	var iy;
-	var i;
-	var j;
-
-	if ( N <= 0 ) {
-		return y;
-	}
-	viewX = reinterpret( x, 0 );
-	viewY = reinterpret( y, 0 );
-	if ( strideX === 1 && strideY === 1 ) {
-		for ( i = 0; i < N*2; i += 2 ) {
-			tmp = viewX[ i ];
-			viewX[ i ] = viewY[ i ];
-			viewY[ i ] = tmp;
-
-			j = i + 1;
-			tmp = viewX[ j ];
-			viewX[ j ] = viewY[ j ];
-			viewY[ j ] = tmp;
-		}
-		return y;
-	}
-	if ( strideX < 0 ) {
-		ix = 2 * (1-N) * strideX;
-	} else {
-		ix = 0;
-	}
-	if ( strideY < 0 ) {
-		iy = 2 * (1-N) * strideY;
-	} else {
-		iy = 0;
-	}
-	sx = strideX * 2;
-	sy = strideY * 2;
-	for ( i = 0; i < N; i++ ) {
-		tmp = viewX[ ix ];
-		viewX[ ix ] = viewY[ iy ];
-		viewY[ iy ] = tmp;
-
-		tmp = viewX[ ix+1 ];
-		viewX[ ix+1 ] = viewY[ iy+1 ];
-		viewY[ iy+1 ] = tmp;
-
-		ix += sx;
-		iy += sy;
-	}
-	return y;
+	var ox = stride2offset( N, strideX );
+	var oy = stride2offset( N, strideY );
+	return ndarray( N, x, strideX, ox, y, strideY, oy );
 }
 
 

include/stdlib/blas/base/cswap.h

@@ -21,7 +21,6 @@
 // MODULES //
 
 var reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
-var minViewBufferIndex = require( '@stdlib/strided-base-min-view-buffer-index' );
 var addon = require( './../src/addon.node' );
 
 
@@ -68,16 +67,9 @@ var addon = require( './../src/addon.node' );
 * // returns 8.0
 */
 function cswap( N, x, strideX, offsetX, y, strideY, offsetY ) {
-	var viewX;
-	var viewY;
-
-	offsetX = minViewBufferIndex( N, strideX, offsetX );
-	offsetY = minViewBufferIndex( N, strideY, offsetY );
-
-	viewX = reinterpret( x, offsetX );
-	viewY = reinterpret( y, offsetY );
-
-	addon( N, viewX, strideX, viewY, strideY );
+	var viewX = reinterpret( x, 0 );
+	var viewY = reinterpret( y, 0 );
+	addon.ndarray( N, viewX, strideX, offsetX, viewY, strideY, offsetY );
 	return y;
 }