From d2003ceecc0fb9a957c971858732921d98d1096a Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Sun, 15 Sep 2024 20:13:35 -0700 Subject: [PATCH 1/3] docs: update list of contributors PR-URL: https://github.com/stdlib-js/stdlib/pull/2902 Reviewed-by: Athan Reines Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Co-authored-by: Philipp Burckhardt --- CONTRIBUTORS | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 8610d916f33..ecfde1e276b 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -2,6 +2,7 @@ # # Contributors listed in alphabetical order. +Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Adarsh Palaskar Aditya Sapra AgPriyanshu18 <113460573+AgPriyanshu18@users.noreply.github.com> From fadff3a44660678d9ccce8bb101f579ca1913a64 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Mon, 16 Sep 2024 08:14:05 +0500 Subject: [PATCH 2/3] feat: add `blas/ext/base/cfill` PR-URL: https://github.com/stdlib-js/stdlib/pull/2901 Co-authored-by: Athan Reines Reviewed-by: Athan Reines --- .../@stdlib/blas/ext/base/cfill/README.md | 281 ++++++++++++++++++ .../ext/base/cfill/benchmark/benchmark.js | 106 +++++++ .../base/cfill/benchmark/benchmark.native.js | 116 ++++++++ .../base/cfill/benchmark/benchmark.ndarray.js | 111 +++++++ .../benchmark/benchmark.ndarray.native.js | 116 ++++++++ .../blas/ext/base/cfill/benchmark/c/Makefile | 146 +++++++++ .../base/cfill/benchmark/c/benchmark.length.c | 153 ++++++++++ .../@stdlib/blas/ext/base/cfill/binding.gyp | 170 +++++++++++ .../@stdlib/blas/ext/base/cfill/docs/repl.txt | 135 +++++++++ .../blas/ext/base/cfill/docs/types/index.d.ts | 137 +++++++++ .../blas/ext/base/cfill/docs/types/test.ts | 202 +++++++++++++ .../blas/ext/base/cfill/examples/c/Makefile | 146 +++++++++ .../blas/ext/base/cfill/examples/c/example.c | 43 +++ .../blas/ext/base/cfill/examples/index.js | 34 +++ .../@stdlib/blas/ext/base/cfill/include.gypi | 53 ++++ .../include/stdlib/blas/ext/base/cfill.h | 41 +++ .../@stdlib/blas/ext/base/cfill/lib/cfill.js | 68 +++++ .../blas/ext/base/cfill/lib/cfill.native.js | 70 +++++ .../@stdlib/blas/ext/base/cfill/lib/index.js | 74 +++++ .../@stdlib/blas/ext/base/cfill/lib/main.js | 35 +++ .../@stdlib/blas/ext/base/cfill/lib/native.js | 35 +++ .../blas/ext/base/cfill/lib/ndarray.js | 139 +++++++++ .../blas/ext/base/cfill/lib/ndarray.native.js | 74 +++++ .../@stdlib/blas/ext/base/cfill/manifest.json | 79 +++++ .../@stdlib/blas/ext/base/cfill/package.json | 78 +++++ .../@stdlib/blas/ext/base/cfill/src/Makefile | 70 +++++ .../@stdlib/blas/ext/base/cfill/src/addon.c | 45 +++ .../@stdlib/blas/ext/base/cfill/src/main.c | 72 +++++ .../blas/ext/base/cfill/test/test.cfill.js | 212 +++++++++++++ .../ext/base/cfill/test/test.cfill.native.js | 221 ++++++++++++++ .../@stdlib/blas/ext/base/cfill/test/test.js | 82 +++++ .../blas/ext/base/cfill/test/test.ndarray.js | 209 +++++++++++++ .../base/cfill/test/test.ndarray.native.js | 218 ++++++++++++++ 33 files changed, 3771 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/binding.gyp create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/include.gypi create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/include/stdlib/blas/ext/base/cfill.h create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/lib/native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/src/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/src/addon.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/src/main.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.cfill.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.cfill.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/README.md b/lib/node_modules/@stdlib/blas/ext/base/cfill/README.md new file mode 100644 index 00000000000..c0950f0f443 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/README.md @@ -0,0 +1,281 @@ + + +# cfill + +> Fill a single-precision complex floating-point strided array with a specified scalar constant. + +
+ +## Usage + +```javascript +var cfill = require( '@stdlib/blas/ext/base/cfill' ); +``` + +#### cfill( N, alpha, x, stride ) + +Fills a single-precision complex floating-point strided array `x` with a specified scalar constant `alpha`. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +var x = new Complex64Array( arr ); + +var alpha = new Complex64( 10.0, 10.0 ); + +cfill( x.length, alpha, x, 1 ); + +var y = x.get( 0 ); +// returns + +var re = realf( y ); +// returns 10.0 + +var im = imagf( y ); +// returns 10.0 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **alpha**: scalar constant. +- **x**: input [`Complex64Array`][@stdlib/array/complex64]. +- **stride**: index increment. + +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to fill every other element + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +var x = new Complex64Array( arr ); + +var alpha = new Complex64( 10.0, 10.0 ); + +cfill( 2, alpha, x, 2 ); + +var y = x.get( 0 ); +// returns + +var re = realf( y ); +// returns 10.0 + +var im = imagf( y ); +// returns 10.0 + +y = x.get( 1 ); +// returns + +re = realf( y ); +// returns 3.0 + +im = imagf( y ); +// returns 4.0 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +// Create the underlying floating-point array +var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + +// Initial array: +var x0 = new Complex64Array( arr ); + +// Create an offset view: +var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +// Define a scalar constant: +var alpha = new Complex64( 10.0, 10.0 ); + +// Fill every other element: +cfill( 2, alpha, x1, 2 ); + +var y = x0.get( 0 ); +// returns + +var re = realf( y ); +// returns 1.0 + +var im = imagf( y ); +// returns 2.0 + +y = x0.get( 1 ); +// returns + +re = realf( y ); +// returns 10.0 + +im = imagf( y ); +// returns 10.0 +``` + +#### cfill.ndarray( N, alpha, x, stride, offset ) + +Fills a single-precision complex floating-point strided array `x` with a specified scalar constant `alpha` using alternative indexing semantics. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +var x = new Complex64Array( arr ); + +var alpha = new Complex64( 10.0, 10.0 ); + +cfill.ndarray( x.length, alpha, x, 1, 0 ); + +var y = x.get( 0 ); +// returns + +var re = realf( y ); +// returns 10.0 + +var im = imagf( y ); +// returns 10.0 +``` + +The function has the following additional parameters: + +- **offset**: starting index. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last two elements of the strided array + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + +var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var x = new Complex64Array( arr ); + +var alpha = new Complex64( 10.0, 10.0 ); + +cfill.ndarray( 2, alpha, x, 1, x.length-2 ); + +var y = x.get( 0 ); +// returns + +var re = realf( y ); +// returns 1.0 + +var im = imagf( y ); +// returns 2.0 + +y = x.get( 1 ); +// returns + +re = realf( y ); +// returns 10.0 + +im = imagf( y ); +// returns 10.0 + +y = x.get( 2 ); +// returns + +re = realf( y ); +// returns 10.0 + +im = imagf( y ); +// returns 10.0 +``` + +
+ + + +
+ +## Notes + +- If `N <= 0`, both functions return the strided array unchanged. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var cfill = require( '@stdlib/blas/ext/base/cfill' ); + +function rand() { + return new Complex64( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); +} + +var x = filledarrayBy( 10, 'complex64', rand ); +var alpha = new Complex64( 10.0, 10.0 ); + +cfill( x.length, alpha, x, 1 ); +console.log( x.get( 0 ).toString() ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64 + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + +
+ + diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.js new file mode 100644 index 00000000000..17fb92dfb71 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.js @@ -0,0 +1,106 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var pkg = require( './../package.json' ).name; +var cfill = require( './../lib/cfill.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Create a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var z; + var x; + + xbuf = uniform( len*2, -100.0, 100.0, options ); + x = new Complex64Array( xbuf.buffer ); + + z = new Complex64( 1.0, 0.0 ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + cfill( x.length, z, x, 1 ); + if ( isnanf( xbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( xbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +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/ext/base/cfill/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.native.js new file mode 100644 index 00000000000..f6e4486141e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.native.js @@ -0,0 +1,116 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var cfill = tryRequire( resolve( __dirname, './../lib/cfill.native.js' ) ); +var opts = { + 'skip': ( cfill instanceof Error ) +}; +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var z; + var x; + + xbuf = uniform( len*2, -100.0, 100.0, options ); + x = new Complex64Array( xbuf.buffer ); + + z = new Complex64( 1.0, 0.0 ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + cfill( x.length, z, x, 1 ); + if ( isnanf( xbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( xbuf[ 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/ext/base/cfill/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.ndarray.js new file mode 100644 index 00000000000..fdeb25d39f9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.ndarray.js @@ -0,0 +1,111 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var pkg = require( './../package.json' ).name; +var cfill = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var z; + var x; + + xbuf = uniform( len*2, -100.0, 100.0, options ); + x = new Complex64Array( xbuf.buffer ); + + z = new Complex64( 1.0, 0.0 ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + cfill( x.length, z, x, 1, 0 ); + if ( isnanf( xbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( xbuf[ 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/ext/base/cfill/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.ndarray.native.js new file mode 100644 index 00000000000..acab1b9a636 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,116 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var cfill = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( cfill instanceof Error ) +}; +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var xbuf; + var z; + var x; + + xbuf = uniform( len*2, -100.0, 100.0, options ); + x = new Complex64Array( xbuf.buffer ); + + z = new Complex64( 1.0, 0.0 ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + cfill( x.length, z, x, 1, 0 ); + if ( isnanf( xbuf[ i%(len*2) ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( xbuf[ 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/ext/base/cfill/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/Makefile new file mode 100644 index 00000000000..9f97140e7cb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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 includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# 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/ext/base/cfill/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/benchmark.length.c new file mode 100644 index 00000000000..8d48e0ed954 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/benchmark/c/benchmark.length.c @@ -0,0 +1,153 @@ +/* +* @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/ext/base/cfill.h" +#include "stdlib/complex/float32/ctor.h" +#include +#include +#include +#include +#include + +#define NAME "cfill" +#define ITERATIONS 10000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* Prints the TAP version. +*/ +static 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 +*/ +static 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 +*/ +static 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 +*/ +static 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 +*/ +static float rand_float( void ) { + int r = rand(); + return (float)r / ( (float)RAND_MAX + 1.0f ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark( int iterations, int len ) { + stdlib_complex64_t alpha; + float x[ len*2 ]; + double elapsed; + double t; + int i; + + alpha = stdlib_complex64( 1.0f, 0.0f ); + for ( i = 0; i < len*2; i += 2 ) { + x[ i ] = ( rand_float()*2.0f ) - 1.0f; + x[ i+1 ] = ( rand_float()*2.0f ) - 1.0f; + } + t = tic(); + for ( i = 0; i < iterations; i++ ) { + c_cfill( len, alpha, (stdlib_complex64_t *)x, 1 ); + if ( x[ 0 ] != x[ 0 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( x[ 0 ] != x[ 0 ] ) { + printf( "should not return NaN\n" ); + } + 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/ext/base/cfill/binding.gyp b/lib/node_modules/@stdlib/blas/ext/base/cfill/binding.gyp new file mode 100644 index 00000000000..ec399223344 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/binding.gyp @@ -0,0 +1,170 @@ +# @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', + + # 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 + }, # 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/ext/base/cfill/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/repl.txt new file mode 100644 index 00000000000..eed8feb75e1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/repl.txt @@ -0,0 +1,135 @@ + +{{alias}}( N, alpha, x, stride ) + Fills a single-precision complex floating-point strided array with a + specified scalar constant. + + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `N <= 0`, the function returns `x` unchanged. + + Parameters + ---------- + N: integer + Number of indexed elements. + + alpha: Complex64 + Constant. + + x: Complex64Array + Input array. + + stride: integer + Index increment. + + Returns + ------- + x: Complex64Array + Input array. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > var alpha = new {{alias:@stdlib/complex/float32/ctor}}( 5.0, -5.0 ); + > {{alias}}( x.length, alpha, x, 1 ); + > var z = x.get( 0 ); + > var re = {{alias:@stdlib/complex/float32/real}}( z ) + 5.0 + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) + -5.0 + + // Using `N` and stride parameters: + > var x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > var alpha = new {{alias:@stdlib/complex/float32/ctor}}( 5.0, -5.0 ); + > {{alias}}( 2, alpha, x, 2 ); + > var z = x.get( 0 ); + > var re = {{alias:@stdlib/complex/float32/real}}( z ) + 5.0 + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) + -5.0 + > z = x.get( 1 ); + > re = {{alias:@stdlib/complex/float32/real}}( z ) + 3.0 + > im = {{alias:@stdlib/complex/float32/imag}}( z ) + 4.0 + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + > var x1 = new {{alias:@stdlib/array/complex64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > var alpha = new {{alias:@stdlib/complex/float32/ctor}}( 5.0, -5.0 ); + > {{alias}}( 2, alpha, x1, 1 ); + > var z = x0.get( 0 ); + > var re = {{alias:@stdlib/complex/float32/real}}( z ) + 1.0 + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) + 2.0 + > z = x0.get( 1 ); + > re = {{alias:@stdlib/complex/float32/real}}( z ) + 5.0 + > im = {{alias:@stdlib/complex/float32/imag}}( z ) + -5.0 + + +{{alias}}.ndarray( N, alpha, x, stride, offset ) + Fills a single-precision complex floating-point strided array with a + specified scalar constant using alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameter supports indexing semantics based on a starting + index. + + Parameters + ---------- + N: integer + Number of indexed elements. + + alpha: Complex64 + Constant. + + x: Complex64Array + Input array. + + stride: integer + Index increment. + + offset: integer + Starting index. + + Returns + ------- + x: Complex64Array + Input array. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > var alpha = new {{alias:@stdlib/complex/float32/ctor}}( 2.0, 2.0 ); + > {{alias}}.ndarray( x.length, alpha, x, 1, 0 ); + > var z = x.get( 0 ); + > var re = {{alias:@stdlib/complex/float32/real}}( z ) + 2.0 + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) + 2.0 + + // Using an index offset: + > var x = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + > var alpha = new {{alias:@stdlib/complex/float32/ctor}}( 5.0, -5.0 ); + > {{alias}}.ndarray( 2, alpha, x, 2, 1 ); + > var z = x.get( 0 ); + > var re = {{alias:@stdlib/complex/float32/real}}( z ) + 1.0 + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) + 2.0 + > z = x.get( 1 ); + > re = {{alias:@stdlib/complex/float32/real}}( z ) + 5.0 + > im = {{alias:@stdlib/complex/float32/imag}}( z ) + -5.0 + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/index.d.ts new file mode 100644 index 00000000000..0104f16827a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/index.d.ts @@ -0,0 +1,137 @@ +/* +* @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 { Complex64Array } from '@stdlib/types/array'; +import { Complex64 } from '@stdlib/types/complex'; + +/** +* Interface describing `cfill`. +*/ +interface Routine { + /** + * Fills a single-precision complex floating-point strided array with a specified scalar constant. + * + * @param N - number of indexed elements + * @param alpha - scalar constant + * @param x - input array + * @param stride - stride length + * @returns input array + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * var Complex64Array = require( '@stdlib/array/complex64' ); + * var Complex64 = require( '@stdlib/complex/float32/ctor' ); + * var realf = require( '@stdlib/complex/float32/real' ); + * var imagf = require( '@stdlib/complex/float32/imag' ); + * + * var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + * var x = new Complex64Array( arr ); + * + * var alpha = new Complex64( 10.0, 10.0 ); + * + * cfill( x.length, alpha, x, 1 ); + * + * var y = x.get( 0 ); + * // returns + * + * var re = realf( y ); + * // returns 10.0 + * + * var im = imagf( y ); + * // returns 10.0 + */ + ( N: number, alpha: Complex64, x: Complex64Array, stride: number ): Complex64Array; + + /** + * Fills a single-precision complex floating-point strided array with a specified scalar constant. + * + * @param N - number of indexed elements + * @param alpha - scalar constant + * @param x - input array + * @param stride - stride length + * @param offset - starting index + * @returns input array + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * var Complex64Array = require( '@stdlib/array/complex64' ); + * var Complex64 = require( '@stdlib/complex/float32/ctor' ); + * var realf = require( '@stdlib/complex/float32/real' ); + * var imagf = require( '@stdlib/complex/float32/imag' ); + * + * var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); + * var x = new Complex64Array( arr ); + * + * var alpha = new Complex64( 10.0, 10.0 ); + * + * cfill( x.length, alpha, x, 1, 0 ); + * + * var y = x.get( 0 ); + * // returns + * + * var re = realf( y ); + * // returns 10.0 + * + * var im = imagf( y ); + * // returns 10.0 + */ + ndarray( N: number, alpha: Complex64, x: Complex64Array, stride: number, offset: number ): Complex64Array; +} + +/** +* Fills a single-precision complex floating-point strided array with a specified scalar constant. +* +* @param N - number of indexed elements +* @param alpha - scalar constant +* @param x - input array +* @param stride - index increment +* @returns input array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* +* var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +* var x = new Complex64Array( arr ); +* +* var alpha = new Complex64( 10.0, 10.0 ); +* +* cfill( x.length, alpha, x, 1 ); +* +* var y = x.get( 0 ); +* // returns +* +* var re = realf( y ); +* // returns 10.0 +* +* var im = imagf( y ); +* // returns 10.0 +*/ +declare var cfill: Routine; + + +// EXPORTS // + +export = cfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/test.ts new file mode 100644 index 00000000000..a36a60ae714 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/docs/types/test.ts @@ -0,0 +1,202 @@ +/* +* @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 Complex64Array = require( '@stdlib/array/complex64' ); +import Complex64 = require( '@stdlib/complex/float32/ctor' ); +import cfill = require( './index' ); + + +// TESTS // + +// The function returns a Complex64Array... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill( x.length, alpha, x, 1 ); // $ExpectType Complex64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill( '10', alpha, x, 1 ); // $ExpectError + cfill( true, alpha, x, 1 ); // $ExpectError + cfill( false, alpha, x, 1 ); // $ExpectError + cfill( null, alpha, x, 1 ); // $ExpectError + cfill( undefined, alpha, x, 1 ); // $ExpectError + cfill( [], alpha, x, 1 ); // $ExpectError + cfill( {}, alpha, x, 1 ); // $ExpectError + cfill( ( x: number ): number => x, alpha, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not complex-like... +{ + const x = new Complex64Array( 10 ); + + cfill( x.length, 10, x, 1 ); // $ExpectError + cfill( x.length, '10', x, 1 ); // $ExpectError + cfill( x.length, true, x, 1 ); // $ExpectError + cfill( x.length, false, x, 1 ); // $ExpectError + cfill( x.length, null, x, 1 ); // $ExpectError + cfill( x.length, undefined, x, 1 ); // $ExpectError + cfill( x.length, [ '1' ], x, 1 ); // $ExpectError + cfill( x.length, {}, x, 1 ); // $ExpectError + cfill( x.length, ( x: number ): number => x, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a Complex64Array... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill( x.length, alpha, 10, 1 ); // $ExpectError + cfill( x.length, alpha, '10', 1 ); // $ExpectError + cfill( x.length, alpha, true, 1 ); // $ExpectError + cfill( x.length, alpha, false, 1 ); // $ExpectError + cfill( x.length, alpha, null, 1 ); // $ExpectError + cfill( x.length, alpha, undefined, 1 ); // $ExpectError + cfill( x.length, alpha, [ '1' ], 1 ); // $ExpectError + cfill( x.length, alpha, {}, 1 ); // $ExpectError + cfill( x.length, alpha, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill( x.length, alpha, x, '10' ); // $ExpectError + cfill( x.length, alpha, x, true ); // $ExpectError + cfill( x.length, alpha, x, false ); // $ExpectError + cfill( x.length, alpha, x, null ); // $ExpectError + cfill( x.length, alpha, x, undefined ); // $ExpectError + cfill( x.length, alpha, x, [] ); // $ExpectError + cfill( x.length, alpha, x, {} ); // $ExpectError + cfill( x.length, alpha, x, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill(); // $ExpectError + cfill( x.length ); // $ExpectError + cfill( x.length, alpha ); // $ExpectError + cfill( x.length, alpha, x ); // $ExpectError + cfill( x.length, alpha, x, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Complex64Array... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill.ndarray( x.length, alpha, x, 1, 0 ); // $ExpectType Complex64Array +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill.ndarray( '10', alpha, x, 1, 0 ); // $ExpectError + cfill.ndarray( true, alpha, x, 1, 0 ); // $ExpectError + cfill.ndarray( false, alpha, x, 1, 0 ); // $ExpectError + cfill.ndarray( null, alpha, x, 1, 0 ); // $ExpectError + cfill.ndarray( undefined, alpha, x, 1, 0 ); // $ExpectError + cfill.ndarray( [], alpha, x, 1, 0 ); // $ExpectError + cfill.ndarray( {}, alpha, x, 1, 0 ); // $ExpectError + cfill.ndarray( ( x: number ): number => x, alpha, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not complex-like... +{ + const x = new Complex64Array( 10 ); + + cfill.ndarray( x.length, 10, x, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, '10', x, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, true, x, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, false, x, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, null, x, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, undefined, x, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, [ '1' ], x, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, {}, x, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, ( x: number ): number => x, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a Complex64Array... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill.ndarray( x.length, alpha, 10, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, '10', 1, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, true, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, false, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, null, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, undefined, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, [ '1' ], 1, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, {}, 1, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, ( x: number ): number => x, 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 Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill.ndarray( x.length, alpha, x, '10', 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, x, true, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, x, false, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, x, null, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, x, undefined, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, x, [], 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, x, {}, 0 ); // $ExpectError + cfill.ndarray( x.length, alpha, x, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number... +{ + const x = new Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill.ndarray( x.length, alpha, x, 1, '10' ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 1, true ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 1, false ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 1, null ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 1, undefined ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 1, [] ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 1, {} ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 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 Complex64Array( 10 ); + const alpha = new Complex64( 2.0, 2.0 ); + + cfill.ndarray(); // $ExpectError + cfill.ndarray( x.length ); // $ExpectError + cfill.ndarray( x.length, alpha ); // $ExpectError + cfill.ndarray( x.length, alpha, x ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 1 ); // $ExpectError + cfill.ndarray( x.length, alpha, x, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/examples/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/cfill/examples/c/Makefile new file mode 100644 index 00000000000..6aed70daf16 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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 includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @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/ext/base/cfill/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/cfill/examples/c/example.c new file mode 100644 index 00000000000..a87ae432c0d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/examples/c/example.c @@ -0,0 +1,43 @@ +/** +* @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/complex/float32/ctor.h" +#include "stdlib/blas/ext/base/cfill.h" +#include + +int main() { + // Create a strided array of interleaved real and imaginary components: + float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; + + // Create a scalar constant: + const stdlib_complex64_t alpha = stdlib_complex64( 2.0f, 2.0f ); + + // Specify the number of elements: + const int N = 4; + + // Specify a stride: + const int stride = 1; + + // Fill the array: + c_cfill( N, alpha, (stdlib_complex64_t *)x, stride ); + + // Print the result: + for ( int i = 0; i < 8; i++ ) { + printf( "x[ %i ] = %f\n", i, x[ i ] ); + } +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/examples/index.js new file mode 100644 index 00000000000..0437e4d4bc1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/examples/index.js @@ -0,0 +1,34 @@ +/** +* @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 Complex64 = require( '@stdlib/complex/float32/ctor' ); +var cfill = require( './../lib' ); + +function rand() { + return new Complex64( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); +} + +var x = filledarrayBy( 10, 'complex64', rand ); +var alpha = new Complex64( 10.0, 10.0 ); + +cfill( x.length, alpha, x, 1 ); +console.log( x.get( 0 ).toString() ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/cfill/include.gypi new file mode 100644 index 00000000000..575cb043c0b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/include.gypi @@ -0,0 +1,53 @@ +# @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. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' + +/* +* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** +* Fills a single-precision complex floating-point strided array with a specified scalar constant. +*/ +void c_cfill( const int64_t N, const stdlib_complex64_t alpha, stdlib_complex64_t *X, const int64_t stride ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_BLAS_EXT_BASE_CFILL_H diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.js new file mode 100644 index 00000000000..963dcad00f0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.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 stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +/** +* Fills a single-precision complex floating-point strided array with a specified scalar constant. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {ComplexLike} alpha - scalar constant +* @param {Complex64Array} x - input array +* @param {integer} stride - index increment +* @returns {Complex64Array} input array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* +* var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +* var x = new Complex64Array( arr ); +* +* var alpha = new Complex64( 10.0, 10.0 ); +* +* cfill( x.length, alpha, x, 1 ); +* +* var y = x.get( 0 ); +* // returns +* +* var re = realf( y ); +* // returns 10.0 +* +* var im = imagf( y ); +* // returns 10.0 +*/ +function cfill( N, alpha, x, stride ) { + return ndarray( N, alpha, x, stride, stride2offset( N, stride ) ); +} + + +// EXPORTS // + +module.exports = cfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.native.js new file mode 100644 index 00000000000..a9011040b95 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/cfill.native.js @@ -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. +*/ + +'use strict'; + +// MODULES // + +var reinterpret = require( '@stdlib/strided/base/reinterpret-complex64' ); +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Fills a single-precision complex floating-point strided array with a specified scalar constant. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {ComplexLike} alpha - scalar constant +* @param {Complex64Array} x - input array +* @param {integer} stride - index increment +* @returns {Complex64Array} input array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* +* var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +* var x = new Complex64Array( arr ); +* +* var alpha = new Complex64( 10.0, 10.0 ); +* +* cfill( x.length, alpha, x, 1 ); +* +* var y = x.get( 0 ); +* // returns +* +* var re = realf( y ); +* // returns 10.0 +* +* var im = imagf( y ); +* // returns 10.0 +*/ +function cfill( N, alpha, x, stride ) { + var view = reinterpret( x, 0 ); + addon( N, alpha, view, stride ); + return x; +} + + +// EXPORTS // + +module.exports = cfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/index.js new file mode 100644 index 00000000000..bff9d24f2df --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/index.js @@ -0,0 +1,74 @@ +/** +* @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'; + +/** +* Fill a single-precision complex floating-point strided array with a specified scalar constant. +* +* @module @stdlib/blas/ext/base/cfill +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* var cfill = require( '@stdlib/blas/ext/base/cfill' ); +* +* var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +* var x = new Complex64Array( arr ); +* +* var alpha = new Complex64( 10.0, 10.0 ); +* +* cfill( x.length, alpha, x, 1 ); +* +* var y = x.get( 0 ); +* // returns +* +* var re = realf( y ); +* // returns 10.0 +* +* var im = imagf( y ); +* // returns 10.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 cfill; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + cfill = main; +} else { + cfill = tmp; +} + + +// EXPORTS // + +module.exports = cfill; + +// exports: { "ndarray": "cfill.ndarray" } diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/main.js new file mode 100644 index 00000000000..3f9fce02abb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/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 cfill = require( './cfill.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( cfill, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = cfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/native.js new file mode 100644 index 00000000000..40571998aba --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/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 cfill = require( './cfill.native.js' ); +var ndarray = require( './ndarray.native.js' ); + + +// MAIN // + +setReadOnly( cfill, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = cfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.js new file mode 100644 index 00000000000..24276cac5a5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.js @@ -0,0 +1,139 @@ +/** +* @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-complex64' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + + +// VARIABLES // + +var M = 8; + + +// MAIN // + +/** +* Fills a single-precision complex floating-point strided array with a specified scalar constant. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {ComplexLike} alpha - scalar constant +* @param {Complex64Array} x - input array +* @param {integer} stride - index increment +* @param {NonNegativeInteger} offset - starting index +* @returns {Complex64Array} input array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* +* var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +* var x = new Complex64Array( arr ); +* +* var alpha = new Complex64( 10.0, 10.0 ); +* +* cfill( x.length, alpha, x, 1, 0 ); +* +* var y = x.get( 0 ); +* // returns +* +* var re = realf( y ); +* // returns 10.0 +* +* var im = imagf( y ); +* // returns 10.0 +*/ +function cfill( N, alpha, x, stride, offset ) { + var view; + var re; + var im; + var ix; + var m; + var i; + var j; + + if ( N <= 0 ) { + return x; + } + ix = offset; + + // Decompose the constant into its real and imaginary components: + re = realf( alpha ); + im = imagf( alpha ); + + // Reinterpret the complex input array as a real-valued array: + view = reinterpret( x, 0 ); + + // Use loop unrolling if the stride is equal to `1`... + if ( stride === 1 ) { + m = N % M; + + // If we have a remainder, run a clean-up loop... + if ( m > 0 ) { + for ( i = 0; i < m; i++ ) { + j = ix * 2; + view[ j ] = re; + view[ j+1 ] = im; + ix += stride; + } + } + if ( N < M ) { + return x; + } + for ( i = m; i < N; i += M ) { + j = ix * 2; + view[ j ] = re; + view[ j+1 ] = im; + view[ j+2 ] = re; + view[ j+3 ] = im; + view[ j+4 ] = re; + view[ j+5 ] = im; + view[ j+6 ] = re; + view[ j+7 ] = im; + view[ j+8 ] = re; + view[ j+9 ] = im; + view[ j+10 ] = re; + view[ j+11 ] = im; + view[ j+12 ] = re; + view[ j+13 ] = im; + view[ j+14 ] = re; + view[ j+15 ] = im; + ix += M; + } + return x; + } + for ( i = 0; i < N; i++ ) { + j = ix * 2; + view[ j ] = re; + view[ j+1 ] = im; + ix += stride; + } + return x; +} + + +// EXPORTS // + +module.exports = cfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.native.js new file mode 100644 index 00000000000..9ca1e67b0af --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/lib/ndarray.native.js @@ -0,0 +1,74 @@ +/** +* @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 minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' ); +var offsetView = require( '@stdlib/strided/base/offset-view' ); +var addon = require( './cfill.native.js' ); + + +// MAIN // + +/** +* Fills a single-precision complex floating-point strided array with a specified scalar constant. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {number} alpha - scalar constant +* @param {Complex64Array} x - input array +* @param {integer} stride - index increment +* @param {NonNegativeInteger} offset - starting index +* @returns {Complex64Array} input array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var realf = require( '@stdlib/complex/float32/real' ); +* var imagf = require( '@stdlib/complex/float32/imag' ); +* +* var arr = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +* var x = new Complex64Array( arr ); +* +* var alpha = new Complex64( 10.0, 10.0 ); +* +* cfill( x.length, alpha, x, 1, 0 ); +* +* var y = x.get( 0 ); +* // returns +* +* var re = realf( y ); +* // returns 10.0 +* +* var im = imagf( y ); +* // returns 10.0 +*/ +function cfill( N, alpha, x, stride, offset ) { + var view; + offset = minViewBufferIndex( N, stride, offset ); + view = offsetView( x, offset ); + addon( N, alpha, view, stride ); + return x; +} + + +// EXPORTS // + +module.exports = cfill; diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/cfill/manifest.json new file mode 100644 index 00000000000..1342e6f5afb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/manifest.json @@ -0,0 +1,79 @@ +{ + "options": { + "task": "build" + }, + "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": [ + { + "task": "build", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-complex64", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-complex64array", + "@stdlib/complex/float32/ctor", + "@stdlib/strided/base/stride2offset" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float32/ctor", + "@stdlib/strided/base/stride2offset" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float32/ctor", + "@stdlib/strided/base/stride2offset" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/package.json b/lib/node_modules/@stdlib/blas/ext/base/cfill/package.json new file mode 100644 index 00000000000..d8e0a8ddb23 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/package.json @@ -0,0 +1,78 @@ +{ + "name": "@stdlib/blas/ext/base/cfill", + "version": "0.0.0", + "description": "Fill a single-precision complex floating-point strided array with a specified scalar constant.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "browser": "./lib/main.js", + "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", + "extended", + "fill", + "assign", + "set", + "equal", + "copy", + "broadcast", + "constant", + "strided", + "complex64", + "array", + "complex64array", + "ndarray" + ], + "__stdlib__": { + "wasm": false + } +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/src/Makefile b/lib/node_modules/@stdlib/blas/ext/base/cfill/src/Makefile new file mode 100644 index 00000000000..bcf18aa4665 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/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/ext/base/cfill/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/cfill/src/addon.c new file mode 100644 index 00000000000..1ba1d0d36fb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/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/ext/base/cfill.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_complex64.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_strided_complex64array.h" +#include "stdlib/complex/float32/ctor.h" +#include + +/** +* Receives JavaScript callback invocation data. +* +* @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, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, stride, argv, 3 ); + STDLIB_NAPI_ARGV_COMPLEX64( env, alpha, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_COMPLEX64ARRAY( env, X, N, stride, argv, 2 ); + c_cfill( N, alpha, (stdlib_complex64_t *)X, stride ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN( addon ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/cfill/src/main.c new file mode 100644 index 00000000000..1e690ec687e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/src/main.c @@ -0,0 +1,72 @@ +/** +* @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/ext/base/cfill.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/strided/base/stride2offset.h" +#include + +/** +* Fills a single-precision complex floating-point strided array with a specified scalar constant. +* +* @param N number of indexed elements +* @param alpha scalar constant +* @param X input array +* @param stride index increment +*/ +void c_cfill( const int64_t N, const stdlib_complex64_t alpha, stdlib_complex64_t *X, const int64_t stride ) { + int64_t ix; + int64_t m; + int64_t i; + + if ( N <= 0 ) { + return; + } + + // Use loop unrolling if the stride is equal to `1`... + if ( stride == 1 ) { + m = N % 8; + + // If we have a remainder, run a clean-up loop... + if ( m > 0 ) { + for ( i = 0; i < m; i++ ) { + X[ i ] = alpha; + } + } + if ( N < 8 ) { + return; + } + for ( i = m; i < N; i += 8 ) { + X[ i ] = alpha; + X[ i+1 ] = alpha; + X[ i+2 ] = alpha; + X[ i+3 ] = alpha; + X[ i+4 ] = alpha; + X[ i+5 ] = alpha; + X[ i+6 ] = alpha; + X[ i+7 ] = alpha; + } + return; + } + ix = stdlib_strided_stride2offset( N, stride ); + for ( i = 0; i < N; i++ ) { + X[ ix ] = alpha; + ix += stride; + } + return; +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.cfill.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.cfill.js new file mode 100644 index 00000000000..00105fbbd26 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.cfill.js @@ -0,0 +1,212 @@ +/** +* @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 isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var constantFunction = require( '@stdlib/utils/constant-function' ); +var cfill = require( './../lib/cfill.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cfill, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 4', function test( t ) { + t.strictEqual( cfill.length, 4, 'has expected arity' ); + t.end(); +}); + +tape( 'the function fills a strided array', function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 4.0, + 2.0, + -3.0, + 5.0, + -1.0, + 2.0, + -5.0, + 6.0 + ]); + expected = new Complex64Array([ + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0 + ]); + + cfill( x.length, new Complex64( 5.0, 5.0 ), x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); + expected = new Complex64Array( [ 5.0, 5.0, 5.0, 5.0 ] ); + + cfill( x.length, new Complex64( 5.0, 5.0 ), x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a reference to the input array', function test( t ) { + var out; + var x; + + x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + out = cfill( x.length, new Complex64( 3.0, 3.0 ), x, 1 ); + + t.strictEqual( out, x, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the input array unchanged', function test( t ) { + var expected; + var x; + + x = new Complex64Array( [ 3.0, -4.0, 1.0, -2.0 ] ); + expected = new Complex64Array( [ 3.0, -4.0, 1.0, -2.0 ] ); + + cfill( 0, new Complex64( 5.0, 5.0 ), x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + cfill( -4, new Complex64( 5.0, 5.0 ), x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride', function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 2.0, // 0 + -3.0, // 0 + 4.0, + -6.0, + 8.0, // 1 + -9.0 // 1 + ]); + expected = new Complex64Array([ + 5.0, // 0 + -5.0, // 0 + 4.0, + -6.0, + 5.0, // 1 + -5.0 // 1 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, 2 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative stride', function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 2.0, // 1 + -3.0, // 1 + 4.0, + -5.0, + 6.0, // 0 + -7.0 // 0 + ]); + expected = new Complex64Array([ + 5.0, // 1 + -5.0, // 1 + 4.0, + -5.0, + 5.0, // 0 + -5.0 // 0 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, -2 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var expected; + var x0; + var x1; + + x0 = new Complex64Array([ + 1.0, + -2.0, + 3.0, // 0 + -4.0, // 0 + 6.0, + -8.0, + 10.0, // 1 + -12.0 // 1 + ]); + expected = new Complex64Array([ + 1.0, + -2.0, + 5.0, // 0 + -5.0, // 0 + 6.0, + -8.0, + 5.0, // 1 + -5.0 // 1 + ]); + + x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + + cfill( 2, new Complex64( 5.0, -5.0 ), x1, 2 ); + t.strictEqual( isSameComplex64Array( x0, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'if `stride` is equal to `1`, the function efficiently fills a strided array', function test( t ) { + var expected; + var alpha; + var x; + + alpha = new Complex64( 3.0, -1.0 ); + x = filledarrayBy( 100, 'complex64', constantFunction( new Complex64( 1.0, 1.0 ) ) ); + expected = filledarrayBy( 100, 'complex64', constantFunction( new Complex64( 3.0, -1.0 ) ) ); + cfill( x.length, alpha, x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + alpha = new Complex64( 9.0, -3.0 ); + x = filledarrayBy( 240, 'complex64', constantFunction( new Complex64( 8.0, -2.0 ) ) ); + expected = filledarrayBy( 240, 'complex64', constantFunction( new Complex64( 9.0, -3.0 ) ) ); + cfill( x.length, alpha, x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.cfill.native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.cfill.native.js new file mode 100644 index 00000000000..ec51f4d05c7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.cfill.native.js @@ -0,0 +1,221 @@ +/** +* @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 isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var constantFunction = require( '@stdlib/utils/constant-function' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var cfill = tryRequire( resolve( __dirname, './../lib/cfill.native.js' ) ); +var opts = { + 'skip': ( cfill instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cfill, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 4', opts, function test( t ) { + t.strictEqual( cfill.length, 4, 'has expected arity' ); + t.end(); +}); + +tape( 'the function fills a strided array', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 4.0, + 2.0, + -3.0, + 5.0, + -1.0, + 2.0, + -5.0, + 6.0 + ]); + expected = new Complex64Array([ + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0 + ]); + + cfill( x.length, new Complex64( 5.0, 5.0 ), x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); + expected = new Complex64Array( [ 5.0, 5.0, 5.0, 5.0 ] ); + + cfill( x.length, new Complex64( 5.0, 5.0 ), x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a reference to the input array', opts, function test( t ) { + var out; + var x; + + x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + out = cfill( x.length, new Complex64( 3.0, 3.0 ), x, 1 ); + + t.strictEqual( out, x, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the input array unchanged', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array( [ 3.0, -4.0, 1.0, -2.0 ] ); + expected = new Complex64Array( [ 3.0, -4.0, 1.0, -2.0 ] ); + + cfill( 0, new Complex64( 5.0, 5.0 ), x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + cfill( -4, new Complex64( 5.0, 5.0 ), x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 2.0, // 0 + -3.0, // 0 + 4.0, + -6.0, + 8.0, // 1 + -9.0 // 1 + ]); + expected = new Complex64Array([ + 5.0, // 0 + -5.0, // 0 + 4.0, + -6.0, + 5.0, // 1 + -5.0 // 1 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, 2 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative stride', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 2.0, // 1 + -3.0, // 1 + 4.0, + -5.0, + 6.0, // 0 + -7.0 // 0 + ]); + expected = new Complex64Array([ + 5.0, // 1 + -5.0, // 1 + 4.0, + -5.0, + 5.0, // 0 + -5.0 // 0 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, -2 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var expected; + var x0; + var x1; + + x0 = new Complex64Array([ + 1.0, + -2.0, + 3.0, // 0 + -4.0, // 0 + 6.0, + -8.0, + 10.0, // 1 + -12.0 // 1 + ]); + expected = new Complex64Array([ + 1.0, + -2.0, + 5.0, // 0 + -5.0, // 0 + 6.0, + -8.0, + 5.0, // 1 + -5.0 // 1 + ]); + + x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + + cfill( 2, new Complex64( 5.0, -5.0 ), x1, 2 ); + t.strictEqual( isSameComplex64Array( x0, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'if `stride` is equal to `1`, the function efficiently fills a strided array', opts, function test( t ) { + var expected; + var alpha; + var x; + + alpha = new Complex64( 3.0, -1.0 ); + x = filledarrayBy( 100, 'complex64', constantFunction( new Complex64( 1.0, 1.0 ) ) ); + expected = filledarrayBy( 100, 'complex64', constantFunction( new Complex64( 3.0, -1.0 ) ) ); + cfill( x.length, alpha, x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + alpha = new Complex64( 9.0, -3.0 ); + x = filledarrayBy( 240, 'complex64', constantFunction( new Complex64( 8.0, -2.0 ) ) ); + expected = filledarrayBy( 240, 'complex64', constantFunction( new Complex64( 9.0, -3.0 ) ) ); + cfill( x.length, alpha, x, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.js new file mode 100644 index 00000000000..f6ada770e82 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/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 IS_BROWSER = require( '@stdlib/assert/is-browser' ); +var cfill = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': IS_BROWSER +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cfill, '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 cfill.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 cfill = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( cfill, 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 cfill; + var main; + + main = require( './../lib/cfill.js' ); + + cfill = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( cfill, main, 'returns JavaScript implementation' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.ndarray.js new file mode 100644 index 00000000000..53d614825b8 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.ndarray.js @@ -0,0 +1,209 @@ +/** +* @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 isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var constantFunction = require( '@stdlib/utils/constant-function' ); +var cfill = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cfill, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', function test( t ) { + t.strictEqual( cfill.length, 5, 'has expected arity' ); + t.end(); +}); + +tape( 'the function fills a strided array', function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 4.0, + 2.0, + -3.0, + 5.0, + -1.0, + 2.0, + -5.0, + 6.0 + ]); + expected = new Complex64Array([ + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0 + ]); + + cfill( x.length, new Complex64( 5.0, 5.0 ), x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); + expected = new Complex64Array( [ 5.0, 5.0, 5.0, 5.0 ] ); + + cfill( x.length, new Complex64( 5.0, 5.0 ), x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a reference to the input array', function test( t ) { + var out; + var x; + + x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + out = cfill( x.length, new Complex64( 3.0, 3.0 ), x, 1, 0 ); + + t.strictEqual( out, x, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the input array unchanged', function test( t ) { + var expected; + var x; + + x = new Complex64Array( [ 3.0, -4.0, 1.0, -2.0 ] ); + expected = new Complex64Array( [ 3.0, -4.0, 1.0, -2.0 ] ); + + cfill( 0, new Complex64( 5.0, 5.0 ), x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + cfill( -4, new Complex64( 5.0, 5.0 ), x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride', function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 2.0, // 0 + -3.0, // 0 + 4.0, + -6.0, + 8.0, // 1 + -9.0 // 1 + ]); + expected = new Complex64Array([ + 5.0, // 0 + -5.0, // 0 + 4.0, + -6.0, + 5.0, // 1 + -5.0 // 1 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, 2, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative stride', function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 2.0, // 1 + -3.0, // 1 + 4.0, + -6.0, + 8.0, // 0 + -9.0 // 0 + ]); + expected = new Complex64Array([ + 5.0, // 1 + -5.0, // 1 + 4.0, + -6.0, + 5.0, // 0 + -5.0 // 0 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, -2, x.length-1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an offset parameter', function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 1.0, + -2.0, + 3.0, // 0 + -4.0, // 0 + 6.0, + -8.0, + 10.0, // 1 + -12.0 // 1 + ]); + expected = new Complex64Array([ + 1.0, + -2.0, + 5.0, // 0 + -5.0, // 0 + 6.0, + -8.0, + 5.0, // 1 + -5.0 // 1 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, 2, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'if `stride` is equal to `1`, the function efficiently fills a strided array', function test( t ) { + var expected; + var alpha; + var x; + + alpha = new Complex64( 3.0, -1.0 ); + x = filledarrayBy( 100, 'complex64', constantFunction( new Complex64( 1.0, 1.0 ) ) ); + expected = filledarrayBy( 100, 'complex64', constantFunction( new Complex64( 3.0, -1.0 ) ) ); + cfill( x.length, alpha, x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + alpha = new Complex64( 9.0, -3.0 ); + x = filledarrayBy( 240, 'complex64', constantFunction( new Complex64( 8.0, -2.0 ) ) ); + expected = filledarrayBy( 240, 'complex64', constantFunction( new Complex64( 9.0, -3.0 ) ) ); + cfill( x.length, alpha, x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.ndarray.native.js new file mode 100644 index 00000000000..b6f4192b9bf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/cfill/test/test.ndarray.native.js @@ -0,0 +1,218 @@ +/** +* @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 isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var constantFunction = require( '@stdlib/utils/constant-function' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var cfill = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( cfill instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cfill, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', opts, function test( t ) { + t.strictEqual( cfill.length, 5, 'has expected arity' ); + t.end(); +}); + +tape( 'the function fills a strided array', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 4.0, + 2.0, + -3.0, + 5.0, + -1.0, + 2.0, + -5.0, + 6.0 + ]); + expected = new Complex64Array([ + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0, + 5.0 + ]); + + cfill( x.length, new Complex64( 5.0, 5.0 ), x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); + expected = new Complex64Array( [ 5.0, 5.0, 5.0, 5.0 ] ); + + cfill( x.length, new Complex64( 5.0, 5.0 ), x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a reference to the input array', opts, function test( t ) { + var out; + var x; + + x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + out = cfill( x.length, new Complex64( 3.0, 3.0 ), x, 1, 0 ); + + t.strictEqual( out, x, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the input array unchanged', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array( [ 3.0, -4.0, 1.0, -2.0 ] ); + expected = new Complex64Array( [ 3.0, -4.0, 1.0, -2.0 ] ); + + cfill( 0, new Complex64( 5.0, 5.0 ), x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + cfill( -4, new Complex64( 5.0, 5.0 ), x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 2.0, // 0 + -3.0, // 0 + 4.0, + -6.0, + 8.0, // 1 + -9.0 // 1 + ]); + expected = new Complex64Array([ + 5.0, // 0 + -5.0, // 0 + 4.0, + -6.0, + 5.0, // 1 + -5.0 // 1 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, 2, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative stride', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 2.0, // 1 + -3.0, // 1 + 4.0, + -6.0, + 8.0, // 0 + -9.0 // 0 + ]); + expected = new Complex64Array([ + 5.0, // 1 + -5.0, // 1 + 4.0, + -6.0, + 5.0, // 0 + -5.0 // 0 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, -2, x.length-1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports an offset parameter', opts, function test( t ) { + var expected; + var x; + + x = new Complex64Array([ + 1.0, + -2.0, + 3.0, // 0 + -4.0, // 0 + 6.0, + -8.0, + 10.0, // 1 + -12.0 // 1 + ]); + expected = new Complex64Array([ + 1.0, + -2.0, + 5.0, // 0 + -5.0, // 0 + 6.0, + -8.0, + 5.0, // 1 + -5.0 // 1 + ]); + + cfill( 2, new Complex64( 5.0, -5.0 ), x, 2, 1 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'if `stride` is equal to `1`, the function efficiently fills a strided array', opts, function test( t ) { + var expected; + var alpha; + var x; + + alpha = new Complex64( 3.0, -1.0 ); + x = filledarrayBy( 100, 'complex64', constantFunction( new Complex64( 1.0, 1.0 ) ) ); + expected = filledarrayBy( 100, 'complex64', constantFunction( new Complex64( 3.0, -1.0 ) ) ); + cfill( x.length, alpha, x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + alpha = new Complex64( 9.0, -3.0 ); + x = filledarrayBy( 240, 'complex64', constantFunction( new Complex64( 8.0, -2.0 ) ) ); + expected = filledarrayBy( 240, 'complex64', constantFunction( new Complex64( 9.0, -3.0 ) ) ); + cfill( x.length, alpha, x, 1, 0 ); + t.strictEqual( isSameComplex64Array( x, expected ), true, 'returns expected value' ); + + t.end(); +}); From 51787c84fc5805a0144c2596ad8ac631470458b5 Mon Sep 17 00:00:00 2001 From: Gunj Joshi Date: Mon, 16 Sep 2024 10:05:17 +0530 Subject: [PATCH 3/3] feat: add `constants/float64/num-high-word-significand-bits` PR-URL: https://github.com/stdlib-js/stdlib/pull/2889 Ref: https://github.com/stdlib-js/stdlib/blob/fadff3a44660678d9ccce8bb101f579ca1913a64/lib/node_modules/%40stdlib/math/base/special/pow/src/main.c#L52 Co-authored-by: Athan Reines Reviewed-by: Athan Reines --- .../num-high-word-significand-bits/README.md | 143 ++++++++++++++++++ .../docs/repl.txt | 13 ++ .../docs/types/index.d.ts | 33 ++++ .../docs/types/test.ts | 28 ++++ .../examples/index.js | 24 +++ .../float64/num_high_word_significand_bits.h | 27 ++++ .../lib/index.js | 47 ++++++ .../manifest.json | 36 +++++ .../package.json | 68 +++++++++ .../test/test.js | 38 +++++ 10 files changed, 457 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/README.md create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/include/stdlib/constants/float64/num_high_word_significand_bits.h create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/manifest.json create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/package.json create mode 100644 lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/README.md b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/README.md new file mode 100644 index 00000000000..34464e45306 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/README.md @@ -0,0 +1,143 @@ + + +# FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS + +> Number of significand bits in the high word of a [double-precision floating-point number][ieee754]. + +
+ +## Usage + + + +```javascript +var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( '@stdlib/constants/float64/num-high-word-significand-bits' ); +``` + +#### FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS + +Number of significand bits in the high word of a [double-precision floating-point number][ieee754]. + + + +```javascript +var bool = ( FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS === 20 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( '@stdlib/constants/float64/num-high-word-significand-bits' ); + +console.log( FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS ); +// => 20 +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/constants/float64/num_high_word_significand_bits.h" +``` + +#### STDLIB_CONSTANT_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS + +Number of significand bits in the high word of a [double-precision floating-point number][ieee754]. + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + + + + + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/repl.txt b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/repl.txt new file mode 100644 index 00000000000..d1e0c2f87d2 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/repl.txt @@ -0,0 +1,13 @@ + +{{alias}} + Number of significand bits in the high word of a double-precision floating- + point number. + + Examples + -------- + > {{alias}} + 20 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/index.d.ts new file mode 100644 index 00000000000..98ca1397d1e --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/index.d.ts @@ -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. +*/ + +// TypeScript Version: 4.1 + +/** +* Number of significand bits in the high word of a double-precision floating-point number. +* +* @example +* var bits = FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS; +* // returns 20 +*/ +declare const FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS: number; + + +// EXPORTS // + +export = FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS; diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/test.ts new file mode 100644 index 00000000000..66a2a110a93 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/test.ts @@ -0,0 +1,28 @@ +/* +* @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 FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS; // $ExpectType number +} diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/examples/index.js b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/examples/index.js new file mode 100644 index 00000000000..48afcc821da --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/examples/index.js @@ -0,0 +1,24 @@ +/** +* @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 FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( './../lib' ); // eslint-disable-line id-length + +console.log( FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS ); +// => 20 diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/include/stdlib/constants/float64/num_high_word_significand_bits.h b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/include/stdlib/constants/float64/num_high_word_significand_bits.h new file mode 100644 index 00000000000..8598d2402ad --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/include/stdlib/constants/float64/num_high_word_significand_bits.h @@ -0,0 +1,27 @@ +/** +* @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. +*/ + +#ifndef STDLIB_CONSTANTS_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS_H +#define STDLIB_CONSTANTS_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS_H + +/** +* Number of significand bits in the high word of a double-precision floating-point number. +*/ +#define STDLIB_CONSTANT_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS 20 + +#endif // !STDLIB_CONSTANTS_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS_H diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/lib/index.js b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/lib/index.js new file mode 100644 index 00000000000..488c1115d8d --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/lib/index.js @@ -0,0 +1,47 @@ +/** +* @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'; + +/** +* Number of significand bits in the high word of a double-precision floating-point number. +* +* @module @stdlib/constants/float64/num-high-word-significand-bits +* @type {integer32} +* +* @example +* var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( '@stdlib/constants/float64/num-high-word-significand-bits' ); +* // returns 20 +*/ + + +// MAIN // + +/** +* Number of significand bits in the high word of a double-precision floating-point number. +* +* @constant +* @type {integer32} +* @default 20 +*/ +var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = 20|0; // eslint-disable-line id-length + + +// EXPORTS // + +module.exports = FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS; diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/manifest.json b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/manifest.json new file mode 100644 index 00000000000..844d692f643 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/manifest.json @@ -0,0 +1,36 @@ +{ + "options": {}, + "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": [ + { + "src": [], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + } + ] +} diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/package.json b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/package.json new file mode 100644 index 00000000000..63d20041de8 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/package.json @@ -0,0 +1,68 @@ +{ + "name": "@stdlib/constants/float64/num-high-word-significand-bits", + "version": "0.0.0", + "description": "Number of significand bits in the high word of a double-precision floating-point number.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "doc": "./docs", + "example": "./examples", + "include": "./include", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "constant", + "const", + "mathematics", + "math", + "float", + "float64", + "64bit", + "floating-point", + "ieee754", + "significand", + "bits", + "high", + "word" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/test/test.js b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/test/test.js new file mode 100644 index 00000000000..35132a72ea4 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/test/test.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'; + +// MODULES // + +var tape = require( 'tape' ); +var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( './../lib' ); // eslint-disable-line id-length + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'the exported value is 20', function test( t ) { + t.equal( FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS, 20, 'returns expected value' ); + t.end(); +});