Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -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:  '39 3 * * 5'
+
+  # 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()

.github/workflows/test_published_package.yml

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-11-01)
+## Unreleased (2024-11-23)
 
 <section class="features">
 
@@ -32,6 +32,7 @@
 
 <details>
 
+-   [`9c913e5`](https://github.com/stdlib-js/stdlib/commit/9c913e504f964aa729ec1f19abbaae30174ddbd8) - **docs:** update descriptions of the function and its parameters in `blas/ext/base/dapx` [(#3226)](https://github.com/stdlib-js/stdlib/pull/3226) _(by Muhammad Haris)_
 -   [`a187bfc`](https://github.com/stdlib-js/stdlib/commit/a187bfc1f71912625823d786f7b1234b224b323d) - **feat:** add C `ndarray` API and refactor `blas/ext/base/dapx` [(#2929)](https://github.com/stdlib-js/stdlib/pull/2929) _(by Muhammad Haris, Athan Reines)_
 -   [`e4de24f`](https://github.com/stdlib-js/stdlib/commit/e4de24f1e086063876214e73f1f6b659dc624eb1) - **fix:** resolve bugs in addon.c files _(by Philipp Burckhardt)_
 -   [`272ae7a`](https://github.com/stdlib-js/stdlib/commit/272ae7ac5c576c68cfab1b6e304c86407faa20cd) - **docs:** remove comment _(by Athan Reines)_

CHANGELOG.md

@@ -59,6 +59,7 @@ Mohammad Kaif <98884589+Kaif987@users.noreply.github.com>
 Momtchil Momtchev <momtchil@momtchev.com>
 Muhammad Haris <harriskhan047@outlook.com>
 Naresh Jagadeesan <naresh.naresh000@gmail.com>
+Neeraj Pathak <neerajrpathak710@gmail.com>
 NightKnight <Ahmedatwa866@yahoo.com>
 Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
 Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com>
@@ -69,6 +70,7 @@ Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <goswami.4@iitj.ac.in>
 Praneki <97080887+PraneGIT@users.noreply.github.com>
 Pratik <97464067+Pratik772846@users.noreply.github.com>
+Pratyush Kumar Chouhan <pratyushkumar0308@gmail.com>
 Priyansh <88396544+itsspriyansh@users.noreply.github.com>
 Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
 RISHAV <115060907+rishav2404@users.noreply.github.com>
@@ -79,9 +81,11 @@ Ridam Garg <67867319+RidamGarg@users.noreply.github.com>
 Robert Gislason <gztown2216@yahoo.com>
 Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
 Rutam <138517416+performant23@users.noreply.github.com>
+Ruthwik Chikoti <145591715+ruthwikchikoti@users.noreply.github.com>
 Ryan Seal <splrk@users.noreply.github.com>
 Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com>
 SarthakPaandey <145528240+SarthakPaandey@users.noreply.github.com>
+Saurabh Singh <saurabhsraghuvanshi@gmail.com>
 Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
 Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
 Shivam <11shivam00@gmail.com>

CONTRIBUTORS

@@ -33,7 +33,7 @@ limitations under the License.
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
-> Add a constant to each element in a double-precision floating-point strided array.
+> Add a scalar constant to each element in a double-precision floating-point strided array.
 
 <section class="installation">
 
@@ -65,7 +65,7 @@ var dapx = require( '@stdlib/blas-ext-base-dapx' );
 
 #### dapx( N, alpha, x, strideX )
 
-Adds a scalar constant `alpha` to each element in a double-precision floating-point strided array.
+Adds a scalar constant to each element in a double-precision floating-point strided array.
 
 ```javascript
 var Float64Array = require( '@stdlib/array-float64' );
@@ -81,9 +81,9 @@ The function has the following parameters:
 -   **N**: number of indexed elements.
 -   **alpha**: scalar constant.
 -   **x**: input [`Float64Array`][@stdlib/array/float64].
--   **strideX**: index increment.
+-   **strideX**: stride length for `x`.
 
-The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element
+The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element:
 
 ```javascript
 var Float64Array = require( '@stdlib/array-float64' );
@@ -112,7 +112,7 @@ dapx( 3, 5.0, x1, 2 );
 
 #### dapx.ndarray( N, alpha, x, strideX, offsetX )
 
-Adds a scalar constant `alpha` to each element in a double-precision floating-point strided array using alternative indexing semantics.
+Adds a scalar constant to each element in a double-precision floating-point strided array using alternative indexing semantics.
 
 ```javascript
 var Float64Array = require( '@stdlib/array-float64' );
@@ -127,7 +127,7 @@ The function has the following additional parameters:
 
 -   **offsetX**: 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 the strided array
+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:
 
 ```javascript
 var Float64Array = require( '@stdlib/array-float64' );
@@ -203,7 +203,7 @@ console.log( x );
 
 #### c_dapx( N, alpha, \*X, strideX )
 
-Adds a scalar constant `alpha` to each element in a double-precision floating-point strided array.
+Adds a scalar constant to each element in a double-precision floating-point strided array.
 
 ```c
 double x[] = { 1.0, 2.0, 3.0, 4.0 };
@@ -217,15 +217,15 @@ The function accepts the following arguments:
 -   **N**: `[in] CBLAS_INT` number of indexed elements.
 -   **alpha**: `[in] double` scalar constant.
 -   **X**: `[inout] double*` input array.
--   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
 
 ```c
 void c_dapx( const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX );
 ```
 
 #### c_dapx_ndarray( N, alpha, \*X, strideX, offsetX )
 
-Adds a scalar constant `alpha` to each element in a double-precision floating-point strided array `X` using alternative indexing semantics.
+Adds a scalar constant to each element in a double-precision floating-point strided array using alternative indexing semantics.
 
 ```c
 double x[] = { 1.0, 2.0, 3.0, 4.0 };
@@ -238,7 +238,7 @@ The function accepts the following arguments:
 -   **N**: `[in] CBLAS_INT` number of indexed elements.
 -   **alpha**: `[in] double` scalar constant.
 -   **X**: `[inout] double*` input array.
--   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
 -   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
 
 ```c
@@ -293,7 +293,7 @@ int main( void ) {
 
 </section>
 
-<!-- /.c -->
+W<!-- /.c -->
 
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 

README.md

@@ -105,6 +105,7 @@ static double benchmark1( int iterations, int len ) {
 	}
 	t = tic();
 	for ( i = 0; i < iterations; i++ ) {
+		// cppcheck-suppress uninitvar
 		c_dapx( len, 5.0, x, 1 );
 		if ( x[ 0 ] != x[ 0 ] ) {
 			printf( "should not return NaN\n" );
@@ -129,6 +130,7 @@ static double benchmark2( int iterations, int len ) {
 	}
 	t = tic();
 	for ( i = 0; i < iterations; i++ ) {
+		// cppcheck-suppress uninitvar
 		c_dapx_ndarray( len, 5.0, x, 1, 0 );
 		if ( x[ 0 ] != x[ 0 ] ) {
 			printf( "should not return NaN\n" );