chore: apply suggestions from review

anandkaranubc · anandkaranubc · commit e2b82b55e7eb · 2026-05-28T22:53:09.000-07:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown_pkg_readmes
    status: passed
  - task: lint_markdown_docs
    status: na
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/README.md
@@ -36,25 +36,35 @@ limitations under the License.
 var saxpb = require( '@stdlib/blas/ext/base/ndarray/saxpb' );
 ```
 
-#### saxpb( alpha, beta, arrays )
+#### saxpb( arrays )
 
-Multiplies each element in a one-dimensional single-precision floating-point ndarray by a scalar constant `alpha` and adds a scalar constant `beta` to each result.
+Multiplies each element in a one-dimensional single-precision floating-point ndarray by a scalar constant and adds a scalar constant to each result.
 
 ```javascript
 var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 
 var x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
-// returns <ndarray>[ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]
 
-saxpb( 5.0, 3.0, [ x ] );
+var alpha = scalar2ndarray( 5.0, {
+    'dtype': 'float32'
+});
+
+var beta = scalar2ndarray( 3.0, {
+    'dtype': 'float32'
+});
+
+saxpb( [ x, alpha, beta ] );
 // x => <ndarray>[ -7.0, 8.0, 18.0, -22.0, 23.0, 3.0, -2.0, -12.0 ]
 ```
 
 The function has the following parameters:
 
--   **alpha**: first scalar constant.
--   **beta**: second scalar constant.
--   **arrays**: array-like object containing a one-dimensional input ndarray.
+-   **arrays**: array-like object containing the following ndarrays:
+
+    -   a one-dimensional input ndarray.
+    -   a zero-dimensional ndarray containing the scalar constant to multiply.
+    -   a zero-dimensional ndarray containing the scalar constant to add.
 
 </section>
 
@@ -78,16 +88,25 @@ The function has the following parameters:
 
 ```javascript
 var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
 var saxpb = require( '@stdlib/blas/ext/base/ndarray/saxpb' );
 
 var opts = {
     'dtype': 'float32'
 };
+
 var x = discreteUniform( [ 10 ], -100, 100, opts );
 console.log( ndarray2array( x ) );
 
