From 1dda7d20d743bf44053c96cfa9bf89f456e1ed8b Mon Sep 17 00:00:00 2001 From: Aman Bhansali <92033532+aman-095@users.noreply.github.com> Date: Wed, 3 Apr 2024 14:29:02 +0530 Subject: [PATCH] feat: add `blas/base/zcopy` PR-URL: https://github.com/stdlib-js/stdlib/pull/2064 Ref: https://github.com/stdlib-js/stdlib/issues/2039 Co-authored-by: Athan Reines Reviewed-by: Athan Reines Signed-off-by: Athan Reines --- .../@stdlib/blas/base/zcopy/README.md | 228 +++++++++++ .../blas/base/zcopy/benchmark/benchmark.js | 115 ++++++ .../base/zcopy/benchmark/benchmark.native.js | 120 ++++++ .../base/zcopy/benchmark/benchmark.ndarray.js | 115 ++++++ .../benchmark/benchmark.ndarray.native.js | 120 ++++++ .../blas/base/zcopy/benchmark/c/Makefile | 129 ++++++ .../base/zcopy/benchmark/c/benchmark.length.c | 161 ++++++++ .../base/zcopy/benchmark/fortran/Makefile | 141 +++++++ .../benchmark/fortran/benchmark.length.f | 217 ++++++++++ .../@stdlib/blas/base/zcopy/binding.gyp | 265 +++++++++++++ .../@stdlib/blas/base/zcopy/docs/repl.txt | 132 +++++++ .../blas/base/zcopy/docs/types/index.d.ts | 147 +++++++ .../blas/base/zcopy/docs/types/test.ts | 249 ++++++++++++ .../blas/base/zcopy/examples/c/Makefile | 129 ++++++ .../blas/base/zcopy/examples/c/example.c | 41 ++ .../@stdlib/blas/base/zcopy/examples/index.js | 38 ++ .../@stdlib/blas/base/zcopy/include.gypi | 70 ++++ .../zcopy/include/stdlib/blas/base/zcopy.h | 41 ++ .../include/stdlib/blas/base/zcopy_cblas.h | 41 ++ .../include/stdlib/blas/base/zcopy_fortran.h | 41 ++ .../@stdlib/blas/base/zcopy/lib/index.js | 90 +++++ .../@stdlib/blas/base/zcopy/lib/main.js | 35 ++ .../@stdlib/blas/base/zcopy/lib/native.js | 35 ++ .../@stdlib/blas/base/zcopy/lib/ndarray.js | 89 +++++ .../blas/base/zcopy/lib/ndarray.native.js | 78 ++++ .../@stdlib/blas/base/zcopy/lib/zcopy.js | 102 +++++ .../blas/base/zcopy/lib/zcopy.native.js | 68 ++++ .../@stdlib/blas/base/zcopy/manifest.json | 169 ++++++++ .../@stdlib/blas/base/zcopy/package.json | 82 ++++ .../@stdlib/blas/base/zcopy/src/Makefile | 70 ++++ .../@stdlib/blas/base/zcopy/src/addon.c | 45 +++ .../@stdlib/blas/base/zcopy/src/zcopy.c | 64 +++ .../@stdlib/blas/base/zcopy/src/zcopy.f | 94 +++++ .../@stdlib/blas/base/zcopy/src/zcopy_cblas.c | 33 ++ .../@stdlib/blas/base/zcopy/src/zcopy_f.c | 33 ++ .../@stdlib/blas/base/zcopy/test/test.js | 82 ++++ .../blas/base/zcopy/test/test.ndarray.js | 361 +++++++++++++++++ .../base/zcopy/test/test.ndarray.native.js | 370 ++++++++++++++++++ .../blas/base/zcopy/test/test.zcopy.js | 331 ++++++++++++++++ .../blas/base/zcopy/test/test.zcopy.native.js | 340 ++++++++++++++++ 40 files changed, 5111 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/README.md create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/benchmark/fortran/Makefile create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/benchmark/fortran/benchmark.length.f create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/binding.gyp create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/include.gypi create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/include/stdlib/blas/base/zcopy.h create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/include/stdlib/blas/base/zcopy_cblas.h create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/include/stdlib/blas/base/zcopy_fortran.h create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/lib/native.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/lib/zcopy.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/lib/zcopy.native.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/package.json create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/src/Makefile create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/src/addon.c create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy.c create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy.f create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy_cblas.c create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy_f.c create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/test/test.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/test/test.zcopy.js create mode 100644 lib/node_modules/@stdlib/blas/base/zcopy/test/test.zcopy.native.js diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/README.md b/lib/node_modules/@stdlib/blas/base/zcopy/README.md new file mode 100644 index 00000000000..2be1bc14078 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/README.md @@ -0,0 +1,228 @@ + + +# zcopy + +> Copy values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. + +
+ +## Usage + +```javascript +var zcopy = require( '@stdlib/blas/base/zcopy' ); +``` + +#### zcopy( N, x, strideX, y, strideY ) + +Copies values from `x` into `y`. + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); + +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + +zcopy( x.length, x, 1, y, 1 ); + +var z = y.get( 0 ); +// returns + +var re = real( z ); +// returns 1.0 + +var im = imag( z ); +// returns 2.0 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Complex128Array`][@stdlib/array/complex128]. +- **strideX**: index increment for `x`. +- **y**: destination [`Complex128Array`][@stdlib/array/complex128]. +- **strideY**: index increment for `y`. + +The `N` and stride parameters determine how values from `x` are copied into `y`. For example, to copy in reverse order every other value in `x` into the first `N` elements of `y`, + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); + +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + +zcopy( 2, x, -2, y, 1 ); + +var z = y.get( 0 ); +// returns + +var re = real( z ); +// returns 5.0 + +var im = imag( z ); +// returns 6.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/real' ); +var imag = require( '@stdlib/complex/imag' ); + +// Initial arrays... +var x0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +var y0 = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + +// Create offset views... +var x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 3rd element + +// Copy in reverse order every other value from `x1` into `y1`... +zcopy( 2, x1, -2, y1, 1 ); + +var z = y0.get( 2 ); +// returns + +var re = real( z ); +// returns 7.0 + +var im = imag( z ); +// returns 8.0 +``` + +#### zcopy.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + +Copies values from `x` into `y` using alternative indexing semantics. + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); + +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + +zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); + +var z = y.get( 0 ); +// returns + +var re = real( z ); +// returns 1.0 + +var im = imag( z ); +// returns 2.0 +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. +- **offsetY**: starting index for `y`. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to copy every other value in `x` starting from the second value into the last `N` elements in `y` where `x[i] = y[n]`, `x[i+2] = y[n-1]`,..., + +```javascript +var Complex128Array = require( '@stdlib/array/complex128' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); + +var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +var y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + +zcopy.ndarray( 2, x, 2, 1, y, -1, y.length-1 ); + +var z = y.get( y.length-1 ); +// returns + +var re = real( z ); +// returns 3.0 + +var im = imag( z ); +// returns 4.0 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return `y` unchanged. +- `zcopy()` corresponds to the [BLAS][blas] level 1 function [`zcopy`][zcopy]. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var zcopy = require( '@stdlib/blas/base/zcopy' ); + +function rand() { + return new Complex128( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); +} + +var x = filledarrayBy( 10, 'complex128', rand ); +console.log( x.get( 0 ).toString() ); + +var y = filledarrayBy( 10, 'complex128', rand ); +console.log( y.get( 0 ).toString() ); + +// Copy elements from `x` into `y` starting from the end of `y`: +zcopy( x.length, x, 1, y, -1 ); +console.log( y.get( y.length-1 ).toString() ); +``` + +
+ + + + + +
+ +[blas]: http://www.netlib.org/blas + +[zcopy]: https://www.netlib.org/lapack/explore-html/d5/d2b/group__copy_gaca1a115319081adeb0a9b80ec37ce626.html#gaca1a115319081adeb0a9b80ec37ce626 + +[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/zcopy/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.js new file mode 100644 index 00000000000..8eda5d59160 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.js @@ -0,0 +1,115 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' ); +var pkg = require( './../package.json' ).name; +var zcopy = require( './../lib/zcopy.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 viewY; + var x; + var y; + + x = uniform( len*2, -100.0, 100.0, options ); + x = new Complex128Array( x.buffer ); + + y = new Complex128Array( len ); + viewY = reinterpret( y, 0 ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + for ( i = 0; i < len*2; i++ ) { + viewY[ i ] = 0.0; + } + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + zcopy( x.length, x, 1, y, 1 ); + if ( isnan( viewY[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( viewY[ 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/zcopy/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.native.js new file mode 100644 index 00000000000..16a39807954 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.native.js @@ -0,0 +1,120 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 resolve = require( 'path' ).resolve; +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 reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var zcopy = tryRequire( resolve( __dirname, './../lib/zcopy.native.js' ) ); +var opts = { + 'skip': ( zcopy instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var viewY; + var x; + var y; + + x = uniform( len*2, -100.0, 100.0, options ); + x = new Complex128Array( x.buffer ); + + y = new Complex128Array( len ); + viewY = reinterpret( y, 0 ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + for ( i = 0; i < len*2; i++ ) { + viewY[ i ] = 0.0; + } + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + zcopy( x.length, x, 1, y, 1 ); + if ( isnan( viewY[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( viewY[ 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+'::native:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.ndarray.js new file mode 100644 index 00000000000..7e7123add88 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.ndarray.js @@ -0,0 +1,115 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' ); +var pkg = require( './../package.json' ).name; +var zcopy = 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 viewY; + var x; + var y; + + x = uniform( len*2, -100.0, 100.0, options ); + x = new Complex128Array( x.buffer ); + + y = new Complex128Array( len ); + viewY = reinterpret( y, 0 ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + for ( i = 0; i < len*2; i++ ) { + viewY[ i ] = 0.0; + } + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + zcopy( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( viewY[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( viewY[ 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/zcopy/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.ndarray.native.js new file mode 100644 index 00000000000..b06a0888fa5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,120 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 resolve = require( 'path' ).resolve; +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 reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var zcopy = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( zcopy instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var viewY; + var x; + var y; + + x = uniform( len*2, -100.0, 100.0, options ); + x = new Complex128Array( x.buffer ); + + y = new Complex128Array( len ); + viewY = reinterpret( y, 0 ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + for ( i = 0; i < len*2; i++ ) { + viewY[ i ] = 0.0; + } + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + zcopy( x.length, x, 1, 0, y, 1, 0 ); + if ( isnan( viewY[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( viewY[ 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+'::native:ndarray:len='+len, opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/c/Makefile new file mode 100644 index 00000000000..b2e5c564320 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/c/Makefile @@ -0,0 +1,129 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of source files: +c_src := ../../src/zcopy.c + +# List of C targets: +c_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles C source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code (e.g., `-fPIC`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler +# @param {string} CFLAGS - C compiler flags +# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) -I ../../include -o $@ $(c_src) $< -lm + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/c/benchmark.length.c new file mode 100644 index 00000000000..4f44b73c9bb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/c/benchmark.length.c @@ -0,0 +1,161 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +/** +* Benchmark `zcopy`. +*/ +#include "stdlib/blas/base/zcopy.h" +#include +#include +#include +#include +#include + +#define NAME "zcopy" +#define ITERATIONS 10000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* Prints the TAP version. +*/ +void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param iterations number of iterations +* @param elapsed elapsed time in seconds +*/ +void print_results( int iterations, double elapsed ) { + double rate = (double)iterations / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", iterations ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1]. +* +* @return random number +*/ +double rand_double( void ) { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +double benchmark( int iterations, int len ) { + double elapsed; + double *x; + double *y; + double t; + int i; + + x = (double *) malloc( len*2 * sizeof( double ) ); + y = (double *) malloc( len*2 * sizeof( double ) ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double()*10000.0 ) - 5000.0; + x[ i+1 ] = ( rand_double()*10000.0 ) - 5000.0; + y[ i ] = 0.0; + y[ i+1 ] = 0.0; + } + t = tic(); + for ( i = 0; i < iterations; i++ ) { + c_zcopy( len, (void *)x, 1, (void *)y, 1 ); + if ( y[ 0 ] != y[ 0 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y[ 0 ] != y[ 0 ] ) { + printf( "should not return NaN\n" ); + } + free( x ); + free( y ); + + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int len; + int i; + int j; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + count = 0; + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:len=%d\n", NAME, len ); + elapsed = benchmark( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/fortran/Makefile b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/fortran/Makefile new file mode 100644 index 00000000000..ab3c1fac2bd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/fortran/Makefile @@ -0,0 +1,141 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling Fortran source files: +ifdef FORTRAN_COMPILER + FC := $(FORTRAN_COMPILER) +else + FC := gfortran +endif + +# Define the command-line options when compiling Fortran files: +FFLAGS ?= \ + -std=f95 \ + -ffree-form \ + -O3 \ + -Wall \ + -Wextra \ + -Wno-compare-reals \ + -Wimplicit-interface \ + -fno-underscoring \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop`): +INCLUDE ?= + +# List of Fortran source files: +SOURCE_FILES ?= ../../src/zcopy.f + +# List of Fortran targets: +f_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles Fortran source files. +# +# @param {string} SOURCE_FILES - list of Fortran source files +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop`) +# @param {string} [FORTRAN_COMPILER] - Fortran compiler +# @param {string} [FFLAGS] - Fortran compiler flags +# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code +# +# @example +# make +# +# @example +# make all +#/ +all: $(f_targets) + +.PHONY: all + +#/ +# Compiles Fortran source files. +# +# @private +# @param {string} SOURCE_FILES - list of Fortran source files +# @param {(string|void)} INCLUDE - list of includes (e.g., `-I /foo/bar -I /beep/boop`) +# @param {string} FC - Fortran compiler +# @param {string} FFLAGS - Fortran compiler flags +# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code +#/ +$(f_targets): %.out: %.f + $(QUIET) $(FC) $(FFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(f_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/fortran/benchmark.length.f b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/fortran/benchmark.length.f new file mode 100644 index 00000000000..fe2341a2613 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/benchmark/fortran/benchmark.length.f @@ -0,0 +1,217 @@ +!> +! @license Apache-2.0 +! +! Copyright (c) 2024 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. +!< + +!> Benchmark `zcopy`. +! +! ## Notes +! +! - Written in "free form" Fortran 95. +! +!< +program bench + implicit none + ! .. + ! Local constants: + character(5), parameter :: name = 'zcopy' ! if changed, be sure to adjust length + integer, parameter :: iterations = 10000000 + integer, parameter :: repeats = 3 + integer, parameter :: min = 1 + integer, parameter :: max = 6 + ! .. + ! Run the benchmarks: + call main() + ! .. + ! Functions: +contains + ! .. + ! Prints the TAP version. + ! .. + subroutine print_version() + print '(A)', 'TAP version 13' + end subroutine print_version + ! .. + ! Prints the TAP summary. + ! + ! @param {integer} total - total number of tests + ! @param {integer} passing - total number of passing tests + ! .. + subroutine print_summary( total, passing ) + ! .. + ! Scalar arguments: + integer, intent(in) :: total, passing + ! .. + ! Local variables: + character(len=999) :: str, tmp + ! .. + ! Intrinsic functions: + intrinsic adjustl, trim + ! .. + print '(A)', '#' + ! .. + write (str, '(I15)') total ! TAP plan + tmp = adjustl( str ) + print '(A,A)', '1..', trim( tmp ) + ! .. + print '(A,A)', '# total ', trim( tmp ) + ! .. + write (str, '(I15)') passing + tmp = adjustl( str ) + print '(A,A)', '# pass ', trim( tmp ) + ! .. + print '(A)', '#' + print '(A)', '# ok' + end subroutine print_summary + ! .. + ! Prints benchmarks results. + ! + ! @param {integer} iterations - number of iterations + ! @param {double} elapsed - elapsed time in seconds + ! .. + subroutine print_results( iterations, elapsed ) + ! .. + ! Scalar arguments: + double precision, intent(in) :: elapsed + integer, intent(in) :: iterations + ! .. + ! Local variables: + double precision :: rate + character(len=999) :: str, tmp + ! .. + ! Intrinsic functions: + intrinsic dble, adjustl, trim + ! .. + rate = dble( iterations ) / elapsed + ! .. + print '(A)', ' ---' + ! .. + write (str, '(I15)') iterations + tmp = adjustl( str ) + print '(A,A)', ' iterations: ', trim( tmp ) + ! .. + write (str, '(f0.9)') elapsed + tmp = adjustl( str ) + print '(A,A)', ' elapsed: ', trim( tmp ) + ! .. + write( str, '(f0.9)') rate + tmp = adjustl( str ) + print '(A,A)', ' rate: ', trim( tmp ) + ! .. + print '(A)', ' ...' + end subroutine print_results + ! .. + ! Runs a benchmark. + ! + ! @param {integer} iterations - number of iterations + ! @param {integer} len - array length + ! @return {double} elapsed time in seconds + ! .. + double precision function benchmark( iterations, len ) + ! .. + ! External functions: + interface + subroutine zcopy( N, zx, strideX, zy, strideY ) + complex(kind=8) :: zx(*), zy(*) + integer :: strideX, strideY, N + end subroutine zcopy + end interface + ! .. + ! Scalar arguments: + integer, intent(in) :: iterations, len + ! .. + ! Local scalars: + double precision :: elapsed, r1, r2 + real :: t1, t2 + integer :: i + ! .. + ! Local arrays: + complex(kind=8), allocatable :: x(:), y(:) + ! .. + ! Intrinsic functions: + intrinsic random_number, cpu_time, cmplx + ! .. + ! Allocate arrays: + allocate( x(len), y(len) ) + ! .. + do i = 1, len + call random_number( r1 ) + call random_number( r2 ) + x( i ) = cmplx( (r1*10000.0d0)-5000.0d0, (r2*1000.0d0)-5000.0d0, kind=kind(0.0d0) ) + y( i ) = ( 0.0d0, 0.0d0 ) + end do + ! .. + call cpu_time( t1 ) + ! .. + do i = 1, iterations + call zcopy( len, x, 1, y, 1 ); + if ( y( 1 ) /= y( 1 ) ) then + print '(A)', 'should not return NaN' + exit + end if + end do + ! .. + call cpu_time( t2 ) + ! .. + elapsed = t2 - t1 + ! .. + if ( y( 1 ) /= y( 1 ) ) then + print '(A)', 'should not return NaN' + end if + ! .. + ! Deallocate arrays: + deallocate( x, y ) + ! .. + benchmark = elapsed + return + end function benchmark + ! .. + ! Main execution sequence. + ! .. + subroutine main() + ! .. + ! Local variables: + integer :: count, iter, len, i, j + double precision :: elapsed + character(len=999) :: str, tmp + ! .. + ! Intrinsic functions: + intrinsic adjustl, trim + ! .. + call print_version() + count = 0 + do i = min, max + len = 10**i + iter = iterations / 10**(i-1) + do j = 1, repeats + count = count + 1 + ! .. + write (str, '(I15)') len + tmp = adjustl( str ) + print '(A,A,A,A)', '# fortran::', name, ':len=', trim( tmp ) + ! .. + elapsed = benchmark( iter, len ) + ! .. + call print_results( iter, elapsed ) + ! .. + write (str, '(I15)') count + tmp = adjustl( str ) + print '(A,A,A)', 'ok ', trim( tmp ), ' benchmark finished' + end do + end do + call print_summary( count, count ) + end subroutine main +end program bench diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/binding.gyp b/lib/node_modules/@stdlib/blas/base/zcopy/binding.gyp new file mode 100644 index 00000000000..02a2799da09 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/binding.gyp @@ -0,0 +1,265 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Fortran compiler (to override -Dfortran_compiler=): + 'fortran_compiler%': 'gfortran', + + # Fortran compiler flags: + 'fflags': [ + # Specify the Fortran standard to which a program is expected to conform: + '-std=f95', + + # Indicate that the layout is free-form source code: + '-ffree-form', + + # Aggressive optimization: + '-O3', + + # Enable commonly used warning options: + '-Wall', + + # Warn if source code contains problematic language features: + '-Wextra', + + # Warn if a procedure is called without an explicit interface: + '-Wimplicit-interface', + + # Do not transform names of entities specified in Fortran source files by appending underscores (i.e., don't mangle names, thus allowing easier usage in C wrappers): + '-fno-underscoring', + + # Warn if source code contains Fortran 95 extensions and C-language constructs: + '-pedantic', + + # Compile but do not link (output is an object file): + '-c', + ], + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + + # Define custom build actions for particular inputs: + 'rules': [ + { + # Define a rule for processing Fortran files: + 'extension': 'f', + + # Define the pathnames to be used as inputs when performing processing: + 'inputs': [ + # Full path of the current input: + '<(RULE_INPUT_PATH)' + ], + + # Define the outputs produced during processing: + 'outputs': [ + # Store an output object file in a directory for placing intermediate results (only accessible within a single target): + '<(INTERMEDIATE_DIR)/<(RULE_INPUT_ROOT).<(obj)' + ], + + # Define the rule for compiling Fortran based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + + # Rule to compile Fortran on Windows: + { + 'rule_name': 'compile_fortran_windows', + 'message': 'Compiling Fortran file <(RULE_INPUT_PATH) on Windows...', + + 'process_outputs_as_sources': 0, + + # Define the command-line invocation: + 'action': [ + '<(fortran_compiler)', + '<@(fflags)', + '<@(_inputs)', + '-o', + '<@(_outputs)', + ], + }, + + # Rule to compile Fortran on non-Windows: + { + 'rule_name': 'compile_fortran_linux', + 'message': 'Compiling Fortran file <(RULE_INPUT_PATH) on Linux...', + + 'process_outputs_as_sources': 1, + + # Define the command-line invocation: + 'action': [ + '<(fortran_compiler)', + '<@(fflags)', + '-fPIC', # generate platform-independent code + '<@(_inputs)', + '-o', + '<@(_outputs)', + ], + } + ], # end condition (OS=="win") + ], # end conditions + }, # end rule (extension=="f") + ], # end rules + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/zcopy/docs/repl.txt new file mode 100644 index 00000000000..cd6ba39a176 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/docs/repl.txt @@ -0,0 +1,132 @@ + +{{alias}}( N, x, strideX, y, strideY ) + Copies values from one complex double-precision floating-point vector to + another complex double-precision floating-point vector. + + The `N` and stride parameters determine how values from `x` are copied into + `y`. + + 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 `y` unchanged. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Complex128Array + Input array. + + strideX: integer + Index increment for `x`. + + y: Complex128Array + Output array. + + strideY: integer + Index increment for `y`. + + Returns + ------- + y: Complex128Array + Output array. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] ); + > {{alias}}( x.length, x, 1, y, 1 ); + > var z = y.get( 0 ); + > var re = {{alias:@stdlib/complex/real}}( z ) + 1.0 + > var im = {{alias:@stdlib/complex/imag}}( z ) + 2.0 + + // Advanced indexing: + > x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + > {{alias}}( 2, x, -2, y, 1 ); + > z = y.get( 0 ); + > re = {{alias:@stdlib/complex/real}}( z ) + 5.0 + > im = {{alias:@stdlib/complex/imag}}( z ) + 6.0 + + // Using typed array views: + > var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > var y0 = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + > var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > var y1 = new {{alias:@stdlib/array/complex128}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); + > {{alias}}( 1, x1, -2, y1, 1 ); + > z = y0.get( 2 ); + > re = {{alias:@stdlib/complex/real}}( z ) + 3.0 + > im = {{alias:@stdlib/complex/imag}}( z ) + 4.0 + + +{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY ) + Copies values from one complex double-precision floating-point vector to + another complex double-precision floating-point vector using alternative + indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Complex128Array + Input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index for `x`. + + y: Complex128Array + Output array. + + strideY: integer + Index increment for `y`. + + offsetY: integer + Starting index for `y`. + + Returns + ------- + y: Complex128Array + Output array. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > var y = new {{alias:@stdlib/array/complex128}}( [ 6.0, 7.0, 8.0, 9.0 ] ); + > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0 ); + > var z = y.get( 0 ); + > var re = {{alias:@stdlib/complex/real}}( z ) + 1.0 + > var im = {{alias:@stdlib/complex/imag}}( z ) + 2.0 + + // Advanced indexing: + > x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > y = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + > {{alias}}.ndarray( 1, x, 2, 1, y, -1, y.length-1 ); + > z = y.get( y.length-1 ); + > re = {{alias:@stdlib/complex/real}}( z ) + 3.0 + > im = {{alias:@stdlib/complex/imag}}( z ) + 4.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/zcopy/docs/types/index.d.ts new file mode 100644 index 00000000000..2eae25a4a3e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/docs/types/index.d.ts @@ -0,0 +1,147 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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 `zcopy`. +*/ +interface Routine { + /** + * Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - `x` stride length + * @param y - output array + * @param strideY - `y` stride length + * @returns output array + * + * @example + * var Complex128Array = require( '@stdlib/array/complex128' ); + * var real = require( '@stdlib/complex/real' ); + * var imag = require( '@stdlib/complex/imag' ); + * + * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + * + * zcopy( x.length, x, 1, y, 1 ); + * + * var z = y.get( 0 ); + * // returns + * + * var re = real( z ); + * // returns 1.0 + * + * var im = imag( z ); + * // returns 2.0 + */ + ( N: number, x: Complex128Array, strideX: number, y: Complex128Array, strideY: number ): Complex128Array; + + /** + * Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param y - output array + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @returns output array + * + * @example + * var Complex128Array = require( '@stdlib/array/complex128' ); + * var real = require( '@stdlib/complex/real' ); + * var imag = require( '@stdlib/complex/imag' ); + * + * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); + * + * zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * + * var z = y.get( 0 ); + * // returns + * + * var re = real( z ); + * // returns 1.0 + * + * var im = imag( z ); + * // returns 2.0 + */ + ndarray( N: number, x: Complex128Array, strideX: number, offsetX: number, y: Complex128Array, strideY: number, offsetY: number ): Complex128Array; +} + +/** +* Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +* +* @param N - number of indexed elements +* @param x - input array +* @param strideX - `x` stride length +* @param y - output array +* @param strideY - `y` stride length +* @returns output array +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); +* +* zcopy( x.length, x, 1, y, 1 ); +* +* var z = y.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 1.0 +* +* var im = imag( z ); +* // returns 2.0 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); +* +* zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* +* var z = y.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 1.0 +* +* var im = imag( z ); +* // returns 2.0 +*/ +declare var zcopy: Routine; + + +// EXPORTS // + +export = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/zcopy/docs/types/test.ts new file mode 100644 index 00000000000..13d99402653 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/docs/types/test.ts @@ -0,0 +1,249 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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 zcopy = require( './index' ); + + +// TESTS // + +// The function returns a Complex128Array... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy( x.length, x, 1, y, 1 ); // $ExpectType Complex128Array +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy( '10', x, 1, y, 1 ); // $ExpectError + zcopy( true, x, 1, y, 1 ); // $ExpectError + zcopy( false, x, 1, y, 1 ); // $ExpectError + zcopy( null, x, 1, y, 1 ); // $ExpectError + zcopy( undefined, x, 1, y, 1 ); // $ExpectError + zcopy( [], x, 1, y, 1 ); // $ExpectError + zcopy( {}, x, 1, y, 1 ); // $ExpectError + zcopy( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a Complex128Array... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy( x.length, 10, 1, y, 1 ); // $ExpectError + zcopy( x.length, '10', 1, y, 1 ); // $ExpectError + zcopy( x.length, true, 1, y, 1 ); // $ExpectError + zcopy( x.length, false, 1, y, 1 ); // $ExpectError + zcopy( x.length, null, 1, y, 1 ); // $ExpectError + zcopy( x.length, undefined, 1, y, 1 ); // $ExpectError + zcopy( x.length, [ '1' ], 1, y, 1 ); // $ExpectError + zcopy( x.length, {}, 1, y, 1 ); // $ExpectError + zcopy( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy( x.length, x, '10', y, 1 ); // $ExpectError + zcopy( x.length, x, true, y, 1 ); // $ExpectError + zcopy( x.length, x, false, y, 1 ); // $ExpectError + zcopy( x.length, x, null, y, 1 ); // $ExpectError + zcopy( x.length, x, undefined, y, 1 ); // $ExpectError + zcopy( x.length, x, [], y, 1 ); // $ExpectError + zcopy( x.length, x, {}, y, 1 ); // $ExpectError + zcopy( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Complex128Array... +{ + const x = new Complex128Array( 10 ); + + zcopy( x.length, x, 1, 10, 1 ); // $ExpectError + zcopy( x.length, x, 1, '10', 1 ); // $ExpectError + zcopy( x.length, x, 1, true, 1 ); // $ExpectError + zcopy( x.length, x, 1, false, 1 ); // $ExpectError + zcopy( x.length, x, 1, null, 1 ); // $ExpectError + zcopy( x.length, x, 1, undefined, 1 ); // $ExpectError + zcopy( x.length, x, 1, [ '1' ], 1 ); // $ExpectError + zcopy( x.length, x, 1, {}, 1 ); // $ExpectError + zcopy( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy( x.length, x, 1, y, '10' ); // $ExpectError + zcopy( x.length, x, 1, y, true ); // $ExpectError + zcopy( x.length, x, 1, y, false ); // $ExpectError + zcopy( x.length, x, 1, y, null ); // $ExpectError + zcopy( x.length, x, 1, y, undefined ); // $ExpectError + zcopy( x.length, x, 1, y, [] ); // $ExpectError + zcopy( x.length, x, 1, y, {} ); // $ExpectError + zcopy( x.length, x, 1, y, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy(); // $ExpectError + zcopy( x.length ); // $ExpectError + zcopy( x.length, x ); // $ExpectError + zcopy( x.length, x, 1 ); // $ExpectError + zcopy( x.length, x, 1, y ); // $ExpectError + zcopy( x.length, x, 1, y, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Complex128Array... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); // $ExpectType Complex128Array +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( ( x: number ): number => x, x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Complex128Array... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, [ '1' ], 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, ( x: number ): number => x, 0, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Complex128Array... +{ + const x = new Complex128Array( 10 ); + + zcopy.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, [ '1' ], 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Complex128Array( 10 ); + const y = new Complex128Array( 10 ); + + zcopy.ndarray(); // $ExpectError + zcopy.ndarray( x.length ); // $ExpectError + zcopy.ndarray( x.length, x ); // $ExpectError + zcopy.ndarray( x.length, x, 1 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError + zcopy.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/examples/c/Makefile b/lib/node_modules/@stdlib/blas/base/zcopy/examples/c/Makefile new file mode 100644 index 00000000000..679178dbc60 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/examples/c/Makefile @@ -0,0 +1,129 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of source files: +c_src := ../../src/zcopy.c + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles C source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code (e.g., `-fPIC`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler +# @param {string} CFLAGS - C compiler flags +# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) -I ../../include -o $@ $(c_src) $< -lm + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/examples/c/example.c b/lib/node_modules/@stdlib/blas/base/zcopy/examples/c/example.c new file mode 100644 index 00000000000..06ed07ca245 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/examples/c/example.c @@ -0,0 +1,41 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/blas/base/zcopy.h" +#include + +int main( void ) { + // Create strided arrays: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + double y[] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }; + + // Specify the number of elements: + const int N = 4; + + // Specify stride lengths: + const int strideX = 1; + const int strideY = -1; + + // Copy elements: + c_zcopy( N, (void *)x, strideX, (void *)y, strideY ); + + // Print the result: + for ( int i = 0; i < N; i++ ) { + printf( "y[ %i ] = %lf + %lfj\n", i, y[ i*2 ], y[ (i*2)+1 ] ); + } +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/examples/index.js b/lib/node_modules/@stdlib/blas/base/zcopy/examples/index.js new file mode 100644 index 00000000000..e8363169de4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/examples/index.js @@ -0,0 +1,38 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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' ); +var zcopy = require( './../lib' ); + +function rand() { + return new Complex128( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); +} + +var x = filledarrayBy( 10, 'complex128', rand ); +console.log( x.get( 0 ).toString() ); + +var y = filledarrayBy( 10, 'complex128', rand ); +console.log( y.get( 0 ).toString() ); + +// Copy elements from `x` into `y` starting from the end of `y`: +zcopy( x.length, x, 1, y, -1 ); +console.log( y.get( y.length-1 ).toString() ); diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/include.gypi b/lib/node_modules/@stdlib/blas/base/zcopy/include.gypi new file mode 100644 index 00000000000..497aeca1532 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/include.gypi @@ -0,0 +1,70 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. + +# A GYP include file for building a Node.js native add-on. +# +# Note that nesting variables is required due to how GYP processes a configuration. Any variables defined within a nested 'variables' section is defined in the outer scope. Thus, conditions in the outer variable scope are free to use these variables without running into "variable undefined" errors. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +# +# Variable nesting hacks: +# +# [3]: https://chromium.googlesource.com/external/skia/gyp/+/master/common_variables.gypi +# [4]: https://src.chromium.org/viewvc/chrome/trunk/src/build/common.gypi?revision=127004 +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + 'variables': { + # Host BLAS library (to override -Dblas=): + 'blas%': '', + + # Path to BLAS library (to override -Dblas_dir=): + 'blas_dir%': '', + }, # end variables + + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + '<@(blas_dir)', + ' +* +* var re = real( z ); +* // returns 1.0 +* +* var im = imag( z ); +* // returns 2.0 +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* var zcopy = require( '@stdlib/blas/base/zcopy' ); +* +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); +* +* zcopy.ndarray( x.length, x, 1, 0, y, 1, 0 ); +* +* var z = y.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 1.0 +* +* var im = imag( z ); +* // returns 2.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 zcopy; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + zcopy = main; +} else { + zcopy = tmp; +} + + +// EXPORTS // + +module.exports = zcopy; + +// exports: { "ndarray": "zcopy.ndarray" } diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/lib/main.js b/lib/node_modules/@stdlib/blas/base/zcopy/lib/main.js new file mode 100644 index 00000000000..88ddc28954b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/lib/main.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 zcopy = require( './zcopy.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( zcopy, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/lib/native.js b/lib/node_modules/@stdlib/blas/base/zcopy/lib/native.js new file mode 100644 index 00000000000..1d4fedfb15e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/lib/native.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 zcopy = require( './zcopy.native.js' ); +var ndarray = require( './ndarray.native.js' ); + + +// MAIN // + +setReadOnly( zcopy, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.js new file mode 100644 index 00000000000..9175017184f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.js @@ -0,0 +1,89 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 // + +/** +* Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Complex128Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @param {Complex128Array} y - output array +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting `y` index +* @returns {Complex128Array} output array +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); +* +* zcopy( x.length, x, 1, 0, y, 1, 0 ); +* +* var z = y.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 1.0 +* +* var im = imag( z ); +* // returns 2.0 +*/ +function zcopy( N, x, strideX, offsetX, y, strideY, offsetY ) { + var viewX; + var viewY; + var sx; + var sy; + var ix; + var iy; + var i; + + if ( N <= 0 ) { + return y; + } + viewX = reinterpret( x, 0 ); + viewY = reinterpret( y, 0 ); + sx = strideX * 2; + sy = strideY * 2; + ix = offsetX * 2; + iy = offsetY * 2; + for ( i = 0; i < N; i++ ) { + viewY[ iy ] = viewX[ ix ]; + viewY[ iy+1 ] = viewX[ ix+1 ]; + ix += sx; + iy += sy; + } + return y; +} + + +// EXPORTS // + +module.exports = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.native.js new file mode 100644 index 00000000000..a9c3ecc175a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/lib/ndarray.native.js @@ -0,0 +1,78 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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' ); +var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' ); +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Complex128Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting `x` index +* @param {Complex128Array} y - output array +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting `y` index +* @returns {Complex128Array} output array +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); +* +* zcopy( x.length, x, 1, 0, y, 1, 0 ); +* +* var z = y.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 1.0 +* +* var im = imag( z ); +* // returns 2.0 +*/ +function zcopy( N, x, strideX, offsetX, y, strideY, offsetY ) { + var viewX; + var viewY; + + offsetX = minViewBufferIndex( N, strideX, offsetX ); + offsetY = minViewBufferIndex( N, strideY, offsetY ); + + viewX = reinterpret( x, offsetX ); + viewY = reinterpret( y, offsetY ); + + addon( N, viewX, strideX, viewY, strideY ); + return y; +} + + +// EXPORTS // + +module.exports = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/lib/zcopy.js b/lib/node_modules/@stdlib/blas/base/zcopy/lib/zcopy.js new file mode 100644 index 00000000000..8e8e0e21e05 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/lib/zcopy.js @@ -0,0 +1,102 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 // + +/** +* Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Complex128Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {Complex128Array} y - output array +* @param {integer} strideY - `y` stride length +* @returns {Complex128Array} output array +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); +* +* zcopy( x.length, x, 1, y, 1 ); +* +* var z = y.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 1.0 +* +* var im = imag( z ); +* // returns 2.0 +*/ +function zcopy( N, x, strideX, y, strideY ) { + var viewX; + var viewY; + var sx; + var sy; + var ix; + var iy; + var i; + + if ( N <= 0 ) { + return y; + } + viewX = reinterpret( x, 0 ); + viewY = reinterpret( y, 0 ); + if ( strideX === 1 && strideY === 1 ) { + for ( i = 0; i < N*2; i += 2 ) { + viewY[ i ] = viewX[ i ]; + viewY[ i+1 ] = viewX[ i+1 ]; + } + return y; + } + if ( strideX < 0 ) { + ix = 2 * (1-N) * strideX; + } else { + ix = 0; + } + if ( strideY < 0 ) { + iy = 2 * (1-N) * strideY; + } else { + iy = 0; + } + sx = strideX * 2; + sy = strideY * 2; + for ( i = 0; i < N; i++ ) { + viewY[ iy ] = viewX[ ix ]; + viewY[ iy+1 ] = viewX[ ix+1 ]; + ix += sx; + iy += sy; + } + return y; +} + + +// EXPORTS // + +module.exports = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/lib/zcopy.native.js b/lib/node_modules/@stdlib/blas/base/zcopy/lib/zcopy.native.js new file mode 100644 index 00000000000..2ec16ad2987 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/lib/zcopy.native.js @@ -0,0 +1,68 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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' ); +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Complex128Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {Complex128Array} y - output array +* @param {integer} strideY - `y` stride length +* @returns {Complex128Array} output array +* +* @example +* var Complex128Array = require( '@stdlib/array/complex128' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var y = new Complex128Array( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); +* +* zcopy( x.length, x, 1, y, 1 ); +* +* var z = y.get( 0 ); +* // returns +* +* var re = real( z ); +* // returns 1.0 +* +* var im = imag( z ); +* // returns 2.0 +*/ +function zcopy( N, x, strideX, y, strideY ) { + var viewX = reinterpret( x, 0 ); + var viewY = reinterpret( y, 0 ); + addon( N, viewX, strideX, viewY, strideY ); + return y; +} + + +// EXPORTS // + +module.exports = zcopy; diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/manifest.json b/lib/node_modules/@stdlib/blas/base/zcopy/manifest.json new file mode 100644 index 00000000000..f4ba5cf9857 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/manifest.json @@ -0,0 +1,169 @@ +{ + "options": { + "os": "linux", + "blas": "", + "wasm": false + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "os": "linux", + "blas": "", + "wasm": false, + "src": [ + "./src/zcopy.f", + "./src/zcopy_f.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-complex128array" + ] + }, + { + "os": "linux", + "blas": "openblas", + "wasm": false, + "src": [ + "./src/zcopy_cblas.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lopenblas", + "-lpthread" + ], + "libpath": [], + "dependencies": [ + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-complex128array" + ] + }, + { + "os": "mac", + "blas": "", + "wasm": false, + "src": [ + "./src/zcopy.f", + "./src/zcopy_f.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-complex128array" + ] + }, + { + "os": "mac", + "blas": "apple_accelerate_framework", + "wasm": false, + "src": [ + "./src/zcopy_cblas.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lblas" + ], + "libpath": [], + "dependencies": [ + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-complex128array" + ] + }, + { + "os": "mac", + "blas": "openblas", + "wasm": false, + "src": [ + "./src/zcopy_cblas.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lopenblas", + "-lpthread" + ], + "libpath": [], + "dependencies": [ + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-complex128array" + ] + }, + { + "os": "win", + "blas": "", + "wasm": false, + "src": [ + "./src/zcopy.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-complex128array" + ] + }, + { + "os": "", + "blas": "", + "wasm": true, + "src": [ + "./src/zcopy.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/package.json b/lib/node_modules/@stdlib/blas/base/zcopy/package.json new file mode 100644 index 00000000000..b0287483b85 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/package.json @@ -0,0 +1,82 @@ +{ + "name": "@stdlib/blas/base/zcopy", + "version": "0.0.0", + "description": "Copy values from one complex double-precision floating-point vector to another complex double-precision floating-point vector.", + "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", + "gypfile": true, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "include": "./include", + "lib": "./lib", + "src": "./src", + "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", + "zcopy", + "copy", + "cp", + "vector", + "typed", + "array", + "ndarray", + "complex", + "complex128", + "float", + "float64", + "double", + "float64array" + ], + "__stdlib__": { + "wasm": false + } +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/src/Makefile b/lib/node_modules/@stdlib/blas/base/zcopy/src/Makefile new file mode 100644 index 00000000000..bcf18aa4665 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/src/addon.c b/lib/node_modules/@stdlib/blas/base/zcopy/src/addon.c new file mode 100644 index 00000000000..ed53665d5ec --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/src/addon.c @@ -0,0 +1,45 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/blas/base/zcopy.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_strided_complex128array.h" +#include + +/** +* Receives JavaScript callback invocation data. +* +* @private +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 5 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 4 ); + STDLIB_NAPI_ARGV_STRIDED_COMPLEX128ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_COMPLEX128ARRAY( env, Y, N, strideY, argv, 3 ); + c_zcopy( N, (void *)X, strideX, (void *)Y, strideY ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy.c b/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy.c new file mode 100644 index 00000000000..e137eab186d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy.c @@ -0,0 +1,64 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/blas/base/zcopy.h" + +/** +* Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +* +* @param N number of indexed elements +* @param X input array +* @param strideX X stride length +* @param Y output array +* @param strideY Y stride length +*/ +void c_zcopy( const int N, const void *X, const int strideX, void *Y, const int strideY ) { + double *x = (double *)X; + double *y = (double *)Y; + int ix; + int iy; + int i; + + if ( N <= 0 ) { + return; + } + if ( strideX == 1 && strideY == 1 ) { + for ( i = 0; i < N*2; i += 2 ) { + y[ i ] = x[ i ]; + y[ i+1 ] = x[ i+1 ]; + } + return; + } + if ( strideX < 0 ) { + ix = 2 * (1-N) * strideX; + } else { + ix = 0; + } + if ( strideY < 0 ) { + iy = 2 * (1-N) * strideY; + } else { + iy = 0; + } + for ( i = 0; i < N; i++ ) { + y[ iy ] = x[ ix ]; + y[ iy+1 ] = x[ ix+1 ]; + ix += strideX * 2; + iy += strideY * 2; + } + return; +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy.f b/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy.f new file mode 100644 index 00000000000..73d8751e076 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy.f @@ -0,0 +1,94 @@ +!> +! @license Apache-2.0 +! +! Copyright (c) 2024 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. +!< + +!> Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +! +! ## Notes +! +! * Modified version of reference BLAS level1 routine (version 3.9.0). Updated to "free form" Fortran 95. +! +! ## Authors +! +! * Univ. of Tennessee +! * Univ. of California Berkeley +! * Univ. of Colorado Denver +! * NAG Ltd. +! +! ## History +! +! * Jack Dongarra, linpack, 4/11/78. +! +! - modified 12/3/93, array(1) declarations changed to array(*) +! +! ## License +! +! From : +! +! > The reference BLAS is a freely-available software package. It is available from netlib via anonymous ftp and the World Wide Web. Thus, it can be included in commercial software packages (and has been). We only ask that proper credit be given to the authors. +! > +! > Like all software, it is copyrighted. It is not trademarked, but we do ask the following: +! > +! > * If you modify the source for these routines we ask that you change the name of the routine and comment the changes made to the original. +! > +! > * We will gladly answer any questions regarding the software. If a modification is done, however, it is the responsibility of the person who modified the routine to provide support. +! +! @param {integer} N - number of indexed elements +! @param {Array>} zx - input array +! @param {integer} strideX - `zx` stride length +! @param {Array>} zy - output array +! @param {integer} strideY - `zy` stride length +!< +subroutine zcopy( N, zx, strideX, zy, strideY ) + implicit none + ! .. + ! Scalar arguments: + integer :: strideX, strideY, N + ! .. + ! Array arguments: + complex(kind=kind(0.0d0)) :: zx(*), zy(*) + ! .. + ! Local scalars: + integer :: ix, iy, i + ! .. + if ( N <= 0 ) then + return + end if + ! .. + if ( strideX == 1 .AND. strideY == 1 ) then + do i = 1, N + zy( i ) = zx( i ) + end do + else + if ( strideX < 0 ) then + ix = ((1-N)*strideX) + 1 + else + ix = 1 + end if + if ( strideY < 0 ) then + iy = ((1-N)*strideY) + 1 + else + iy = 1 + end if + do i = 1, N + zy( iy ) = zx( ix ) + ix = ix + strideX + iy = iy + strideY + end do + end if + return +end subroutine zcopy diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy_cblas.c b/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy_cblas.c new file mode 100644 index 00000000000..603a63753a7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy_cblas.c @@ -0,0 +1,33 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/blas/base/zcopy.h" +#include "stdlib/blas/base/zcopy_cblas.h" + +/** +* Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +* +* @param N number of indexed elements +* @param X input array +* @param strideX X stride length +* @param Y output array +* @param strideY Y stride length +*/ +void c_zcopy( const int N, const void *X, const int strideX, void *Y, const int strideY ) { + cblas_zcopy( N, X, strideX, Y, strideY ); +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy_f.c b/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy_f.c new file mode 100644 index 00000000000..eb3b3c5dc8a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/src/zcopy_f.c @@ -0,0 +1,33 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/blas/base/zcopy.h" +#include "stdlib/blas/base/zcopy_fortran.h" + +/** +* Copies values from one complex double-precision floating-point vector to another complex double-precision floating-point vector. +* +* @param N number of indexed elements +* @param X input array +* @param strideX X stride length +* @param Y output array +* @param strideY Y stride length +*/ +void c_zcopy( const int N, const void *X, const int strideX, void *Y, const int strideY ) { + zcopy( &N, X, &strideX, Y, &strideY ); +} diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/test/test.js b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.js new file mode 100644 index 00000000000..5c71bdb7330 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 zcopy = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': isBrowser +}; + + +// 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( 'attached to the main export is a method providing an ndarray interface', function test( t ) { + t.strictEqual( typeof zcopy.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 zcopy = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( zcopy, 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 zcopy; + var main; + + main = require( './../lib/zcopy.js' ); + + zcopy = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( zcopy, main, 'returns JavaScript implementation' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.ndarray.js new file mode 100644 index 00000000000..6e38840139d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.ndarray.js @@ -0,0 +1,361 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 Float64Array = require( '@stdlib/array/float64' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var zcopy = require( './../lib/ndarray.js' ); + + +// 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 7', function test( t ) { + t.strictEqual( zcopy.length, 7, 'arity of 7' ); + t.end(); +}); + +tape( 'the function copies elements from `x` into `y`', function test( t ) { + var viewX; + var viewY; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 7.0, 8.0 ] ); + + zcopy( x.length, x, 1, 0, y, 1, 0 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewX, viewY, 'returns expected value' ); + t.notEqual( y, x, 'different references' ); + + t.end(); +}); + +tape( 'the function supports an `x` stride', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, + 4.0, + 5.0, // 2 + 6.0, // 2 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 2, 0, y, 1, 0 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 5.0, 6.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` offset', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, + 2.0, + 3.0, + 4.0, + 5.0, // 1 + 6.0, // 1 + 7.0, // 2 + 8.0 // 2 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 1, 2, y, 1, 0 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 5.0, 6.0, 7.0, 8.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0, // 2 + 5.0, + 6.0, + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0, + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 1, 0, y, 2, 0 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` offset', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0, // 2 + 5.0, + 6.0, + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0 // 2 + ]); + N = 2; + + zcopy( N, x, 1, 0, y, 1, 2 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the output array', function test( t ) { + var out; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + out = zcopy( x.length, x, 1, 0, y, 1, 0 ); + + t.strictEqual( out, y, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', function test( t ) { + var expected; + var viewY; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + zcopy( -1, x, 1, 0, y, 1, 0 ); + t.deepEqual( viewY, expected, 'returns expected value' ); + + zcopy( 0, x, 1, 0, y, 1, 0 ); + t.deepEqual( viewY, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports negative strides', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 2 + 2.0, // 2 + 3.0, + 4.0, + 5.0, // 1 + 6.0, // 1 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, + 0.0, + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, -2, x.length-2, y, -1, y.length-2 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 1.0, 2.0, 5.0, 6.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, + 2.0, + 3.0, // 1 + 4.0, // 1 + 5.0, + 6.0, + 7.0, // 2 + 8.0 // 2 + ]); + y = new Complex128Array([ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0 // 1 + ]); + N = 2; + + zcopy( N, x, 2, 1, y, -1, y.length-1 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if both strides are equal to `1`, the function efficiently copies elements from `x` into `y`', function test( t ) { + var viewX; + var viewY; + var x; + var y; + var i; + + x = new Complex128Array( 100 ); + y = new Complex128Array( x.length ); + for ( i = 0; i < x.length; i++ ) { + x.set( [ i, i ], i ); + } + + zcopy( x.length, x, 1, 0, y, 1, 0 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewY, viewX, 'returns expected value' ); + t.notEqual( viewY, viewX, 'different references' ); + + x = new Complex128Array( 120 ); + y = new Complex128Array( x.length ); + for ( i = 0; i < x.length; i++ ) { + x.set( [ i*2, i*2 ], i ); + } + + zcopy( x.length, x, 1, 0, y, 1, 0 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewY, viewX, 'returns expected value' ); + t.notEqual( viewY, viewX, 'different references' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.ndarray.native.js new file mode 100644 index 00000000000..e1796fb811d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.ndarray.native.js @@ -0,0 +1,370 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var zcopy = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( zcopy instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, 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 7', opts, function test( t ) { + t.strictEqual( zcopy.length, 7, 'arity of 7' ); + t.end(); +}); + +tape( 'the function copies elements from `x` into `y`', opts, function test( t ) { + var viewX; + var viewY; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 7.0, 8.0 ] ); + + zcopy( x.length, x, 1, 0, y, 1, 0 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewX, viewY, 'returns expected value' ); + t.notEqual( y, x, 'different references' ); + + t.end(); +}); + +tape( 'the function supports an `x` stride', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, + 4.0, + 5.0, // 2 + 6.0, // 2 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 2, 0, y, 1, 0 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 5.0, 6.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an `x` offset', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, + 2.0, + 3.0, + 4.0, + 5.0, // 1 + 6.0, // 1 + 7.0, // 2 + 8.0 // 2 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 1, 2, y, 1, 0 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 5.0, 6.0, 7.0, 8.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0, // 2 + 5.0, + 6.0, + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0, + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 1, 0, y, 2, 0 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` offset', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0, // 2 + 5.0, + 6.0, + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0 // 2 + ]); + N = 2; + + zcopy( N, x, 1, 0, y, 1, 2 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the output array', opts, function test( t ) { + var out; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + out = zcopy( x.length, x, 1, 0, y, 1, 0 ); + + t.strictEqual( out, y, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + zcopy( -1, x, 1, 0, y, 1, 0 ); + t.deepEqual( viewY, expected, 'returns expected value' ); + + zcopy( 0, x, 1, 0, y, 1, 0 ); + t.deepEqual( viewY, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports negative strides', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 2 + 2.0, // 2 + 3.0, + 4.0, + 5.0, // 1 + 6.0, // 1 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, + 0.0, + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, -2, x.length-2, y, -1, y.length-2 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 1.0, 2.0, 5.0, 6.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, + 2.0, + 3.0, // 1 + 4.0, // 1 + 5.0, + 6.0, + 7.0, // 2 + 8.0 // 2 + ]); + y = new Complex128Array([ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0 // 1 + ]); + N = 2; + + zcopy( N, x, 2, 1, y, -1, y.length-1 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if both strides are equal to `1`, the function efficiently copies elements from `x` into `y`', opts, function test( t ) { + var viewX; + var viewY; + var x; + var y; + var i; + + x = new Complex128Array( 100 ); + y = new Complex128Array( x.length ); + for ( i = 0; i < x.length; i++ ) { + x.set( [ i, i ], i ); + } + + zcopy( x.length, x, 1, 0, y, 1, 0 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewY, viewX, 'returns expected value' ); + t.notEqual( viewY, viewX, 'different references' ); + + x = new Complex128Array( 120 ); + y = new Complex128Array( x.length ); + for ( i = 0; i < x.length; i++ ) { + x.set( [ i*2, i*2 ], i ); + } + + zcopy( x.length, x, 1, 0, y, 1, 0 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewY, viewX, 'returns expected value' ); + t.notEqual( viewY, viewX, 'different references' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/test/test.zcopy.js b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.zcopy.js new file mode 100644 index 00000000000..9022309f2a5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.zcopy.js @@ -0,0 +1,331 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 Float64Array = require( '@stdlib/array/float64' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var zcopy = require( './../lib/zcopy.js' ); + + +// 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 5', function test( t ) { + t.strictEqual( zcopy.length, 5, 'arity of 5' ); + t.end(); +}); + +tape( 'the function copies elements from `x` into `y`', function test( t ) { + var viewX; + var viewY; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 7.0, 8.0 ] ); + + zcopy( x.length, x, 1, y, 1 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewX, viewY, 'returns expected value' ); + t.notEqual( y, x, 'different references' ); + + t.end(); +}); + +tape( 'the function supports an `x` stride', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, + 4.0, + 5.0, // 2 + 6.0, // 2 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 2, y, 1 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 5.0, 6.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0, // 2 + 5.0, + 6.0, + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0, + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 1, y, 2 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the output array', function test( t ) { + var out; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + out = zcopy( x.length, x, 1, y, 1 ); + + t.strictEqual( out, y, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', function test( t ) { + var expected; + var viewY; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + zcopy( -1, x, 1, y, 1 ); + t.deepEqual( viewY, expected, 'returns expected value' ); + + zcopy( 0, x, 1, y, 1 ); + t.deepEqual( viewY, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports negative strides', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 2 + 2.0, // 2 + 3.0, + 4.0, + 5.0, // 1 + 6.0, // 1 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, -2, y, -1 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 5.0, 6.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, + 4.0, + 5.0, // 2 + 6.0, // 2 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 2, y, -1 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var expected; + var viewY; + var x0; + var y0; + var x1; + var y1; + var N; + + // Initial arrays... + x0 = new Complex128Array([ + 1.0, + 2.0, + 3.0, // 2 + 4.0, // 2 + 5.0, + 6.0, + 7.0, // 1 + 8.0 // 1 + ]); + y0 = new Complex128Array([ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0 // 2 + ]); + + // Create offset views... + x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // begin at 2nd element + y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // begin at the 3rd element + + N = 2; + + zcopy( N, x1, -2, y1, 1 ); + + viewY = new Float64Array( y0.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if both strides are equal to `1`, the function efficiently copies elements from `x` into `y`', function test( t ) { + var viewX; + var viewY; + var x; + var y; + var i; + + x = new Complex128Array( 100 ); + y = new Complex128Array( x.length ); + for ( i = 0; i < x.length; i++ ) { + x.set( [ i, i ], i ); + } + + zcopy( x.length, x, 1, y, 1 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewY, viewX, 'returns expected value' ); + t.notEqual( viewY, viewX, 'different references' ); + + x = new Complex128Array( 120 ); + y = new Complex128Array( x.length ); + for ( i = 0; i < x.length; i++ ) { + x.set( [ i*2, i*2 ], i ); + } + + zcopy( x.length, x, 1, y, 1 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewY, viewX, 'returns expected value' ); + t.notEqual( viewY, viewX, 'different references' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/zcopy/test/test.zcopy.native.js b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.zcopy.native.js new file mode 100644 index 00000000000..43339685937 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/zcopy/test/test.zcopy.native.js @@ -0,0 +1,340 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Complex128Array = require( '@stdlib/array/complex128' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var zcopy = tryRequire( resolve( __dirname, './../lib/zcopy.native.js' ) ); +var opts = { + 'skip': ( zcopy instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, 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 5', opts, function test( t ) { + t.strictEqual( zcopy.length, 5, 'arity of 5' ); + t.end(); +}); + +tape( 'the function copies elements from `x` into `y`', opts, function test( t ) { + var viewX; + var viewY; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 7.0, 8.0 ] ); + + zcopy( x.length, x, 1, y, 1 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewX, viewY, 'returns expected value' ); + t.notEqual( y, x, 'different references' ); + + t.end(); +}); + +tape( 'the function supports an `x` stride', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, + 4.0, + 5.0, // 2 + 6.0, // 2 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 2, y, 1 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 5.0, 6.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `y` stride', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, // 2 + 4.0, // 2 + 5.0, + 6.0, + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0, + 0.0, // 2 + 0.0, // 2 + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 1, y, 2 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 0.0, 0.0, 3.0, 4.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the output array', opts, function test( t ) { + var out; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + out = zcopy( x.length, x, 1, y, 1 ); + + t.strictEqual( out, y, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + + x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + y = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + zcopy( -1, x, 1, y, 1 ); + t.deepEqual( viewY, expected, 'returns expected value' ); + + zcopy( 0, x, 1, y, 1 ); + t.deepEqual( viewY, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports negative strides', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 2 + 2.0, // 2 + 3.0, + 4.0, + 5.0, // 1 + 6.0, // 1 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, -2, y, -1 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 1.0, 2.0, 5.0, 6.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns', opts, function test( t ) { + var expected; + var viewY; + var x; + var y; + var N; + + x = new Complex128Array([ + 1.0, // 1 + 2.0, // 1 + 3.0, + 4.0, + 5.0, // 2 + 6.0, // 2 + 7.0, + 8.0 + ]); + y = new Complex128Array([ + 0.0, // 2 + 0.0, // 2 + 0.0, // 1 + 0.0, // 1 + 0.0, + 0.0, + 0.0, + 0.0 + ]); + N = 2; + + zcopy( N, x, 2, y, -1 ); + + viewY = new Float64Array( y.buffer ); + expected = new Float64Array( [ 5.0, 6.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var expected; + var viewY; + var x0; + var y0; + var x1; + var y1; + var N; + + // Initial arrays... + x0 = new Complex128Array([ + 1.0, + 2.0, + 3.0, // 2 + 4.0, // 2 + 5.0, + 6.0, + 7.0, // 1 + 8.0 // 1 + ]); + y0 = new Complex128Array([ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, // 1 + 0.0, // 1 + 0.0, // 2 + 0.0 // 2 + ]); + + // Create offset views... + x1 = new Complex128Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // begin at 2nd element + y1 = new Complex128Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // begin at the 3rd element + + N = 2; + + zcopy( N, x1, -2, y1, 1 ); + + viewY = new Float64Array( y0.buffer ); + expected = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 7.0, 8.0, 3.0, 4.0 ] ); + + t.deepEqual( viewY, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if both strides are equal to `1`, the function efficiently copies elements from `x` into `y`', opts, function test( t ) { + var viewX; + var viewY; + var x; + var y; + var i; + + x = new Complex128Array( 100 ); + y = new Complex128Array( x.length ); + for ( i = 0; i < x.length; i++ ) { + x.set( [ i, i ], i ); + } + + zcopy( x.length, x, 1, y, 1 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewY, viewX, 'returns expected value' ); + t.notEqual( viewY, viewX, 'different references' ); + + x = new Complex128Array( 120 ); + y = new Complex128Array( x.length ); + for ( i = 0; i < x.length; i++ ) { + x.set( [ i*2, i*2 ], i ); + } + + zcopy( x.length, x, 1, y, 1 ); + + viewX = new Float64Array( x.buffer ); + viewY = new Float64Array( y.buffer ); + + t.deepEqual( viewY, viewX, 'returns expected value' ); + t.notEqual( viewY, viewX, 'different references' ); + + t.end(); +});