Merge branch 'stdlib-js:develop' into ccopy-wasm

Author: aman-095

lib/node_modules/@stdlib/_tools/scripts/publish_packages.js

@@ -1061,6 +1061,10 @@ function publish( pkg, clbk ) {
 	}
 	fs.copyFileSync( join( __dirname, 'templates', 'workflow_cancel.yml.txt' ), join( dist, '.github', 'workflows', 'cancel.yml' ) );
 
+	workflow = readFileSync( join( __dirname, 'templates', 'workflow_test_published_package.yml.txt' ), 'utf8' );
+	workflow = replace( workflow, '{{cron}}', schedule );
+	writeFileSync( join( dist, '.github', 'workflows', 'test_published_package.yml' ), workflow );
+
 	// Write the current date to the `.keepalive` file...
 	if ( flags[ 'keep-alive' ] ) {
 		fs.writeFileSync( join( dist, '.github', '.keepalive' ), new Date().toISOString() + '\n' );

lib/node_modules/@stdlib/_tools/scripts/templates/workflow_test_published_package.yml.txt

@@ -0,0 +1,105 @@
+#/
+# @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.
+#/
+
+# Workflow name:
+name: test_published_package
+
+# Workflow triggers:
+on:
+  # Run workflow on a weekly schedule:
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '{{cron}}'
+
+  # Run workflow upon completion of `publish` workflow run:
+  workflow_run:
+    workflows: ["publish"]
+    types: [completed]
+
+  # Allow workflow to be manually run:
+  workflow_dispatch:
+
+# Workflow jobs:
+jobs:
+  test-published:
+    # Define a display name:
+    name: 'Test running examples of published package'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define environment variables:
+    env:
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+
+    # Define the job's steps:
+    steps:
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
+
+      # Install Node.js:
+      - name: 'Install Node.js'
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
+        with:
+          node-version: 20
+        timeout-minutes: 5
+
+      # Create test directory and run examples:
+      - name: 'Create test directory and run examples'
+        run: |
+          cd ..
+          mkdir test-published
+          cd test-published
+
+          # Copy example file:
+          cp $GITHUB_WORKSPACE/examples/index.js .
+
+          # Create a minimal package.json
+          echo '{
+            "name": "test-published",
+            "version": "1.0.0",
+            "main": "index.js",
+            "dependencies": {}
+          }' > package.json
+
+          # Get package name and modify example file:
+          PACKAGE_NAME=$(jq -r '.name' $GITHUB_WORKSPACE/package.json)
+          ESCAPED_PACKAGE_NAME=$(echo "$PACKAGE_NAME" | sed 's/[\/&]/\\&/g')
+
+          sed -i "s/require( '.\/..\/lib' )/require( '$ESCAPED_PACKAGE_NAME' )/g" index.js
+
+          # Extract and install dependencies:
+          DEPS=$(grep -oP "require\(\s*'([^']+)'\s*\)" index.js | sed "s/require(\s*'//" | sed "s/'\s*)//" | grep -v "^\.")
+          for dep in $DEPS; do
+            npm install $dep --save
+          done
+
+          # Run the example:
+          node index.js
+
+      # Send Slack notification if job fails:
+      - name: 'Send notification to Slack in case of failure'
+        uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
+        with:
+          status: ${{ job.status }}
+          channel: '#npm-ci'
+        if: failure()

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

@@ -181,7 +181,7 @@ Computes the L2-norm of a complex single-precision floating-point vector.
 const float cx[] = { 0.3f, 0.1f, 0.5f, 0.0f, 0.0f, 0.5f, 0.0f, 0.2f };
 
 float norm = c_scnrm2( 4, (void *)cx, 1 );
-// returns 0.8
+// returns 0.8f
 ```
 
 The function accepts the following arguments:
@@ -194,6 +194,27 @@ The function accepts the following arguments:
 float c_scnrm2( const CBLAS_INT N, const void *CX, const CBLAS_INT strideX );
 ```
 
