From dc999a82de64fa9d52c4c084a97c86428dc53fb3 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Mon, 20 Apr 2026 22:41:11 +0530 Subject: [PATCH 1/6] feat: add blas/base/ndarray/zcopy --- .../@stdlib/blas/base/ndarray/zcopy/README.md | 121 +++++++ .../base/ndarray/zcopy/benchmark/benchmark.js | 120 +++++++ .../blas/base/ndarray/zcopy/docs/repl.txt | 39 ++ .../base/ndarray/zcopy/docs/types/index.d.ts | 52 +++ .../base/ndarray/zcopy/docs/types/test.ts | 63 ++++ .../blas/base/ndarray/zcopy/examples/index.js | 40 +++ .../blas/base/ndarray/zcopy/lib/index.js | 51 +++ .../blas/base/ndarray/zcopy/lib/main.js | 64 ++++ .../blas/base/ndarray/zcopy/package.json | 72 ++++ .../blas/base/ndarray/zcopy/test/test.js | 333 ++++++++++++++++++ 10 files changed, 955 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md new file mode 100644 index 000000000000..149c21c3d62a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md @@ -0,0 +1,121 @@ + + +# zcopy + +> Copy values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`. + +
+ +
+ + + +
+ +## Usage + +```javascript +var zcopy = require( '@stdlib/blas/base/ndarray/zcopy' ); +``` + +#### zcopy( arrays ) + +Copies values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`. + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var x = new ndarray( 'complex128', xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); + +var ybuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); +var y = new ndarray( 'complex128', ybuf, [ 3 ], [ 1 ], 0, 'row-major' ); + +var z = zcopy( [ x, y ] ); +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] + +var bool = ( y === z ); +// returns true +``` + +The function has the following parameters: + +- **arrays**: array-like object containing an input ndarray and an output ndarray. + +
+ + + +
+ +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var zcopy = require( '@stdlib/blas/base/ndarray/zcopy' ); + +var opts = { + 'dtype': 'float64' +}; + +var xbuf = new Complex128Array( discreteUniform( 10, 0, 100, opts ) ); +var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var ybuf = new Complex128Array( discreteUniform( xbuf.length*2, 0, 10, opts ) ); +var y = new ndarray( 'complex128', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( y ) ); + +var out = zcopy( [ x, y ] ); +console.log( ndarray2array( out ) ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/benchmark/benchmark.js new file mode 100644 index 000000000000..6da2e1274eea --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/benchmark/benchmark.js @@ -0,0 +1,120 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 real = require( '@stdlib/complex/float64/real' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var zcopy = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'complex128' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var ybuf; + var x; + var y; + + xbuf = uniform( len*2, -100.0, 100.0, { + 'dtype': 'float64' + }); + x = new ndarray( options.dtype, new Complex128Array( xbuf ), [ len ], [ 1 ], 0, 'row-major' ); + + ybuf = uniform( len*2, -100.0, 100.0, { + 'dtype': 'float64' + }); + y = new ndarray( options.dtype, new Complex128Array( ybuf ), [ len ], [ 1 ], 0, 'row-major' ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var z; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = zcopy( [ x, y ] ); + if ( typeof z !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( isnan( real( z.get( i%len ) ) ) ) { + 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( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt new file mode 100644 index 000000000000..76a5c1ede99a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt @@ -0,0 +1,39 @@ + +{{alias}}( arrays ) + Copies values from a one-dimensional double-precision complex + floating-point ndarray `x` into a one-dimensional double-precision + complex floating-point ndarray `y`. + + If provided an empty input ndarray, the function returns the output + ndarray unchanged. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing an input ndarray and an output + ndarray. + + Returns + ------- + out: ndarray + Output ndarray. + + Examples + -------- + > var xbuf = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0 ] ); + > var ybuf = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0 ] ); + > var dt = 'complex128'; + > var sh = [ xbuf.length ]; + > var st = [ 1 ]; + > var oo = 0; + > var ord = 'row-major'; + > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord ); + > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord ); + + > {{alias}}( [ x, y ] ); + > y + [ [ 1.0, 2.0 ] ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/types/index.d.ts new file mode 100644 index 000000000000..1821afed013d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/types/index.d.ts @@ -0,0 +1,52 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 { complex128ndarray } from '@stdlib/types/ndarray'; + +/** +* Copies values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`. +* +* @param arrays - array-like object containing an input ndarray and an output ndarray +* @returns output ndarray +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new ndarray( 'complex128', xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* var ybuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); +* var y = new ndarray( 'complex128', ybuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* var z = zcopy( [ x, y ] ); +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] +* +* var bool = ( z === y ); +* // returns true +*/ +declare function zcopy( arrays: [ complex128ndarray, complex128ndarray ] ): complex128ndarray; + + +// EXPORTS // + +export = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/types/test.ts new file mode 100644 index 000000000000..5c621fe07f19 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/types/test.ts @@ -0,0 +1,63 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import zcopy = require( './index' ); + + +// TESTS // + +// The function returns an ndarray... +{ + const x = zeros( [ 10 ], { + 'dtype': 'complex128' + }); + const y = zeros( [ 10 ], { + 'dtype': 'complex128' + }); + + zcopy( [ x, y ] ); // $ExpectType complex128ndarray +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + zcopy( '10' ); // $ExpectError + zcopy( 10 ); // $ExpectError + zcopy( true ); // $ExpectError + zcopy( false ); // $ExpectError + zcopy( null ); // $ExpectError + zcopy( undefined ); // $ExpectError + zcopy( [] ); // $ExpectError + zcopy( {} ); // $ExpectError + zcopy( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 10 ], { + 'dtype': 'complex128' + }); + const y = zeros( [ 10 ], { + 'dtype': 'complex128' + }); + + zcopy(); // $ExpectError + zcopy( [ x, y ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js new file mode 100644 index 000000000000..8788c4826a77 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/array/discrete-uniform' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var zcopy = require( './../lib' ); + +var opts = { + 'dtype': 'float64' +}; + +var xbuf = new Complex128Array( discreteUniform( 10, 0, 100, opts ) ); +var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var ybuf = new Complex128Array( discreteUniform( xbuf.length*2, 0, 10, opts ) ); +var y = new ndarray( 'complex128', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( y ) ); + +var out = zcopy( [ x, y ] ); +console.log( ndarray2array( out ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/lib/index.js new file mode 100644 index 000000000000..d80d1078fbea --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/lib/index.js @@ -0,0 +1,51 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 copy values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`. +* +* @module @stdlib/blas/base/ndarray/zcopy +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var zcopy = require( '@stdlib/blas/base/ndarray/zcopy' ); +* +* var xbuf = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new ndarray( 'complex128', xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* var ybuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); +* var y = new ndarray( 'complex128', ybuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* var z = zcopy( [ x, y ] ); +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] +* +* var bool = ( z === y ); +* // returns true +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/lib/main.js new file mode 100644 index 000000000000..100b93908235 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/lib/main.js @@ -0,0 +1,64 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/blas/base/zcopy' ).ndarray; + + +// MAIN // + +/** +* Copies values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`. +* +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray and an output ndarray +* @returns {Object} output ndarray +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new ndarray( 'complex128', xbuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* var ybuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); +* var y = new ndarray( 'complex128', ybuf, [ 3 ], [ 1 ], 0, 'row-major' ); +* +* var z = zcopy( [ x, y ] ); +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] +* +* var bool = ( z === y ); +* // returns true +*/ +function zcopy( arrays ) { + var x = arrays[ 0 ]; + var y = arrays[ 1 ]; + strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( y ), getStride( y, 0 ), getOffset( y ) ); // eslint-disable-line max-len + return y; +} + + +// EXPORTS // + +module.exports = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/package.json new file mode 100644 index 000000000000..9f68f9e27a07 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/blas/base/ndarray/zcopy", + "version": "0.0.0", + "description": "Copy values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`.", + "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", + "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", + "zcopy", + "linear", + "algebra", + "subroutines", + "ccopy", + "dcopy", + "copy", + "vector", + "array", + "ndarray", + "complex128", + "double", + "complex128array" + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js new file mode 100644 index 000000000000..64eecf4af422 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js @@ -0,0 +1,333 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var zcopy = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Collection} buffer - underlying data buffer +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( buffer, length, stride, offset ) { + return new ndarray( 'complex128', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof zcopy, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( zcopy.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function copies values from one-dimensional ndarray `x` into one-dimensional ndarray `y`', function test( t ) { + var expected; + var xbuf; + var ybuf; + var x; + var y; + var v; + + xbuf = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0, // 2 + 5.0, // 3 + 6.0 // 3 + ]); + ybuf = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, // 3 + 0.0 // 3 + ]); + x = vector( xbuf, 3, 1, 0 ); + y = vector( ybuf, 3, 1, 0 ); + + v = zcopy( [ x, y ] ); + + expected = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0, // 2 + 5.0, // 3 + 6.0 // 3 + ]); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameComplex128Array( getData( v ), expected ), true, 'returns expected value' ); + + xbuf = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0 // 2 + ]); + ybuf = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0 // 2 + ]); + x = vector( xbuf, 2, 1, 0 ); + y = vector( ybuf, 2, 1, 0 ); + + v = zcopy( [ x, y ] ); + + expected = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0 // 2 + ]); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameComplex128Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided empty ndarrays, the function returns the output ndarray unchanged', function test( t ) { + var expected; + var xbuf; + var ybuf; + var x; + var y; + var v; + + xbuf = new Complex128Array( [] ); + ybuf = new Complex128Array( [] ); + x = vector( xbuf, 0, 1, 0 ); + y = vector( ybuf, 0, 1, 0 ); + + v = zcopy( [ x, y ] ); + + expected = new Complex128Array( [] ); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameComplex128Array( getData( v ), expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { + var expected; + var xbuf; + var ybuf; + var x; + var y; + var v; + + xbuf = new Complex128Array([ + 1.0, // 0 + 2.0, // 0 + 0.0, + 0.0, + 3.0, // 1 + 4.0, // 1 + 0.0, + 0.0, + 5.0, // 2 + 6.0 // 2 + ]); + x = vector( xbuf, 3, 2, 0 ); + + ybuf = new Complex128Array([ + 0.0, // 0 + 0.0, // 0 + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + y = vector( ybuf, 3, 1, 0 ); + + v = zcopy( [ x, y ] ); + + expected = new Complex128Array([ + 1.0, // 0 + 2.0, // 0 + 3.0, // 1 + 4.0, // 1 + 5.0, // 2 + 6.0, // 2 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameComplex128Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var expected; + var xbuf; + var ybuf; + var x; + var y; + var v; + + xbuf = new Complex128Array([ + 1.0, // 2 + 2.0, // 2 + 0.0, + 0.0, + 3.0, // 1 + 4.0, // 1 + 0.0, + 0.0, + 5.0, // 0 + 6.0 // 0 + ]); + x = vector( xbuf, 3, -2, 4 ); + + ybuf = new Complex128Array([ + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0, // 1 + 0.0, // 0 + 0.0, // 0 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + y = vector( ybuf, 3, -1, 2 ); + + v = zcopy( [ x, y ] ); + + expected = new Complex128Array([ + 1.0, // 2 + 2.0, // 2 + 3.0, // 1 + 4.0, // 1 + 5.0, // 0 + 6.0, // 0 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameComplex128Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var expected; + var xbuf; + var ybuf; + var x; + var y; + var v; + + xbuf = new Complex128Array([ + 0.0, + 0.0, + 1.0, // 0 + 2.0, // 0 + 0.0, + 0.0, + 3.0, // 1 + 4.0, // 1 + 0.0, + 0.0, + 5.0, // 2 + 6.0, // 2 + 0.0, + 0.0, + 7.0, // 3 + 8.0 // 3 + ]); + x = vector( xbuf, 4, 2, 1 ); + + ybuf = new Complex128Array([ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, // 0 + 0.0, // 0 + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, // 3 + 0.0, // 3 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + y = vector( ybuf, 4, 1, 2 ); + + v = zcopy( [ x, y ] ); + + expected = new Complex128Array([ + 0.0, + 0.0, + 0.0, + 0.0, + 1.0, // 0 + 2.0, // 0 + 3.0, // 1 + 4.0, // 1 + 5.0, // 2 + 6.0, // 2 + 7.0, // 3 + 8.0, // 3 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + t.strictEqual( v, y, 'returns expected value' ); + t.strictEqual( isSameComplex128Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); From 0e88d9d917019967110ea90fbae825e6e8d1f8fc Mon Sep 17 00:00:00 2001 From: kaustubh Date: Tue, 21 Apr 2026 02:07:08 +0530 Subject: [PATCH 2/6] fix line breaks --- .../@stdlib/blas/base/ndarray/zcopy/docs/repl.txt | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt index 76a5c1ede99a..8b7fa58c4879 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt @@ -4,14 +4,13 @@ floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`. - If provided an empty input ndarray, the function returns the output - ndarray unchanged. + If provided an empty input ndarray, the function returns the output ndarray + unchanged. Parameters ---------- arrays: ArrayLikeObject - Array-like object containing an input ndarray and an output - ndarray. + Array-like object containing an input ndarray and an output ndarray. Returns ------- @@ -20,8 +19,8 @@ Examples -------- - > var xbuf = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0 ] ); - > var ybuf = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0 ] ); + > var xbuf = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > var ybuf = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0 ] ); > var dt = 'complex128'; > var sh = [ xbuf.length ]; > var st = [ 1 ]; @@ -32,7 +31,7 @@ > {{alias}}( [ x, y ] ); > y - [ [ 1.0, 2.0 ] ] + [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] See Also -------- From 6cbb842d2392cfc9e2b8c71029c761151f1440aa Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 20 Apr 2026 17:05:11 -0700 Subject: [PATCH 3/6] style: fix line wrapping Signed-off-by: Athan --- .../@stdlib/blas/base/ndarray/zcopy/docs/repl.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt index 8b7fa58c4879..a5012277b50a 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( arrays ) - Copies values from a one-dimensional double-precision complex - floating-point ndarray `x` into a one-dimensional double-precision - complex floating-point ndarray `y`. + Copies values from a one-dimensional double-precision complex floating-point + ndarray `x` into a one-dimensional double-precision complex floating-point + ndarray `y`. If provided an empty input ndarray, the function returns the output ndarray unchanged. From f84264f1532eee48bd246b1d5a97ad23c1e830df Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 20 Apr 2026 17:07:40 -0700 Subject: [PATCH 4/6] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md | 2 +- .../@stdlib/blas/base/ndarray/zcopy/examples/index.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md index 149c21c3d62a..6ed4d2b7fcd2 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md @@ -92,7 +92,7 @@ var xbuf = new Complex128Array( discreteUniform( 10, 0, 100, opts ) ); var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); -var ybuf = new Complex128Array( discreteUniform( xbuf.length*2, 0, 10, opts ) ); +var ybuf = new Complex128Array( discreteUniform( xbuf.length, 0, 10, opts ) ); var y = new ndarray( 'complex128', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( y ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js index 8788c4826a77..8ffbd0d309a2 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js @@ -32,7 +32,7 @@ var xbuf = new Complex128Array( discreteUniform( 10, 0, 100, opts ) ); var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); -var ybuf = new Complex128Array( discreteUniform( xbuf.length*2, 0, 10, opts ) ); +var ybuf = new Complex128Array( discreteUniform( xbuf.length, 0, 10, opts ) ); var y = new ndarray( 'complex128', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( y ) ); From 2198a7dd047ff1616e79dd152609fdf5d5979e13 Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 20 Apr 2026 17:09:12 -0700 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js index 64eecf4af422..ebe870bc4c5b 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/test/test.js @@ -58,7 +58,7 @@ tape( 'the function has an arity of 1', function test( t ) { t.end(); }); -tape( 'the function copies values from one-dimensional ndarray `x` into one-dimensional ndarray `y`', function test( t ) { +tape( 'the function copies values from a one-dimensional ndarray `x` into a one-dimensional ndarray `y`', function test( t ) { var expected; var xbuf; var ybuf; From be937366c8192846338d5e44a99a608e36cc99c9 Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 20 Apr 2026 17:12:16 -0700 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Athan Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md | 2 +- .../@stdlib/blas/base/ndarray/zcopy/examples/index.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md index 6ed4d2b7fcd2..149c21c3d62a 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/README.md @@ -92,7 +92,7 @@ var xbuf = new Complex128Array( discreteUniform( 10, 0, 100, opts ) ); var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); -var ybuf = new Complex128Array( discreteUniform( xbuf.length, 0, 10, opts ) ); +var ybuf = new Complex128Array( discreteUniform( xbuf.length*2, 0, 10, opts ) ); var y = new ndarray( 'complex128', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( y ) ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js index 8ffbd0d309a2..8788c4826a77 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/ndarray/zcopy/examples/index.js @@ -32,7 +32,7 @@ var xbuf = new Complex128Array( discreteUniform( 10, 0, 100, opts ) ); var x = new ndarray( 'complex128', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); -var ybuf = new Complex128Array( discreteUniform( xbuf.length, 0, 10, opts ) ); +var ybuf = new Complex128Array( discreteUniform( xbuf.length*2, 0, 10, opts ) ); var y = new ndarray( 'complex128', ybuf, [ ybuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( y ) );