diff --git a/lib/node_modules/@stdlib/blas/base/gscal/README.md b/lib/node_modules/@stdlib/blas/base/gscal/README.md index b77e4f06c024..06e39cb315dd 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 by a scalar constant.
@@ -32,7 +32,7 @@ var gscal = require( '@stdlib/blas/base/gscal' ); #### gscal( N, alpha, x, stride ) -Multiplies a vector `x` by a constant `alpha`. +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 ]; @@ -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. +- **stride**: 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 ]; @@ -77,7 +77,7 @@ If either `N` or `stride` is less than or equal to `0`, the function returns `x` #### gscal.ndarray( N, alpha, x, stride, offset ) -Multiplies a vector `x` by a 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 ]; @@ -90,7 +90,7 @@ The function has the following additional parameters: - **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 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..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,14 +1,14 @@ -{{alias}}( N, alpha, x, stride ) - Multiplies a vector `x` by a constant `alpha`. +{{alias}}( N, alpha, x, strideX ) + Multiplies a vector by a scalar constant. - 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`, 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,12 +32,11 @@ 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: + // Using `N` and stride parameters: > 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 ] @@ -51,12 +50,13 @@ [ 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 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 index. + buffer, the offset parameter supports indexing semantics based on a starting + index. Parameters ---------- @@ -64,16 +64,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 +83,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 ]; 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..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 @@ -32,10 +32,10 @@ type InputArray = NumericArray | Collection | AccessorArrayLike; */ interface Routine { /** - * Multiplies a vector `x` by a constant `alpha`. + * Multiplies a vector by a scalar constant. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array * @param stride - stride length * @returns input array @@ -49,10 +49,10 @@ interface Routine { ( N: number, alpha: number, x: T, stride: number ): T; /** - * Multiplies a vector `x` by a constant `alpha` using alternative indexing semantics. + * Multiplies a vector by a scalar constant 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 @@ -68,10 +68,10 @@ interface Routine { } /** -* Multiplies a vector `x` by a constant `alpha`. +* Multiplies a vector by a scalar constant. * * @param N - number of indexed elements -* @param alpha - constant +* @param alpha - scalar constant * @param x - input array * @param stride - stride length * @returns input array 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..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 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 7b71f23c01b7..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 +* @param {number} alpha - scalar constant * @param {NumericArray} x - input array -* @param {PositiveInteger} stride - index increment +* @param {PositiveInteger} stride - stride length * @returns {NumericArray} input array * * @example 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..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,12 +32,12 @@ var M = 5; // MAIN // /** -* Multiplies `x` by a scalar `alpha`. +* Multiplies a vector by a scalar constant using alternative indexing semantics. * * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar * @param {NumericArray} x - input array -* @param {integer} stride - index increment +* @param {integer} stride - stride length * @param {NonNegativeInteger} offset - starting index * @returns {NumericArray} input array * 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",