-saxpb( 5.0, 3.0, [ x ] );
+var alpha = scalar2ndarray( 5.0, opts );
+console.log( 'Alpha: %d', ndarraylike2scalar( alpha ) );
+
+var beta = scalar2ndarray( 3.0, opts );
+console.log( 'Beta: %d', ndarraylike2scalar( beta ) );
+
+saxpb( [ x, alpha, beta ] );
 console.log( ndarray2array( x ) );
 ```
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/benchmark/benchmark.js
@@ -21,13 +21,21 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+var uniform = require( '@stdlib/random/uniform' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var format = require( '@stdlib/string/format' );
 var pkg = require( './../package.json' ).name;
 var saxpb = require( './../lib' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -38,7 +46,13 @@ var saxpb = require( './../lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = new Float32Vector( len );
+	var alpha;
+	var beta;
+	var x;
+
+	x = uniform( [ len ], -100.0, 100.0, options );
+	alpha = scalar2ndarray( 5.0, options );
+	beta = scalar2ndarray( 3.0, options );
 	return benchmark;
 
 	/**
@@ -53,7 +67,7 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			out = saxpb( 5.0, 3.0, [ x ] );
+			out = saxpb( [ x, alpha, beta ] );
 			if ( typeof out !== 'object' ) {
 				b.fail( 'should return an ndarray' );
 			}
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/docs/repl.txt
@@ -1,5 +1,5 @@
 
-{{alias}}( alpha, beta, arrays )
+{{alias}}( arrays )
     Multiplies each element in a one-dimensional single-precision floating-point
     ndarray by a scalar constant and adds a scalar constant to each result.
 
@@ -8,14 +8,12 @@
 
     Parameters
     ----------
-    alpha: number
-        First scalar constant.
-
-    beta: number
-        Second scalar constant.
-
     arrays: ArrayLikeObject<ndarray>
-        Array-like object containing a one-dimensional input ndarray.
+        Array-like object containing the following ndarrays:
+
+        - a one-dimensional input ndarray.
+        - a zero-dimensional ndarray containing the scalar constant to multiply.
+        - a zero-dimensional ndarray containing the scalar constant to add.
 
     Returns
     -------
@@ -26,7 +24,10 @@
     --------
     > var buf = [ -2.0, 1.0, 3.0, -5.0 ];
     > var x = new {{alias:@stdlib/ndarray/vector/float32}}( buf );
-    > {{alias}}( 5.0, 3.0, [ x ] )
+    > var opts = { 'dtype': 'float32' };
+    > var alpha = {{alias:@stdlib/ndarray/from-scalar}}( 5.0, opts );
+    > var beta = {{alias:@stdlib/ndarray/from-scalar}}( 3.0, opts );
+    > {{alias}}( [ x, alpha, beta ] )
     <ndarray>[ -7.0, 8.0, 18.0, -22.0 ]
 
     See Also
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/docs/types/index.d.ts
@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { float32ndarray } from '@stdlib/types/ndarray';
+import { float32ndarray, typedndarray } from '@stdlib/types/ndarray';
 
 /**
 * Multiplies each element in a one-dimensional single-precision floating-point ndarray by a scalar constant and adds a scalar constant to each result.
@@ -30,22 +30,30 @@ import { float32ndarray } from '@stdlib/types/ndarray';
 * -   The function expects the following ndarrays:
 *
 *     -   a one-dimensional input ndarray.
+*     -   a zero-dimensional ndarray containing the scalar constant to multiply.
+*     -   a zero-dimensional ndarray containing the scalar constant to add.
 *
-* @param alpha - first scalar constant
-* @param beta - second scalar constant
-* @param arrays - array-like object containing a one-dimensional input ndarray
+* @param arrays - array-like object containing ndarrays
 * @returns input ndarray
 *
 * @example
 * var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 *
 * var x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
-* // returns <ndarray>[ -2.0, 1.0, 3.0, -5.0 ]
 *
-* var out = saxpb( 5.0, 3.0, [ x ] );
+* var alpha = scalar2ndarray( 5.0, {
+*     'dtype': 'float32'
+* });
+*
+* var beta = scalar2ndarray( 3.0, {
+*     'dtype': 'float32'
+* });
+*
+* var out = saxpb( [ x, alpha, beta ] );
 * // returns <ndarray>[ -7.0, 8.0, 18.0, -22.0 ]
 */
-declare function saxpb( alpha: number, beta: number, arrays: [ float32ndarray ] ): float32ndarray;
+declare function saxpb( arrays: [ float32ndarray, typedndarray<number>, typedndarray<number> ] ): float32ndarray;
 
 
 // EXPORTS //
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/docs/types/test.ts
@@ -16,62 +16,55 @@
 * limitations under the License.
 */
 
-import Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+/* eslint-disable space-in-parens */
+
+import zeros = require( '@stdlib/ndarray/zeros' );
+import scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 import saxpb = require( './index' );
 
 
 // TESTS //
 
 // The function returns an ndarray...
 {
-	const x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
-	saxpb( 5.0, 3.0, [ x ] ); // $ExpectType float32ndarray
-}
+	const x = zeros( [ 10 ], {
+		'dtype': 'float32'
+	});
+	const alpha = scalar2ndarray( 5.0, {
+		'dtype': 'float32'
+	});
+	const beta = scalar2ndarray( 3.0, {
+		'dtype': 'float32'
+	});
 
-// The compiler throws an error if the function is provided a first argument which is not a number...
-{
-	const x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
-	saxpb( '5', 3.0, [ x ] ); // $ExpectError
-	saxpb( true, 3.0, [ x ] ); // $ExpectError
-	saxpb( false, 3.0, [ x ] ); // $ExpectError
-	saxpb( null, 3.0, [ x ] ); // $ExpectError
-	saxpb( undefined, 3.0, [ x ] ); // $ExpectError
-	saxpb( [], 3.0, [ x ] ); // $ExpectError
-	saxpb( {}, 3.0, [ x ] ); // $ExpectError
-	saxpb( ( x: number ): number => x, 3.0, [ x ] ); // $ExpectError
+	saxpb( [ x, alpha, beta ] ); // $ExpectType float32ndarray
 }
 
-// The compiler throws an error if the function is provided a second argument which is not a number...
+// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
 {
-	const x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
-	saxpb( 5.0, '3', [ x ] ); // $ExpectError
-	saxpb( 5.0, true, [ x ] ); // $ExpectError
-	saxpb( 5.0, false, [ x ] ); // $ExpectError
-	saxpb( 5.0, null, [ x ] ); // $ExpectError
-	saxpb( 5.0, undefined, [ x ] ); // $ExpectError
-	saxpb( 5.0, [], [ x ] ); // $ExpectError
-	saxpb( 5.0, {}, [ x ] ); // $ExpectError
-	saxpb( 5.0, ( x: number ): number => x, [ x ] ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not an array of ndarrays...
-{
-	saxpb( 5.0, 3.0, '10' ); // $ExpectError
-	saxpb( 5.0, 3.0, 5 ); // $ExpectError
-	saxpb( 5.0, 3.0, true ); // $ExpectError
-	saxpb( 5.0, 3.0, false ); // $ExpectError
-	saxpb( 5.0, 3.0, null ); // $ExpectError
-	saxpb( 5.0, 3.0, undefined ); // $ExpectError
-	saxpb( 5.0, 3.0, [] ); // $ExpectError
-	saxpb( 5.0, 3.0, {} ); // $ExpectError
-	saxpb( 5.0, 3.0, ( x: number ): number => x ); // $ExpectError
+	saxpb( '10' ); // $ExpectError
+	saxpb( 5 ); // $ExpectError
+	saxpb( true ); // $ExpectError
+	saxpb( false ); // $ExpectError
+	saxpb( null ); // $ExpectError
+	saxpb( undefined ); // $ExpectError
+	saxpb( [] ); // $ExpectError
+	saxpb( {} ); // $ExpectError
+	saxpb( ( x: number ): number => x ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
 {
-	const x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
+	const x = zeros( [ 10 ], {
+		'dtype': 'float32'
+	});
+	const alpha = scalar2ndarray( 5.0, {
+		'dtype': 'float32'
+	});
+	const beta = scalar2ndarray( 3.0, {
+		'dtype': 'float32'
+	});
+
 	saxpb(); // $ExpectError
-	saxpb( 5.0 ); // $ExpectError
-	saxpb( 5.0, 3.0 ); // $ExpectError
-	saxpb( 5.0, 3.0, [ x ], {} ); // $ExpectError
+	saxpb( [ x, alpha, beta ], {} ); // $ExpectError
 }
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/examples/index.js
@@ -19,14 +19,23 @@
 'use strict';
 
 var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
 var saxpb = require( './../lib' );
 
 var opts = {
 	'dtype': 'float32'
 };
+
 var x = discreteUniform( [ 10 ], -100, 100, opts );
 console.log( ndarray2array( x ) );
 
-saxpb( 5.0, 3.0, [ x ] );
+var alpha = scalar2ndarray( 5.0, opts );
+console.log( 'Alpha: %d', ndarraylike2scalar( alpha ) );
+
+var beta = scalar2ndarray( 3.0, opts );
+console.log( 'Beta: %d', ndarraylike2scalar( beta ) );
+
+saxpb( [ x, alpha, beta ] );
 console.log( ndarray2array( x ) );
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/lib/index.js
@@ -25,12 +25,20 @@
 *
 * @example
 * var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 * var saxpb = require( '@stdlib/blas/ext/base/ndarray/saxpb' );
 *
 * var x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
-* // returns <ndarray>[ -2.0, 1.0, 3.0, -5.0 ]
 *
-* var out = saxpb( 5.0, 3.0, [ x ] );
+* var alpha = scalar2ndarray( 5.0, {
+*     'dtype': 'float32'
+* });
+*
+* var beta = scalar2ndarray( 3.0, {
+*     'dtype': 'float32'
+* });
+*
+* var out = saxpb( [ x, alpha, beta ] );
 * // returns <ndarray>[ -7.0, 8.0, 18.0, -22.0 ]
 */
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/lib/main.js
@@ -25,6 +25,7 @@ var getStride = require( '@stdlib/ndarray/base/stride' );
 var getOffset = require( '@stdlib/ndarray/base/offset' );
 var getData = require( '@stdlib/ndarray/base/data-buffer' );
 var strided = require( '@stdlib/blas/ext/base/saxpb' ).ndarray;
+var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
 
 
 // MAIN //
@@ -37,23 +38,37 @@ var strided = require( '@stdlib/blas/ext/base/saxpb' ).ndarray;
 * -   The function expects the following ndarrays:
 *
 *     -   a one-dimensional input ndarray.
+*     -   a zero-dimensional ndarray containing the scalar constant to multiply.
+*     -   a zero-dimensional ndarray containing the scalar constant to add.
 *
-* @param {number} alpha - first scalar constant
-* @param {number} beta - second scalar constant
 * @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
 * @returns {ndarray} input ndarray
 *
 * @example
 * var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
 *
 * var x = new Float32Vector( [ -2.0, 1.0, 3.0, -5.0 ] );
-* // returns <ndarray>[ -2.0, 1.0, 3.0, -5.0 ]
 *
-* var out = saxpb( 5.0, 3.0, [ x ] );
+* var alpha = scalar2ndarray( 5.0, {
+*     'dtype': 'float32'
+* });
+*
+* var beta = scalar2ndarray( 3.0, {
+*     'dtype': 'float32'
+* });
+*
+* var out = saxpb( [ x, alpha, beta ] );
 * // returns <ndarray>[ -7.0, 8.0, 18.0, -22.0 ]
 */
-function saxpb( alpha, beta, arrays ) {
-	var x = arrays[ 0 ];
+function saxpb( arrays ) {
+	var alpha;
+	var beta;
+	var x;
+
+	x = arrays[ 0 ];
+	alpha = ndarraylike2scalar( arrays[ 1 ] );
+	beta = ndarraylike2scalar( arrays[ 2 ] );
 	strided( numelDimension( x, 0 ), alpha, beta, getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len
 	return x;
 }
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/saxpb/test/test.js