+#### c_scnrm2_ndarray( N, \*CX, strideX, offsetX )
+
+Computes the L2-norm of a complex single-precision floating-point vector using alternative indexing semantics.
+
+```c
+const float cx[] = { 0.3f, 0.1f, 0.5f, 0.0f, 0.0f, 0.5f, 0.0f, 0.2f };
+
+float norm = c_scnrm2_ndarray( 4, (void *)cx, 1, 0 );
+// returns 0.8f
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **CX**: `[in] void*` input array.
+-   **strideX**: `[in] CBLAS_INT` index increment for `CX`.
+
+```c
+float c_scnrm2_ndarray( const CBLAS_INT N, const void *CX, const CBLAS_INT strideX, const CBLAS_INT offsetX );
+```
+
 </section>
 
 <!-- /.usage -->
@@ -227,7 +248,13 @@ int main( void ) {
     const int strideX = 1;
 
     // Compute the L2-norm:
-    c_scnrm2( N, (void *)cx, strideX );
+    float norm = c_scnrm2( N, (void *)cx, strideX );
+
+    // Print the result:
+    printf( "L2-norm: %f\n", norm );
+
+    // Compute the L2-norm using alternative indexing semantics:
+    norm = c_scnrm2_ndarray( N, (void *)cx, -strideX, N-1 );
 
     // Print the result:
     printf( "L2-norm: %f\n", norm );

lib/node_modules/@stdlib/blas/base/scnrm2/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 ) {
 	float cx[ len*2 ];
 	double elapsed;
 	float norm;
@@ -121,6 +121,40 @@ 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 ) {
+	float cx[ len*2 ];
+	double elapsed;
+	float norm;
+	double t;
+	int i;
+
+	for ( i = 0; i < len*2; i += 2 ) {
+		cx[ i ] = ( rand_float()*10000.0f ) - 5000.0f;
+		cx[ i+1 ] = ( rand_float()*10000.0f ) - 5000.0f;
+	}
+	norm = 0.0f;
+	t = tic();
+	for ( i = 0; i < iterations; i++ ) {
+		norm = c_scnrm2_ndarray( len, (void *)cx, 1, 0 );
+		if ( norm != norm ) {
+			printf( "should not return NaN\n" );
+			break;
+		}
+	}
+	elapsed = tic() - t;
+	if ( norm != norm ) {
+		printf( "should not return NaN\n" );
+	}
+	return elapsed;
+}
+
 /**
 * Main execution sequence.
 */
@@ -143,7 +177,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 );
 		}

lib/node_modules/@stdlib/blas/base/scnrm2/examples/c/example.c

@@ -34,4 +34,10 @@ int main( void ) {
 
 	// Print the result:
 	printf( "L2-norm: %f\n", norm );
+
+	// Compute the L2-norm using alternative indexing semantics:
+	norm = c_scnrm2_ndarray( N, (void *)cx, -strideX, N-1 );
+
+	// Print the result:
+	printf( "L2-norm: %f\n", norm );
 }

lib/node_modules/@stdlib/blas/base/scnrm2/include/stdlib/blas/base/scnrm2.h

@@ -36,6 +36,11 @@ extern "C" {
 */
 float API_SUFFIX(c_scnrm2)( const CBLAS_INT N, const void *CX, const CBLAS_INT strideX );
 
+/**
+* Computes the L2-norm of a complex single-precision floating-point vector using alternative indexing semantics.
+*/
+float API_SUFFIX(c_scnrm2_ndarray)( const CBLAS_INT N, const void *CX, const CBLAS_INT strideX, const CBLAS_INT offsetX );
+
 #ifdef __cplusplus
 }
 #endif

lib/node_modules/@stdlib/blas/base/scnrm2/lib/ndarray.native.js

@@ -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' );
 
 
@@ -46,10 +45,8 @@ var addon = require( './../src/addon.node' );
 * // returns ~0.8
 */
 function scnrm2( N, cx, strideX, offsetX ) {
-	var viewCX;
-	offsetX = minViewBufferIndex( N, strideX, offsetX );
-	viewCX = reinterpret( cx, offsetX );
-	return addon( N, viewCX, strideX );
+	var viewCX = reinterpret( cx, 0 );
+	return addon.ndarray( N, viewCX, strideX, offsetX );
 }