From f7570c063e4d897c3dfc1dcae5b9fe41aac9f4cb Mon Sep 17 00:00:00 2001 From: saurabhraghuvanshii Date: Wed, 26 Feb 2025 00:25:30 +0530 Subject: [PATCH 01/11] refactor: update to follow current project convetions --- .../@stdlib/blas/base/gscal/README.md | 18 +++---- .../@stdlib/blas/base/gscal/docs/repl.txt | 48 +++++++++---------- .../blas/base/gscal/docs/types/index.d.ts | 22 ++++----- .../@stdlib/blas/base/gscal/lib/index.js | 2 +- .../@stdlib/blas/base/gscal/lib/main.js | 8 ++-- .../@stdlib/blas/base/gscal/lib/ndarray.js | 18 +++---- .../@stdlib/blas/base/gscal/package.json | 2 +- 7 files changed, 58 insertions(+), 60 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/README.md b/lib/node_modules/@stdlib/blas/base/gscal/README.md index b77e4f06c024..3147468bdff9 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/README.md +++ b/lib/node_modules/@stdlib/blas/base/gscal/README.md @@ -20,7 +20,7 @@ limitations under the License. # gscal -> Multiply a vector `x` by a constant `alpha`. +> Multiply a vector `x` by a scalar constant `alpha`.
@@ -30,9 +30,9 @@ limitations under the License. var gscal = require( '@stdlib/blas/base/gscal' ); ``` -#### gscal( N, alpha, x, stride ) +#### gscal( N, alpha, x, strideX ) -Multiplies a vector `x` by a constant `alpha`. +Multiplies a vector `x` by a scalar constant `alpha`. ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; @@ -46,9 +46,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar constant. - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. -- **stride**: index increment. +- **strideX**: stride length. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to multiply every other value by a constant +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to multiply every other value by a scalar constant ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; @@ -75,9 +75,9 @@ gscal( 3, 5.0, x1, 2 ); If either `N` or `stride` is less than or equal to `0`, the function returns `x` unchanged. -#### gscal.ndarray( N, alpha, x, stride, offset ) +#### gscal.ndarray( N, alpha, x, strideX, offsetX ) -Multiplies a vector `x` by a constant `alpha` using alternative indexing semantics. +Multiplies a vector `x` by a scalar constant `alpha` using alternative indexing semantics. ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; @@ -88,9 +88,9 @@ gscal.ndarray( x.length, 5.0, x, 1, 0 ); The function has the following additional parameters: -- **offset**: starting index. +- **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 multiply the last three elements of `x` by a constant +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 multiply the last three elements: ```javascript var x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ]; diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt index e37f88b6525e..f48cd96f1c27 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt @@ -1,14 +1,14 @@ -{{alias}}( N, alpha, x, stride ) - Multiplies a vector `x` by a constant `alpha`. +{{alias}}( N, alpha, x, strideX ) + Multiplies a vector `x` by a scalar constant `alpha`. - The `N` and `stride` parameters determine which elements in `x` are accessed - at runtime. + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use typed array views. - If `N <= 0` or `stride <= 0`, the function returns `x` unchanged. + If `N <= 0` or `strideX <= 0`, the function returns `x` unchanged. Parameters ---------- @@ -16,13 +16,13 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Array|TypedArray Input array. - stride: integer - Index increment for `x`. + strideX: integer + Stride length. Returns ------- @@ -32,13 +32,12 @@ Examples -------- // Standard Usage: - > var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ]; - > var alpha = 5.0; - > {{alias}}( x.length, alpha, x, 1 ) - [ -10.0, 5.0, 15.0, -25.0, 20.0, -5.0, -15.0 ] + > var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; + > {{alias}}( x.length, 5.0, x, 1 ) + [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] - // Using `N` and `stride` parameters: - > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ]; + // Using `N` and stride parameters: + > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 -1.0, -3.0 ]; > {{alias}}( 3, 5.0, x, 2 ) [ -10.0, 1.0, 15.0, -5.0, 20.0, -1.0, -3.0 ] @@ -51,11 +50,11 @@ [ 1.0, -10.0, 3.0, -20.0, 5.0, -30.0 ] -{{alias}}.ndarray( N, alpha, x, stride, offset ) - Multiplies `x` by a constant `alpha` using alternative indexing semantics. +{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) + Multiplies `x` by a scalar constant `alpha` using alternative indexing semantics. While typed array views mandate a view offset based on the underlying - buffer, the `offset` parameter supports indexing semantics based on a + buffer, the offset parameter supports indexing semantics based on a starting index. Parameters @@ -64,16 +63,16 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Array|TypedArray Input array. - stride: integer - Index increment for `x`. + strideX: integer + Stride length. - offset: integer - Starting index of `x`. + offsetX: integer + Starting index. Returns ------- @@ -83,9 +82,9 @@ Examples -------- // Standard Usage: - > var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ]; + > var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; > {{alias}}.ndarray( x.length, 5.0, x, 1, 0 ) - [ -10.0, 5.0, 15.0, -25.0, 20.0, -5.0, -15.0 ] + [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] // Using an index offset: > x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ]; @@ -94,4 +93,3 @@ See Also -------- - diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts index 8453ebed2020..570e63777400 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts @@ -32,12 +32,12 @@ type InputArray = NumericArray | Collection | AccessorArrayLike; */ interface Routine { /** - * Multiplies a vector `x` by a constant `alpha`. + * Multiplies a vector `x` by a scalar constant `alpha`. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns input array * * @example @@ -46,16 +46,16 @@ interface Routine { * gscal( x.length, 5.0, x, 1 ); * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] */ - ( N: number, alpha: number, x: T, stride: number ): T; + ( N: number, alpha: number, x: T, strideX: number ): T; /** - * Multiplies a vector `x` by a constant `alpha` using alternative indexing semantics. + * Multiplies a vector `x` by a scalar constant `alpha` using alternative indexing semantics. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns input array * * @example @@ -64,16 +64,16 @@ interface Routine { * gscal.ndarray( x.length, 5.0, x, 1, 0 ); * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] */ - ndarray( N: number, alpha: number, x: T, stride: number, offset: number ): T; + ndarray( N: number, alpha: number, x: T, strideX: number, offsetX: number ): T; } /** * Multiplies a vector `x` by a constant `alpha`. * * @param N - number of indexed elements -* @param alpha - constant +* @param alpha - scalar constant * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns input array * * @example diff --git a/lib/node_modules/@stdlib/blas/base/gscal/lib/index.js b/lib/node_modules/@stdlib/blas/base/gscal/lib/index.js index 4a1e5150d56f..ef5a709aa45b 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/gscal/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* BLAS level 1 routine to multiply `x` by a constant. +* BLAS level 1 routine to multiply `x` by a scalar constant. * * @module @stdlib/blas/base/gscal * diff --git a/lib/node_modules/@stdlib/blas/base/gscal/lib/main.js b/lib/node_modules/@stdlib/blas/base/gscal/lib/main.js index 7b71f23c01b7..f8319c157b1e 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/gscal/lib/main.js @@ -30,9 +30,9 @@ var ndarray = require( './ndarray.js' ); * Multiplies `x` by a scalar `alpha`. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {NumericArray} x - input array -* @param {PositiveInteger} stride - index increment +* @param {PositiveInteger} strideX - stride length * @returns {NumericArray} input array * * @example @@ -41,8 +41,8 @@ var ndarray = require( './ndarray.js' ); * gscal( x.length, 5.0, x, 1 ); * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] */ -function gscal( N, alpha, x, stride ) { - return ndarray( N, alpha, x, stride, stride2offset( N, stride ) ); +function gscal( N, alpha, x, strideX ) { + return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js index 4a1085fb8b05..2e43f07956fc 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js @@ -37,8 +37,8 @@ var M = 5; * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar * @param {NumericArray} x - input array -* @param {integer} stride - index increment -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {NumericArray} input array * * @example @@ -47,7 +47,7 @@ var M = 5; * gscal( 3, 5.0, x, 1, x.length-3 ); * // x => [ 1.0, -2.0, 3.0, -20.0, 25.0, -30.0 ] */ -function gscal( N, alpha, x, stride, offset ) { +function gscal( N, alpha, x, strideX, offsetX ) { var ix; var m; var o; @@ -58,25 +58,25 @@ function gscal( N, alpha, x, stride, offset ) { } o = arraylike2object( x ); if ( o.accessorProtocol ) { - accessors( N, alpha, o, stride, offset ); + accessors( N, alpha, o, strideX, offsetX ); return x; } - ix = offset; - if ( stride === 0 ) { + ix = offsetX; + if ( strideX === 0 ) { x[ ix ] *= alpha * N; return x; } // Use loop unrolling if the stride is equal to `1`... - if ( stride === 1 ) { + if ( strideX === 1 ) { m = N % M; // If we have a remainder, run a clean-up loop... if ( m > 0 ) { for ( i = 0; i < m; i++ ) { x[ ix ] *= alpha; - ix += stride; + ix += strideX; } } if ( N < M ) { @@ -94,7 +94,7 @@ function gscal( N, alpha, x, stride, offset ) { } for ( i = 0; i < N; i++ ) { x[ ix ] *= alpha; - ix += stride; + ix += strideX; } return x; } diff --git a/lib/node_modules/@stdlib/blas/base/gscal/package.json b/lib/node_modules/@stdlib/blas/base/gscal/package.json index a7c21ab67f3a..5b01eda618fe 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/package.json +++ b/lib/node_modules/@stdlib/blas/base/gscal/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/base/gscal", "version": "0.0.0", - "description": "Multiply a vector by a constant.", + "description": "Multiply a vector by a scalar constant.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", From bc213a0b78c0eecbebaca6a8f2a491336df080fc Mon Sep 17 00:00:00 2001 From: saurabhraghuvanshii Date: Wed, 26 Feb 2025 12:25:01 +0530 Subject: [PATCH 02/11] chore: address changes --- 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 status: passed - 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: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/base/gscal/README.md | 16 ++++++++-------- .../@stdlib/blas/base/gscal/docs/repl.txt | 18 +++++++++--------- .../blas/base/gscal/docs/types/index.d.ts | 16 ++++++++-------- .../@stdlib/blas/base/gscal/lib/index.js | 2 +- .../@stdlib/blas/base/gscal/lib/main.js | 8 ++++---- .../@stdlib/blas/base/gscal/lib/ndarray.js | 18 +++++++++--------- 6 files changed, 39 insertions(+), 39 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/README.md b/lib/node_modules/@stdlib/blas/base/gscal/README.md index 3147468bdff9..304fa78001f3 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/README.md +++ b/lib/node_modules/@stdlib/blas/base/gscal/README.md @@ -20,7 +20,7 @@ limitations under the License. # gscal -> Multiply a vector `x` by a scalar constant `alpha`. +> Multiply a vector by a scalar constant.
@@ -30,9 +30,9 @@ limitations under the License. var gscal = require( '@stdlib/blas/base/gscal' ); ``` -#### gscal( N, alpha, x, strideX ) +#### gscal( N, alpha, x, stride ) -Multiplies a vector `x` by a scalar constant `alpha`. +Multiply a vector by a scalar constant. ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; @@ -46,9 +46,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar constant. - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. -- **strideX**: stride length. +- **stride**: stride length. -The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to multiply every other value by a scalar constant +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to multiply every other value by a scalar constant: ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; @@ -75,9 +75,9 @@ gscal( 3, 5.0, x1, 2 ); If either `N` or `stride` is less than or equal to `0`, the function returns `x` unchanged. -#### gscal.ndarray( N, alpha, x, strideX, offsetX ) +#### gscal.ndarray( N, alpha, x, stride, offset ) -Multiplies a vector `x` by a scalar constant `alpha` using alternative indexing semantics. +Multiplies a vector by a scalar constant using alternative indexing semantics. ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; @@ -88,7 +88,7 @@ gscal.ndarray( x.length, 5.0, x, 1, 0 ); The function has the following additional parameters: -- **offsetX**: starting index. +- **offset**: 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 multiply the last three elements: diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt index f48cd96f1c27..8395c6e44171 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt @@ -1,6 +1,6 @@ -{{alias}}( N, alpha, x, strideX ) - Multiplies a vector `x` by a scalar constant `alpha`. +{{alias}}( N, alpha, x, stride ) + Multiplies a vector by a scalar constant The `N` and stride parameters determine which elements in the strided array are accessed at runtime. @@ -8,7 +8,7 @@ Indexing is relative to the first index. To introduce an offset, use typed array views. - If `N <= 0` or `strideX <= 0`, the function returns `x` unchanged. + If `N <= 0` or `stride <= 0`, the function returns `x` unchanged. Parameters ---------- @@ -21,7 +21,7 @@ x: Array|TypedArray Input array. - strideX: integer + stride: integer Stride length. Returns @@ -50,12 +50,12 @@ [ 1.0, -10.0, 3.0, -20.0, 5.0, -30.0 ] -{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) - Multiplies `x` by a scalar constant `alpha` using alternative indexing semantics. +{{alias}}.ndarray( N, alpha, x, stride, offsetX ) + Multiplies a vector by a scalar constant. While typed array views mandate a view offset based on the underlying - buffer, the offset parameter supports indexing semantics based on a - starting index. + buffer, the offset parameter supports indexing semantics based on a starting + index. Parameters ---------- @@ -68,7 +68,7 @@ x: Array|TypedArray Input array. - strideX: integer + stride: integer Stride length. offsetX: integer diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts index 570e63777400..2c82892cd775 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts @@ -32,12 +32,12 @@ type InputArray = NumericArray | Collection | AccessorArrayLike; */ interface Routine { /** - * Multiplies a vector `x` by a scalar constant `alpha`. + * Multiplies a vector by a scalar constant. * * @param N - number of indexed elements * @param alpha - scalar constant * @param x - input array - * @param strideX - stride length + * @param stride - stride length * @returns input array * * @example @@ -46,15 +46,15 @@ interface Routine { * gscal( x.length, 5.0, x, 1 ); * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] */ - ( N: number, alpha: number, x: T, strideX: number ): T; + ( N: number, alpha: number, x: T, stride: number ): T; /** - * Multiplies a vector `x` by a scalar constant `alpha` using alternative indexing semantics. + * Multiplies a vector by a scalar constant. * * @param N - number of indexed elements * @param alpha - scalar constant * @param x - input array - * @param strideX - stride length + * @param stride - stride length * @param offsetX - starting index * @returns input array * @@ -64,16 +64,16 @@ interface Routine { * gscal.ndarray( x.length, 5.0, x, 1, 0 ); * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] */ - ndarray( N: number, alpha: number, x: T, strideX: number, offsetX: number ): T; + ndarray( N: number, alpha: number, x: T, stride: number, offsetX: number ): T; } /** -* Multiplies a vector `x` by a constant `alpha`. +* Multiplies a vector by a scalar constant. * * @param N - number of indexed elements * @param alpha - scalar constant * @param x - input array -* @param strideX - stride length +* @param stride - stride length * @returns input array * * @example diff --git a/lib/node_modules/@stdlib/blas/base/gscal/lib/index.js b/lib/node_modules/@stdlib/blas/base/gscal/lib/index.js index ef5a709aa45b..19e2929bfcdc 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/gscal/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* BLAS level 1 routine to multiply `x` by a scalar constant. +* Multiply a vector by a scalar constant. * * @module @stdlib/blas/base/gscal * diff --git a/lib/node_modules/@stdlib/blas/base/gscal/lib/main.js b/lib/node_modules/@stdlib/blas/base/gscal/lib/main.js index f8319c157b1e..1285863e6fa1 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/lib/main.js +++ b/lib/node_modules/@stdlib/blas/base/gscal/lib/main.js @@ -27,12 +27,12 @@ var ndarray = require( './ndarray.js' ); // MAIN // /** -* Multiplies `x` by a scalar `alpha`. +* Multiplies a vector by a scalar constant. * * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar constant * @param {NumericArray} x - input array -* @param {PositiveInteger} strideX - stride length +* @param {PositiveInteger} stride - stride length * @returns {NumericArray} input array * * @example @@ -41,8 +41,8 @@ var ndarray = require( './ndarray.js' ); * gscal( x.length, 5.0, x, 1 ); * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] */ -function gscal( N, alpha, x, strideX ) { - return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); +function gscal( N, alpha, x, stride ) { + return ndarray( N, alpha, x, stride, stride2offset( N, stride ) ); } diff --git a/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js index 2e43f07956fc..4903d7035390 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js @@ -37,8 +37,8 @@ var M = 5; * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar * @param {NumericArray} x - input array -* @param {integer} strideX - stride length -* @param {NonNegativeInteger} offsetX - starting index +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - starting index * @returns {NumericArray} input array * * @example @@ -47,7 +47,7 @@ var M = 5; * gscal( 3, 5.0, x, 1, x.length-3 ); * // x => [ 1.0, -2.0, 3.0, -20.0, 25.0, -30.0 ] */ -function gscal( N, alpha, x, strideX, offsetX ) { +function gscal( N, alpha, x, stride, offset ) { var ix; var m; var o; @@ -58,25 +58,25 @@ function gscal( N, alpha, x, strideX, offsetX ) { } o = arraylike2object( x ); if ( o.accessorProtocol ) { - accessors( N, alpha, o, strideX, offsetX ); + accessors( N, alpha, o, stride, offset ); return x; } - ix = offsetX; - if ( strideX === 0 ) { + ix = offset; + if ( stride === 0 ) { x[ ix ] *= alpha * N; return x; } // Use loop unrolling if the stride is equal to `1`... - if ( strideX === 1 ) { + if ( stride === 1 ) { m = N % M; // If we have a remainder, run a clean-up loop... if ( m > 0 ) { for ( i = 0; i < m; i++ ) { x[ ix ] *= alpha; - ix += strideX; + ix += stride; } } if ( N < M ) { @@ -94,7 +94,7 @@ function gscal( N, alpha, x, strideX, offsetX ) { } for ( i = 0; i < N; i++ ) { x[ ix ] *= alpha; - ix += strideX; + ix += stride; } return x; } From e6fd57061959e71323fe5484fa2e5778f35cc079 Mon Sep 17 00:00:00 2001 From: saurabhraghuvanshii Date: Wed, 26 Feb 2025 21:23:06 +0530 Subject: [PATCH 03/11] chore: addresses comments --- 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 status: passed - 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: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/blas/base/gscal/README.md | 2 +- lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt | 2 +- lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/README.md b/lib/node_modules/@stdlib/blas/base/gscal/README.md index 304fa78001f3..06e39cb315dd 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/README.md +++ b/lib/node_modules/@stdlib/blas/base/gscal/README.md @@ -32,7 +32,7 @@ var gscal = require( '@stdlib/blas/base/gscal' ); #### gscal( N, alpha, x, stride ) -Multiply a vector by a scalar constant. +Multiplies a vector by a scalar constant. ```javascript var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt index 8395c6e44171..5de704fe21dd 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt @@ -1,6 +1,6 @@ {{alias}}( N, alpha, x, stride ) - Multiplies a vector by a scalar constant + Multiplies a vector by a scalar constant. The `N` and stride parameters determine which elements in the strided array are accessed at runtime. diff --git a/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js index 4903d7035390..9aa73f63e3d4 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js @@ -32,7 +32,7 @@ var M = 5; // MAIN // /** -* Multiplies `x` by a scalar `alpha`. +* Multiplies a vector by a scalar constant. * * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar From 36d1042a17d1518a4f6fc8f09929ffffc532ab7a Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Thu, 27 Feb 2025 08:18:36 +0500 Subject: [PATCH 04/11] docs: apply suggestions from code review Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts index 2c82892cd775..d578957e6f3a 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts @@ -55,7 +55,7 @@ interface Routine { * @param alpha - scalar constant * @param x - input array * @param stride - stride length - * @param offsetX - starting index + * @param offset - starting index * @returns input array * * @example From 6d0e3f3c78acff48769399305478075b123e59f1 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Thu, 27 Feb 2025 08:18:50 +0500 Subject: [PATCH 05/11] refactor: apply suggestions from code review Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts index d578957e6f3a..8f05c63aac05 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts @@ -64,7 +64,7 @@ interface Routine { * gscal.ndarray( x.length, 5.0, x, 1, 0 ); * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] */ - ndarray( N: number, alpha: number, x: T, stride: number, offsetX: number ): T; + ndarray( N: number, alpha: number, x: T, stride: number, offset: number ): T; } /** From 2b01a7cf6e820e8e3e4a844453e3cd46a7085e60 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Thu, 27 Feb 2025 08:23:11 +0500 Subject: [PATCH 06/11] docs: apply suggestions from code review Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt index 5de704fe21dd..5453bded293c 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt @@ -37,7 +37,7 @@ [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] // Using `N` and stride parameters: - > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 -1.0, -3.0 ]; + > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ]; > {{alias}}( 3, 5.0, x, 2 ) [ -10.0, 1.0, 15.0, -5.0, 20.0, -1.0, -3.0 ] From e5fe9a9c2b10bf90c036bb76458da7c9dc797fb7 Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 27 Feb 2025 01:49:31 -0800 Subject: [PATCH 07/11] docs: update description Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt index 5453bded293c..addcb91ff140 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt @@ -51,7 +51,7 @@ {{alias}}.ndarray( N, alpha, x, stride, offsetX ) - Multiplies a vector by a scalar constant. + Multiplies a vector by a scalar constant using alternative indexing semantics. While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting From cbb3cbc1e3285295b29ce063e82739161a602fc7 Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 27 Feb 2025 01:50:04 -0800 Subject: [PATCH 08/11] style: wrap text Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt index addcb91ff140..60ccfce44079 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt @@ -51,7 +51,8 @@ {{alias}}.ndarray( N, alpha, x, stride, offsetX ) - Multiplies a vector by a scalar constant using alternative indexing semantics. + Multiplies a vector by a scalar constant using alternative indexing + semantics. While typed array views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting From 44e5989a583ee02f23b725b1053c9ffa7afddabb Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 27 Feb 2025 01:51:29 -0800 Subject: [PATCH 09/11] docs: clean-up Signed-off-by: Athan --- .../@stdlib/blas/base/gscal/docs/repl.txt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt index 60ccfce44079..8e547eeb3fec 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/repl.txt @@ -1,5 +1,5 @@ -{{alias}}( N, alpha, x, stride ) +{{alias}}( N, alpha, x, strideX ) Multiplies a vector by a scalar constant. The `N` and stride parameters determine which elements in the strided array @@ -8,7 +8,7 @@ Indexing is relative to the first index. To introduce an offset, use typed array views. - If `N <= 0` or `stride <= 0`, the function returns `x` unchanged. + If `N <= 0`, the function returns `x` unchanged. Parameters ---------- @@ -21,7 +21,7 @@ x: Array|TypedArray Input array. - stride: integer + strideX: integer Stride length. Returns @@ -50,7 +50,7 @@ [ 1.0, -10.0, 3.0, -20.0, 5.0, -30.0 ] -{{alias}}.ndarray( N, alpha, x, stride, offsetX ) +{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) Multiplies a vector by a scalar constant using alternative indexing semantics. @@ -69,7 +69,7 @@ x: Array|TypedArray Input array. - stride: integer + strideX: integer Stride length. offsetX: integer @@ -94,3 +94,4 @@ See Also -------- + From c431e7111857d9262cb57da0f9aac6096d0c338e Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 27 Feb 2025 01:55:10 -0800 Subject: [PATCH 10/11] docs: update description Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts index 8f05c63aac05..922912203d4e 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/gscal/docs/types/index.d.ts @@ -49,7 +49,7 @@ interface Routine { ( N: number, alpha: number, x: T, stride: number ): T; /** - * Multiplies a vector by a scalar constant. + * Multiplies a vector by a scalar constant using alternative indexing semantics. * * @param N - number of indexed elements * @param alpha - scalar constant From a3f5496b9ce48bb9d3e5f25ae6923ba968e19615 Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 27 Feb 2025 01:56:10 -0800 Subject: [PATCH 11/11] docs: update description Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js index 9aa73f63e3d4..6cfe0a9ca5cd 100644 --- a/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/gscal/lib/ndarray.js @@ -32,7 +32,7 @@ var M = 5; // MAIN // /** -* Multiplies a vector by a scalar constant. +* Multiplies a vector by a scalar constant using alternative indexing semantics. * * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar