diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/README.md b/lib/node_modules/@stdlib/blas/base/zdscal/README.md new file mode 100644 index 000000000000..4bcd8970c392 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/README.md @@ -0,0 +1,233 @@ + + +# zdscal + +> Scale a double-precision complex floating-point vector by a double-precision floating-point constant. + +
+ +## Usage + +```javascript +var zdscal = require( '@stdlib/blas/base/zdscal' ); +``` + +#### zdscal( N, da, zx, strideZX ) + +Scales a double-precision complex floating-point vector by a double-precision floating-point constant. + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/float64/real' ); +var imag = require( '@stdlib/complex/float64/imag' ); + +var zx = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); + +zdscal( 3, 2.0, zx, 1 ); + +var z = zx.get( 0 ); +// returns + +var re = real( z ); +// returns 2.0 + +var im = imag( z ); +// returns 2.0 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **da**: scalar constant. +- **zx**: input [`Complex128Array`][@stdlib/array/complex128]. +- **strideZX**: stride length for `zx`. + +The `N` and stride parameters determine which elements in `zx` are scaled by `da`. For example, to scale every other element in `zx` by `da`, + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/float64/real' ); +var imag = require( '@stdlib/complex/float64/imag' ); + +var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + +zdscal( 2, 2.0, zx, 2 ); + +var z = zx.get( 2 ); +// returns + +var re = real( z ); +// returns 10.0 + +var im = imag( z ); +// returns 12.0 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + + + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/float64/real' ); +var imag = require( '@stdlib/complex/float64/imag' ); + +// Initial array: +var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + +// Create an offset view: +var zx1 = new Complex128Array( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +// Scale every element in `zx1`: +zdscal( 3, 2.0, zx1, 1 ); + +var z = zx0.get( 0 ); +// returns + +var re = real( z ); +// returns 1.0 + +var im = imag( z ); +// returns 2.0 + +z = zx0.get( 1 ); +// returns + +re = real( z ); +// returns 6.0 + +im = imag( z ); +// returns 8.0 +``` + +#### zdscal.ndarray( N, da, zx, strideZX, offsetZX ) + +Scales a double-precision complex floating-point vector by a double-precision floating-point constant using alternative indexing semantics. + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/float64/real' ); +var imag = require( '@stdlib/complex/float64/imag' ); + +var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + +zdscal.ndarray( 3, 2.0, zx, 1, 0 ); + +var z = zx.get( 0 ); +// returns + +var re = real( z ); +// returns 2.0 + +var im = imag( z ); +// returns 4.0 +``` + +The function has the following additional parameters: + +- **offsetZX**: starting index for `zx`. + +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 scale every other element in the input strided array starting from the second element, + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/float64/real' ); +var imag = require( '@stdlib/complex/float64/imag' ); + +var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + +zdscal.ndarray( 2, 2.0, zx, 2, 1 ); + +var z = zx.get( 3 ); +// returns + +var re = real( z ); +// returns 14.0 + +var im = imag( z ); +// returns 16.0 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `zx` unchanged. +- `zdscal()` corresponds to the [BLAS][blas] level 1 function [`zdscal`][zdscal]. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var zdscal = require( '@stdlib/blas/base/zdscal' ); + +function rand() { + return new Complex128( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); +} + +var zx = filledarrayBy( 10, 'complex128', rand ); +console.log( zx.toString() ); + +zdscal( zx.length, 2.0, zx, 1 ); +console.log( zx.toString() ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[blas]: http://www.netlib.org/blas + +[zdscal]: https://www.netlib.org/lapack/explore-html/d2/de8/group__scal_ga40d50a435a5fcf16cf41fa80d746819f.html#ga40d50a435a5fcf16cf41fa80d746819f + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + +[@stdlib/array/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex128 + +
+ + diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/zdscal/benchmark/benchmark.js new file mode 100644 index 000000000000..44194d6be6b4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/benchmark/benchmark.js @@ -0,0 +1,107 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var pkg = require( './../package.json' ).name; +var zdscal = require( './../lib/zdscal.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var zxbuf; + var zx; + + zxbuf = uniform( len*2, -100.0, 100.0, options ); + zx = new Complex128Array( zxbuf.buffer ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + zdscal( zx.length, 2.0, zx, 1 ); + if ( isnan( zxbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( zxbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/zdscal/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..ebefeb815a35 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/benchmark/benchmark.ndarray.js @@ -0,0 +1,107 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var pkg = require( './../package.json' ).name; +var zdscal = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var zxbuf; + var zx; + + zxbuf = uniform( len*2, -100.0, 100.0, options ); + zx = new Complex128Array( zxbuf.buffer ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + zdscal( zx.length, 2.0, zx, 1, 0 ); + if ( isnan( zxbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( zxbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':ndarray:len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/zdscal/docs/repl.txt new file mode 100644 index 000000000000..daf02cf15b11 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/docs/repl.txt @@ -0,0 +1,116 @@ + +{{alias}}( N, da, zx, strideZX ) + Scales a double-precision complex floating-point vector by a double- + precision floating-point constant. + + The `N` and stride parameters determine which elements in `zx` are scaled by + `da`. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `N` is less than or equal to `0`, the function returns `zx` unchanged. + + + Parameters + ---------- + N: integer + Number of indexed elements. + + da: double + Scalar constant. + + zx: Complex128Array + Input array. + + strideZX: integer + Stride length for `zx`. + + Returns + ------- + zx: Complex128Array + Input array. + + Examples + -------- + // Standard usage: + > var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > {{alias}}( 2, 2.0, zx, 1 ); + > var z = zx.get( 0 ); + > var re = {{alias:@stdlib/complex/float64/real}}( z ) + 2.0 + > var im = {{alias:@stdlib/complex/float64/imag}}( z ) + 4.0 + + // N and stride parameters: + > zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > {{alias}}( 2, 2.0, zx, 2 ); + > z = zx.get( 2 ); + > re = {{alias:@stdlib/complex/float64/real}}( z ) + 10.0 + > im = {{alias:@stdlib/complex/float64/imag}}( z ) + 12.0 + + // Using typed array views: + > var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > var zx1 = new {{alias:@stdlib/array/complex128}}( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); + > {{alias}}( 2, 2.0, zx1, 1 ); + > z = zx0.get( 1 ); + > re = {{alias:@stdlib/complex/float64/real}}( z ) + 6.0 + > im = {{alias:@stdlib/complex/float64/imag}}( z ) + 8.0 + + +{{alias}}.ndarray( N, da, zx, strideZX, offsetZX ) + Scales a double-precision complex floating-point vector by a double- + precision floating-point 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. + + Parameters + ---------- + N: integer + Number of indexed elements. + + da: number + Scalar constant. + + zx: Complex128Array + Input array. + + strideZX: integer + Stride length for `zx`. + + offsetZX: integer + Starting index for `zx`. + + Returns + ------- + zx: Complex128Array + Input array. + + Examples + -------- + // Standard usage: + > var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > {{alias}}.ndarray( 2, 2.0, zx, 1, 0 ); + > var z = zx.get( 0 ); + > var re = {{alias:@stdlib/complex/float64/real}}( z ) + 2.0 + > var im = {{alias:@stdlib/complex/float64/imag}}( z ) + 4.0 + + // Advanced indexing: + > zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + > {{alias}}.ndarray( 2, 2.0, zx, 1, 2 ); + > z = zx.get( 2 ); + > re = {{alias:@stdlib/complex/float64/real}}( z ) + 10.0 + > im = {{alias:@stdlib/complex/float64/imag}}( z ) + 12.0 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/zdscal/docs/types/index.d.ts new file mode 100644 index 000000000000..e669d140c00f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/docs/types/index.d.ts @@ -0,0 +1,139 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { Complex128Array } from '@stdlib/types/array'; + +/** +* Interface describing `zdscal`. +*/ +interface Routine { + /** + * Scales a double-precision complex floating-point vector by a double-precision floating-point constant. + * + * @param N - number of indexed elements + * @param za - scalar constant + * @param zx - input array + * @param strideZX - `zx` stride length + * @returns input array + * + * @example + * var Complex128Array = require( '@stdlib/array/complex128' ); + * var real = require( '@stdlib/complex/float64/real' ); + * var imag = require( '@stdlib/complex/float64/imag' ); + * + * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * + * zdscal( 3, 2.0, zx, 1 ); + * + * var z = zx.get( 0 ); + * // returns + * + * var re = real( z ); + * // returns 2.0 + * + * var im = imag( z ); + * // returns 4.0 + */ + ( N: number, da: number, zx: Complex128Array, strideZX: number ): Complex128Array; + + /** + * Scales a double-precision complex floating-point vector by a double-precision floating-point constant. + * + * @param N - number of indexed elements + * @param da - scalar constant + * @param zx - input array + * @param strideZX - `zx` stride length + * @param offsetZX - starting index for `zx` + * @returns input array + * + * @example + * var Complex128Array = require( '@stdlib/array/complex128' ); + * var real = require( '@stdlib/complex/float64/real' ); + * var imag = require( '@stdlib/complex/float64/imag' ); + * + * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * + * zdscal.ndarray( 3, 2.0, zx, 1, 0 ); + * + * var z = zx.get( 0 ); + * // returns + * + * var re = real( z ); + * // returns 2.0 + * + * var im = imag( z ); + * // returns 4.0 + */ + ndarray( N: number, da: number, zx: Complex128Array, strideZX: number, offsetZX: number ): Complex128Array; +} + +/** +* Scales a double-precision complex floating-point vector by a double-precision floating-point constant. +* +* @param N - number of indexed elements +* @param da - scalar constant +* @param zx - input array +* @param strideZX - `zx` stride length +* @returns input array +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/float64/real' ); +* var imag = require( '@stdlib/complex/float64/imag' ); +* +* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* zdscal( 3, 2.0, zx, 1 ); +* +* var z = zx.get( 1 ); +* // returns +* +* var re = real( z ); +* // returns 6.0 +* +* var im = imag( z ); +* // returns 8.0 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/float64/real' ); +* var imag = require( '@stdlib/complex/float64/imag' ); +* +* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* zdscal.ndarray( 2, 2.0, zx, 1, 1 ); +* +* var z = zx.get( 1 ); +* // returns +* +* var re = real( z ); +* // returns 10.0 +* +* var im = imag( z ); +* // returns 12.0 +*/ +declare var zdscal: Routine; + + +// EXPORTS // + +export = zdscal; diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/zdscal/docs/types/test.ts new file mode 100644 index 000000000000..d857869e57da --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/docs/types/test.ts @@ -0,0 +1,191 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +import Complex128Array = require( '@stdlib/array/complex128' ); +import Complex128 = require( '@stdlib/complex/float64/ctor' ); +import zdscal = require( './index' ); + + +// TESTS // + +// The function returns a Complex128Array... +{ + const zx = new Complex128Array( 10 ); + + zdscal( zx.length, 2.0, zx, 1 ); // $ExpectType Complex128Array +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const zx = new Complex128Array( 10 ); + + zdscal( '10', 2.0, zx, 1 ); // $EzxpectError + zdscal( true, 2.0, zx, 1 ); // $ExpectError + zdscal( false, 2.0, zx, 1 ); // $ExpectError + zdscal( null, 2.0, zx, 1 ); // $ExpectError + zdscal( undefined, 2.0, zx, 1 ); // $ExpectError + zdscal( [], 2.0, zx, 1 ); // $ExpectError + zdscal( {}, 2.0, zx, 1 ); // $ExpectError + zdscal( ( zx: number ): number => zx, 2.0, zx, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + const zx = new Complex128Array( 10 ); + + zdscal( zx.length, new Complex128( 1.0, 2.0 ), zx, 1 ); // $ExpectError + zdscal( zx.length, '10', zx, 1 ); // $ExpectError + zdscal( zx.length, true, zx, 1 ); // $ExpectError + zdscal( zx.length, false, zx, 1 ); // $ExpectError + zdscal( zx.length, null, zx, 1 ); // $ExpectError + zdscal( zx.length, undefined, zx, 1 ); // $ExpectError + zdscal( zx.length, [ '1' ], zx, 1 ); // $ExpectError + zdscal( zx.length, {}, zx, 1 ); // $ExpectError + zdscal( zx.length, ( zx: number ): number => zx, zx, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a Complex128Array... +{ + const zx = new Complex128Array( 10 ); + + zdscal( zx.length, 2.0, 10, 1 ); // $ExpectError + zdscal( zx.length, 2.0, '10', 1 ); // $ExpectError + zdscal( zx.length, 2.0, true, 1 ); // $ExpectError + zdscal( zx.length, 2.0, false, 1 ); // $ExpectError + zdscal( zx.length, 2.0, null, 1 ); // $ExpectError + zdscal( zx.length, 2.0, undefined, 1 ); // $ExpectError + zdscal( zx.length, 2.0, [ '1' ], 1 ); // $ExpectError + zdscal( zx.length, 2.0, {}, 1 ); // $ExpectError + zdscal( zx.length, 2.0, ( zx: number ): number => zx, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a number... +{ + const zx = new Complex128Array( 10 ); + + zdscal( zx.length, 2.0, zx, '10' ); // $ExpectError + zdscal( zx.length, 2.0, zx, true ); // $ExpectError + zdscal( zx.length, 2.0, zx, false ); // $ExpectError + zdscal( zx.length, 2.0, zx, null ); // $ExpectError + zdscal( zx.length, 2.0, zx, undefined ); // $ExpectError + zdscal( zx.length, 2.0, zx, [] ); // $ExpectError + zdscal( zx.length, 2.0, zx, {} ); // $ExpectError + zdscal( zx.length, 2.0, zx, ( zx: number ): number => zx ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const zx = new Complex128Array( 10 ); + + zdscal(); // $ExpectError + zdscal( zx.length ); // $ExpectError + zdscal( zx.length, 2.0 ); // $ExpectError + zdscal( zx.length, 2.0, zx ); // $ExpectError + zdscal( zx.length, 2.0, zx, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Complex128Array... +{ + const zx = new Complex128Array( 10 ); + + zdscal.ndarray( zx.length, 2.0, zx, 1, 0 ); // $ExpectType Complex128Array +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const zx = new Complex128Array( 10 ); + + zdscal.ndarray( '10', 2.0, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( true, 2.0, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( false, 2.0, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( null, 2.0, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( undefined, 2.0, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( [], 2.0, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( {}, 2.0, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( ( zx: number ): number => zx, 2.0, zx, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number... +{ + const zx = new Complex128Array( 10 ); + + zdscal.ndarray( zx.length, new Complex128( 1.0, 2.0 ), zx, 1, 0 ); // $ExpectError + zdscal.ndarray( zx.length, '10', zx, 1, 0 ); // $ExpectError + zdscal.ndarray( zx.length, true, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( zx.length, false, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( zx.length, null, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( zx.length, undefined, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( zx.length, [ '1' ], zx, 1, 0 ); // $ExpectError + zdscal.ndarray( zx.length, {}, zx, 1, 0 ); // $ExpectError + zdscal.ndarray( zx.length, ( zx: number ): number => zx, zx, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a Complex128Array... +{ + const zx = new Complex128Array( 10 ); + + zdscal( zx.length, 2.0, 10, 1, 0 ); // $ExpectError + zdscal( zx.length, 2.0, '10', 1, 0 ); // $ExpectError + zdscal( zx.length, 2.0, true, 1, 0 ); // $ExpectError + zdscal( zx.length, 2.0, false, 1, 0 ); // $ExpectError + zdscal( zx.length, 2.0, null, 1, 0 ); // $ExpectError + zdscal( zx.length, 2.0, undefined, 1, 0 ); // $ExpectError + zdscal( zx.length, 2.0, [ '1' ], 1, 0 ); // $ExpectError + zdscal( zx.length, 2.0, {}, 1, 0 ); // $ExpectError + zdscal( zx.length, 2.0, ( zx: number ): number => zx, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const zx = new Complex128Array( 10 ); + + zdscal.ndarray( zx.length, 2.0, zx, '10', 0 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, true, 0 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, false, 0 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, null, 0 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, undefined, 0 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, [], 0 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, {}, 0 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, ( zx: number ): number => zx, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number... +{ + const zx = new Complex128Array( 10 ); + + zdscal.ndarray( zx.length, 2.0, zx, 1, '10' ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1, true ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1, false ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1, null ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1, undefined ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1, [] ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1, {} ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1, ( zx: number ): number => zx ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const zx = new Complex128Array( 10 ); + + zdscal.ndarray(); // $ExpectError + zdscal.ndarray( zx.length ); // $ExpectError + zdscal.ndarray( zx.length, 2.0 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1 ); // $ExpectError + zdscal.ndarray( zx.length, 2.0, zx, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/examples/index.js b/lib/node_modules/@stdlib/blas/base/zdscal/examples/index.js new file mode 100644 index 000000000000..86e6529bb69e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/examples/index.js @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var zdscal = require( './../lib' ); + +function rand() { + return new Complex128( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); +} + +var zx = filledarrayBy( 10, 'complex128', rand ); +console.log( zx.toString() ); + +zdscal( zx.length, 2.0, zx, 1 ); +console.log( zx.toString() ); diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/lib/index.js b/lib/node_modules/@stdlib/blas/base/zdscal/lib/index.js new file mode 100644 index 000000000000..bed34c7d314b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/lib/index.js @@ -0,0 +1,88 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +/** +* BLAS level 1 routine to scale a double-precision complex floating-point vector by a double-precision floating-point constant. +* +* @module @stdlib/blas/base/zdscal +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/float64/real' ); +* var imag = require( '@stdlib/complex/float64/imag' ); +* var zdscal = require( '@stdlib/blas/base/zdscal' ); +* +* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* zdscal( 3, 2.0, zx, 1 ); +* +* var z = zx.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns -2.0 +* +* var im = imag( z ); +* // returns 6.0 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/float64/real' ); +* var imag = require( '@stdlib/complex/float64/imag' ); +* var zdscal = require( '@stdlib/blas/base/zdscal' ); +* +* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* zdscal.ndarray( 3, 2.0, zx, 1, 0 ); +* +* var z = zx.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns -2.0 +* +* var im = imag( z ); +* // returns 6.0 +*/ + +// MODULES // + +var join = require( 'path' ).join; +var tryRequire = require( '@stdlib/utils/try-require' ); +var isError = require( '@stdlib/assert/is-error' ); +var main = require( './main.js' ); + + +// MAIN // + +var zdscal; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + zdscal = main; +} else { + zdscal = tmp; +} + + +// EXPORTS // + +module.exports = zdscal; + +// exports: { "ndarray": "zdscal.ndarray" } diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/lib/main.js b/lib/node_modules/@stdlib/blas/base/zdscal/lib/main.js new file mode 100644 index 000000000000..2d88da0211e0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/lib/main.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var zdscal = require( './zdscal.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( zdscal, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = zdscal; diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/zdscal/lib/ndarray.js new file mode 100644 index 000000000000..37182fe629d5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/lib/ndarray.js @@ -0,0 +1,84 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +// MODULES // + +var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' ); + + +// MAIN // + +/** +* Scales a double-precision complex floating-point vector by a double-precision floating-point constant. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {number} da - constant +* @param {Complex128Array} zx - input array +* @param {integer} strideZX - `zx` stride length +* @param {NonNegativeInteger} offsetZX - starting `zx` index +* @returns {Complex128Array} input array +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var Complex128 = require( '@stdlib/complex/float64/ctor' ); +* var real = require( '@stdlib/complex/float64/real' ); +* var imag = require( '@stdlib/complex/float64/imag' ); +* +* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* zdscal( 3, 2.0, zx, 1, 0 ); +* +* var z = zx.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 2.0 +* +* var im = imag( z ); +* // returns 4.0 +*/ +function zdscal( N, da, zx, strideZX, offsetZX ) { + var zx64; + var ix; + var sx; + var i; + + if ( N <= 0 || da === 1.0 ) { + return zx; + } + // Reinterpret the input array as a real-valued array of interleaved real and imaginary components: + zx64 = reinterpret( zx, 0 ); + + // Adjust the stride and offset accordingly: + ix = offsetZX * 2; + sx = strideZX * 2; + + for ( i = 0; i < N; i++ ) { + zx64[ ix ] *= da; + zx64[ ix+1 ] *= da; + ix += sx; + } + return zx; +} + + +// EXPORTS // + +module.exports = zdscal; diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/lib/zdscal.js b/lib/node_modules/@stdlib/blas/base/zdscal/lib/zdscal.js new file mode 100644 index 000000000000..c68df863272d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/lib/zdscal.js @@ -0,0 +1,63 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +// MODULES // + +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +/** +* Scales a double-precision complex floating-point vector by a double-precision floating-point constant. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {number} da - constant +* @param {Complex128Array} zx - input array +* @param {integer} strideZX - `zx` stride length +* @returns {Complex128Array} input array +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/float64/real' ); +* var imag = require( '@stdlib/complex/float64/imag' ); +* +* var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* +* zdscal( 3, 2.0, zx, 1 ); +* +* var z = zx.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 2.0 +* +* var im = imag( z ); +* // returns 4.0 +*/ +function zdscal( N, da, zx, strideZX ) { + return ndarray( N, da, zx, strideZX, stride2offset( N, strideZX ) ); +} + + +// EXPORTS // + +module.exports = zdscal; diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/package.json b/lib/node_modules/@stdlib/blas/base/zdscal/package.json new file mode 100644 index 000000000000..2107fd81e8c7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/package.json @@ -0,0 +1,77 @@ +{ + "name": "@stdlib/blas/base/zdscal", + "version": "0.0.0", + "description": "Scale a double-precision complex floating-point vector by a double-precision floating-point constant.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "browser": "./lib/main.js", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "level 1", + "linear", + "algebra", + "subroutines", + "zdscal", + "scale", + "vector", + "typed", + "array", + "ndarray", + "complex", + "complex128", + "double", + "float64", + "float64array" + ], + "__stdlib__": { + "wasm": false + } +} diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/test/test.js b/lib/node_modules/@stdlib/blas/base/zdscal/test/test.js new file mode 100644 index 000000000000..67ccee99c8a3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/test/test.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var proxyquire = require( 'proxyquire' ); +var isBrowser = require( '@stdlib/assert/is-browser' ); +var zdscal = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': isBrowser +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof zdscal, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'attached to the main export is a method providing an ndarray interface', function test( t ) { + t.strictEqual( typeof zdscal.ndarray, 'function', 'method is a function' ); + t.end(); +}); + +tape( 'if a native implementation is available, the main export is the native implementation', opts, function test( t ) { + var zdscal = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( zdscal, mock, 'returns native implementation' ); + t.end(); + + function tryRequire() { + return mock; + } + + function mock() { + // Mock... + } +}); + +tape( 'if a native implementation is not available, the main export is a JavaScript implementation', opts, function test( t ) { + var zdscal; + var main; + + main = require( './../lib/zdscal.js' ); + + zdscal = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( zdscal, main, 'returns JavaScript implementation' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/zdscal/test/test.ndarray.js new file mode 100644 index 000000000000..c8e16e0b6450 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/test/test.ndarray.js @@ -0,0 +1,267 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isSameComplex128Array = require( '@stdlib/assert/is-same-complex128array' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var zdscal = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof zdscal, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', function test( t ) { + t.strictEqual( zdscal.length, 5, 'arity of 5' ); + t.end(); +}); + +tape( 'the function scales elements from `zx` by `da`', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array([ + 0.3, // 1 + 0.1, // 1 + 0.5, // 2 + 0.0, // 2 + 0.0, // 3 + 0.5, // 3 + 0.0, // 4 + 0.2, // 4 + 2.0, + 3.0, + 2.0, + 3.0 + ]); + + zdscal( 4, 2.0, zx, 1, 0 ); + + expected = new Complex128Array([ + 0.6, // 1 + 0.2, // 1 + 1.0, // 2 + 0.0, // 2 + 0.0, // 3 + 1.0, // 3 + 0.0, // 4 + 0.4, // 4 + 2.0, + 3.0, + 2.0, + 3.0 + ]); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `zx` stride', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array([ + 0.1, // 1 + 0.1, // 1 + 3.0, + 6.0, + -0.6, // 2 + 0.1, // 2 + 4.0, + 7.0, + 0.1, // 3 + -0.3, // 3 + 7.0, + 2.0 + ]); + + zdscal( 3, 2.0, zx, 2, 0 ); + + expected = new Complex128Array([ + 0.2, // 1 + 0.2, // 1 + 3.0, + 6.0, + -1.2, // 2 + 0.2, // 2 + 4.0, + 7.0, + 0.2, // 3 + -0.6, // 3 + 7.0, + 2.0 + ]); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `zx` stride', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array([ + 0.1, // 3 + 0.1, // 3 + 3.0, + 6.0, + -0.6, // 2 + 0.1, // 2 + 4.0, + 7.0, + 0.1, // 1 + -0.3, // 1 + 7.0, + 2.0 + ]); + + zdscal( 3, 2.0, zx, -2, 4 ); + + expected = new Complex128Array([ + 0.2, // 3 + 0.2, // 3 + 3.0, + 6.0, + -1.2, // 2 + 0.2, // 2 + 4.0, + 7.0, + 0.2, // 1 + -0.6, // 1 + 7.0, + 2.0 + ]); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `zx` offset', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array([ + 0.1, + 0.1, + 3.0, + 6.0, + -0.6, + 0.1, + 4.0, // 1 + 6.0, // 1 + 0.1, // 2 + -0.3, // 2 + 7.0, // 3 + 2.0 // 3 + ]); + + zdscal( 3, 2.0, zx, 1, 3 ); + + expected = new Complex128Array([ + 0.1, + 0.1, + 3.0, + 6.0, + -0.6, + 0.1, + 8.0, // 1 + 12.0, // 1 + 0.2, // 2 + -0.6, // 2 + 14.0, // 3 + 4.0 // 3 + ]); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input array', function test( t ) { + var out; + var zx; + + zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + out = zdscal( 4, 2.0, zx, 1, 0 ); + + t.strictEqual( out, zx, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the input array unchanged', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + + expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len + + zdscal( -1, 2.0, zx, 1, 0 ); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + + zdscal( 0, 2.0, zx, 1, 0 ); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array([ + 0.1, + 0.1, + 3.0, + 6.0, + -0.6, + 0.1, + 4.0, // 2 + 6.0, // 2 + 0.1, + -0.3, + 7.0, + 2.0, + 2.0, // 1 + 3.0 // 1 + ]); + + zdscal( 2, 2.0, zx, -3, 6 ); + + expected = new Complex128Array([ + 0.1, + 0.1, + 3.0, + 6.0, + -0.6, + 0.1, + 8.0, // 2 + 12.0, // 2 + 0.1, + -0.3, + 7.0, + 2.0, + 4.0, // 1 + 6.0 // 1 + ]); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/zdscal/test/test.zdscal.js b/lib/node_modules/@stdlib/blas/base/zdscal/test/test.zdscal.js new file mode 100644 index 000000000000..dd012578436b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zdscal/test/test.zdscal.js @@ -0,0 +1,217 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isSameComplex128Array = require( '@stdlib/assert/is-same-complex128array' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var zdscal = require( './../lib/zdscal.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof zdscal, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 4', function test( t ) { + t.strictEqual( zdscal.length, 4, 'arity of 4' ); + t.end(); +}); + +tape( 'the function scales elements from `zx` by `da`', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array([ + 0.3, // 1 + 0.1, // 1 + 0.5, // 2 + 0.0, // 2 + 0.0, // 3 + 0.5, // 3 + 0.0, // 4 + 0.2 // 4 + ]); + + zdscal( 4, 2.0, zx, 1 ); + + expected = new Complex128Array([ + 0.6, // 1 + 0.2, // 1 + 1.0, // 2 + 0.0, // 2 + 0.0, // 3 + 1.0, // 3 + 0.0, // 4 + 0.4 // 4 + ]); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `zx` stride', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array([ + 0.1, // 1 + 0.1, // 1 + 3.0, + 6.0, + -0.6, // 2 + 0.1, // 2 + 4.0, + 7.0, + 0.1, // 3 + -0.3, // 3 + 7.0, + 2.0 + ]); + + zdscal( 3, 2.0, zx, 2 ); + + expected = new Complex128Array([ + 0.2, // 1 + 0.2, // 1 + 3.0, + 6.0, + -1.2, // 2 + 0.2, // 2 + 4.0, + 7.0, + 0.2, // 3 + -0.6, // 3 + 7.0, + 2.0 + ]); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `zx` stride', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array([ + 0.1, // 3 + 0.1, // 3 + 3.0, + 6.0, + -0.6, // 2 + 0.1, // 2 + 4.0, + 7.0, + 0.1, // 1 + -0.3, // 1 + 7.0, + 2.0 + ]); + + zdscal( 3, 2.0, zx, -2 ); + + expected = new Complex128Array([ + 0.2, // 3 + 0.2, // 3 + 3.0, + 6.0, + -1.2, // 2 + 0.2, // 2 + 4.0, + 7.0, + 0.2, // 1 + -0.6, // 1 + 7.0, + 2.0 + ]); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input array', function test( t ) { + var out; + var zx; + + zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + out = zdscal( 4, 2.0, zx, 1 ); + + t.strictEqual( out, zx, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the input array unchanged', function test( t ) { + var expected; + var zx; + + zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + + expected = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); // eslint-disable-line max-len + + zdscal( -1, 2.0, zx, 1 ); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + + zdscal( 0, 2.0, zx, 1 ); + t.strictEqual( isSameComplex128Array( zx, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var expected; + var zx0; + var zx1; + + // Initial array: + zx0 = new Complex128Array([ + 0.1, + -0.3, + 8.0, // 1 + 9.0, // 1 + 0.5, // 2 + -0.1, // 2 + 2.0, // 3 + 5.0, // 3 + 2.0, + 3.0 + ]); + + // Create offset view: + zx1 = new Complex128Array( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); // begin at 2nd element + + zdscal( 3, 2.0, zx1, 1 ); + + expected = new Complex128Array([ + 0.1, + -0.3, + 16.0, // 1 + 18.0, // 1 + 1.0, // 2 + -0.2, // 2 + 4.0, // 3 + 10.0, // 3 + 2.0, + 3.0 + ]); + t.strictEqual( isSameComplex128Array( zx0, expected ), true, 'returns expected value' ); + t.end(); +});