From 34f63d5a38acc205ab3fa19a201603692e22cf3a Mon Sep 17 00:00:00 2001 From: orthodox-64 Date: Wed, 28 Jan 2026 17:39:21 +0530 Subject: [PATCH] feat: add complex/float32/base/add3 --- .../complex/float32/base/add3/README.md | 275 +++++++++++ .../base/add3/benchmark/benchmark.assign.js | 71 +++ .../float32/base/add3/benchmark/benchmark.js | 60 +++ .../base/add3/benchmark/benchmark.native.js | 70 +++ .../base/add3/benchmark/benchmark.strided.js | 71 +++ .../float32/base/add3/benchmark/c/Makefile | 126 +++++ .../float32/base/add3/benchmark/c/benchmark.c | 149 ++++++ .../base/add3/benchmark/c/native/Makefile | 146 ++++++ .../base/add3/benchmark/c/native/benchmark.c | 154 ++++++ .../float32/base/add3/benchmark/julia/REQUIRE | 2 + .../base/add3/benchmark/julia/benchmark.jl | 144 ++++++ .../complex/float32/base/add3/binding.gyp | 170 +++++++ .../complex/float32/base/add3/docs/repl.txt | 133 +++++ .../float32/base/add3/docs/types/index.d.ts | 145 ++++++ .../float32/base/add3/docs/types/test.ts | 465 ++++++++++++++++++ .../float32/base/add3/examples/c/Makefile | 146 ++++++ .../float32/base/add3/examples/c/example.c | 46 ++ .../float32/base/add3/examples/index.js | 32 ++ .../complex/float32/base/add3/include.gypi | 53 ++ .../stdlib/complex/float32/base/add3.h | 40 ++ .../complex/float32/base/add3/lib/assign.js | 57 +++ .../complex/float32/base/add3/lib/index.js | 54 ++ .../complex/float32/base/add3/lib/main.js | 56 +++ .../complex/float32/base/add3/lib/native.js | 54 ++ .../complex/float32/base/add3/lib/strided.js | 64 +++ .../complex/float32/base/add3/manifest.json | 75 +++ .../complex/float32/base/add3/package.json | 69 +++ .../complex/float32/base/add3/src/Makefile | 70 +++ .../complex/float32/base/add3/src/addon.c | 22 + .../complex/float32/base/add3/src/main.c | 64 +++ .../float32/base/add3/test/test.assign.js | 132 +++++ .../complex/float32/base/add3/test/test.js | 46 ++ .../float32/base/add3/test/test.main.js | 120 +++++ .../float32/base/add3/test/test.native.js | 129 +++++ .../float32/base/add3/test/test.strided.js | 171 +++++++ 35 files changed, 3681 insertions(+) create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/README.md create mode 100755 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.assign.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.native.js create mode 100755 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.strided.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/julia/REQUIRE create mode 100755 lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/julia/benchmark.jl create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/binding.gyp create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/examples/index.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/include.gypi create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/include/stdlib/complex/float32/base/add3.h create mode 100755 lib/node_modules/@stdlib/complex/float32/base/add3/lib/assign.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/lib/index.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/lib/main.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/lib/native.js create mode 100755 lib/node_modules/@stdlib/complex/float32/base/add3/lib/strided.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/manifest.json create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/package.json create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/src/Makefile create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/src/addon.c create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/src/main.c create mode 100755 lib/node_modules/@stdlib/complex/float32/base/add3/test/test.assign.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/test/test.js create mode 100755 lib/node_modules/@stdlib/complex/float32/base/add3/test/test.main.js create mode 100644 lib/node_modules/@stdlib/complex/float32/base/add3/test/test.native.js create mode 100755 lib/node_modules/@stdlib/complex/float32/base/add3/test/test.strided.js diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/README.md b/lib/node_modules/@stdlib/complex/float32/base/add3/README.md new file mode 100644 index 000000000000..6d8de1c80c8e --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/README.md @@ -0,0 +1,275 @@ + + +# add3 + +> Compute the sum of three single-precision complex floating-point numbers. + +
+ +
+ + + +
+ +## Usage + +```javascript +var add3 = require( '@stdlib/complex/float32/base/add3' ); +``` + +#### add3( z1, z2, z3 ) + +Computes the sum of three single-precision complex floating-point numbers. + +```javascript +var Complex64 = require( '@stdlib/complex/float32/ctor' ); + +var z = new Complex64( -1.5, 2.5 ); + +var v = add3( z, z, z ); +// returns [ -4.5, 7.5 ] +``` + +The function supports the following parameters: + +- **z1**: first complex number. +- **z2**: second complex number. +- **z3**: third complex number. + +#### add3.assign( re1, im1, re2, im2, re3, im3, out, strideOut, offsetOut ) + +Computes the sum of three single-precision complex floating-point numbers and assigns results to a provided output array. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var out = new Float32Array( 2 ); +var v = add3.assign( 5.0, 3.0, -2.0, 1.0, 5.0, 3.0, out, 1, 0 ); +// returns [ 8.0, 7.0 ] + +var bool = ( out === v ); +// returns true +``` + +The function supports the following parameters: + +- **re1**: real component of the first complex number. +- **im1**: imaginary component of the first complex number. +- **re2**: real component of the second complex number. +- **im2**: imaginary component of the second complex number. +- **re3**: real component of the third complex number. +- **im3**: imaginary component of the third complex number. +- **out**: output array. +- **strideOut**: stride length for `out`. +- **offsetOut**: starting index for `out`. + +#### add3.strided( z1, sz1, oz1, z2, sz2, oz2, z3, sz3, oz3, out, so, oo ) + +Computes the sum of three single-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +var z1 = new Float32Array( [ 5.0, 3.0 ] ); +var z2 = new Float32Array( [ -2.0, 1.0 ] ); +var z3 = new Float32Array( [ 5.0, 3.0 ] ); +var out = new Float32Array( 2 ); + +var v = add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); +// returns [ 8.0, 7.0 ] + +var bool = ( out === v ); +// returns true +``` + +The function supports the following parameters: + +- **z1**: first complex number strided array view. +- **sz1**: stride length for `z1`. +- **oz1**: starting index for `z1`. +- **z2**: second complex number strided array view. +- **sz2**: stride length for `z2`. +- **oz2**: starting index for `z2`. +- **z3**: third complex number strided array view. +- **sz3**: stride length for `z3`. +- **oz3**: starting index for `z3`. +- **out**: output array. +- **so**: stride length for `out`. +- **oo**: starting index for `out`. + +
+ + + +
+ +## Examples + + + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var add3 = require( '@stdlib/complex/float32/base/add3' ); + +// Generate arrays of random values: +var z1 = new Complex64Array( discreteUniform( 200, -50, 50 ) ); +var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) ); +var z3 = new Complex64Array( discreteUniform( 200, -50, 50 ) ); + +// Perform element-wise addition: +logEachMap( '(%s) + (%s) + (%s) = %s', z1, z2, z3, add3 ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/complex/float32/base/add3.h" +``` + +#### stdlib_base_complex64_add3( z1, z2, z3 ) + +Computes the sum of three single-precision complex floating-point numbers. + +```c +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/real.h" +#include "stdlib/complex/float32/imag.h" + +stdlib_complex64_t z = stdlib_complex64( 3.0f, -2.0f ); + +stdlib_complex64_t out = stdlib_base_complex64_add3( z, z, z ); + +float re = stdlib_complex64_real( out ); +// returns 9.0f + +float im = stdlib_complex64_imag( out ); +// returns -6.0f +``` + +The function accepts the following arguments: + +- **z1**: `[in] stdlib_complex64_t` first input value. +- **z2**: `[in] stdlib_complex64_t` second input value. +- **z3**: `[in] stdlib_complex64_t` third input value. + +```c +stdlib_complex64_t stdlib_base_complex64_add3( const stdlib_complex64_t z1, const stdlib_complex64_t z2, const stdlib_complex64_t z3 ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/complex/float32/base/add3.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/reim.h" +#include + +int main( void ) { + const stdlib_complex64_t x[] = { + stdlib_complex64( 3.14f, 1.5f ), + stdlib_complex64( -3.14f, 1.5f ), + stdlib_complex64( 0.0f, -0.0f ), + stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f ) + }; + + stdlib_complex64_t v; + stdlib_complex64_t y; + float re; + float im; + int i; + for ( i = 0; i < 4; i++ ) { + v = x[ i ]; + stdlib_complex64_reim( v, &re, &im ); + printf( "z = %f + %fi\n", re, im ); + + y = stdlib_base_complex64_add3( v, v, v ); + stdlib_complex64_reim( y, &re, &im ); + printf( "add3(z, z, z) = %f + %fi\n", re, im ); + } +} +``` + +
+ + + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.assign.js b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.assign.js new file mode 100755 index 000000000000..353d87ed54f0 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.assign.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Float32Array = require( '@stdlib/array/float32' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var add3 = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// MAIN // + +bench( format( '%s:assign', pkg ), function benchmark( b ) { + var out; + var re; + var im; + var N; + var i; + var j; + var k; + + N = 100; + re = uniform( N, -500.0, 500.0, options ); + im = uniform( N, -500.0, 500.0, options ); + + out = new Float32Array( 2 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + j = i % N; + k = ( i+1 ) % N; + out = add3.assign( re[ j ], im[ j ], re[ k ], im[ k ], re[ j ], im[ k ], out, 1, 0 ); // eslint-disable-line max-len + if ( typeof out !== 'object' ) { + b.fail( 'should return an object' ); + } + } + b.toc(); + if ( isnanf( out[ 0 ] ) || isnanf( out[ 1 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.js b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.js new file mode 100644 index 000000000000..9ee75acee6d9 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); +var pkg = require( './../package.json' ).name; +var add3 = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var values; + var out; + var z; + var i; + + values = [ + new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ), + new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ) + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = values[ i%values.length ]; + out = add3( z, z, z ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an object' ); + } + } + b.toc(); + if ( isnanf( realf( out ) ) || isnanf( imagf( out ) ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.native.js new file mode 100644 index 000000000000..33bf6f894fed --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.native.js @@ -0,0 +1,70 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var add3 = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( add3 instanceof Error ) +}; + + +// MAIN // + +bench( format( '%s::native', pkg ), opts, function benchmark( b ) { + var values; + var out; + var z; + var i; + + values = [ + new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ), + new Complex64( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ) + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = values[ i%values.length ]; + out = add3( z, z, z ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an object' ); + } + } + b.toc(); + if ( isnanf( realf( out ) ) || isnanf( imagf( out ) ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.strided.js b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.strided.js new file mode 100755 index 000000000000..b1aa62b7fe4a --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/benchmark.strided.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Float32Array = require( '@stdlib/array/float32' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var add3 = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// MAIN // + +bench( format( '%s:strided', pkg ), function benchmark( b ) { + var out; + var z1; + var z2; + var z3; + var N; + var i; + var j; + + N = 50; + z1 = uniform( N*2, -500.0, 500.0, options ); + z2 = uniform( N*2, -500.0, 500.0, options ); + z3 = uniform( N*2, -500.0, 500.0, options ); + + out = new Float32Array( 2 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + j = ( i % N ) * 2; + out = add3.strided( z1, 1, j, z2, 1, j, z3, 1, j, out, 1, 0 ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an object' ); + } + } + b.toc(); + if ( isnanf( out[ 0 ] ) || isnanf( out[ 1 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/Makefile b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/Makefile new file mode 100644 index 000000000000..ff0ad2332400 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/Makefile @@ -0,0 +1,126 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# 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 C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles C source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code (e.g., `-fPIC`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler +# @param {string} CFLAGS - C compiler flags +# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $< -lm + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/benchmark.c new file mode 100644 index 000000000000..e213f8017843 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/benchmark.c @@ -0,0 +1,149 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include +#include +#include +#include +#include + +#define NAME "add3" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* 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 elapsed elapsed time in seconds +*/ +static void print_results( 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. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + float complex z1[ 100 ]; + float complex z2[ 100 ]; + float complex z3[ 100 ]; + float complex z4; + double elapsed; + float re; + float im; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + re = ( 1000.0f*rand_float() ) - 500.0f; + im = ( 1000.0f*rand_float() ) - 500.0f; + z1[ i ] = re + im*I; + + re = ( 1000.0f*rand_float() ) - 500.0f; + im = ( 1000.0f*rand_float() ) - 500.0f; + z2[ i ] = re + im*I; + + re = ( 1000.0f*rand_float() ) - 500.0f; + im = ( 1000.0f*rand_float() ) - 500.0f; + z3[ i ] = re + im*I; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + z4 = ( crealf( z1[ i%100 ] ) + crealf( z2[ i%100 ] ) + crealf( z3[ i%100 ] ) ) + ( cimagf( z1[ i%100 ] ) + cimagf( z2[ i%100 ] ) + cimagf( z3[ i%100 ] ) ) * I; + if ( z4 != z4 ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( z4 != z4 ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/native/Makefile new file mode 100644 index 000000000000..979768abbcec --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# 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.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/complex/float32/base/add3/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..ddace08906b2 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/c/native/benchmark.c @@ -0,0 +1,154 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/complex/float32/base/add3.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/reim.h" +#include +#include +#include +#include +#include +#include + +#define NAME "add3" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* 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 elapsed elapsed time in seconds +*/ +static void print_results( 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. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + stdlib_complex64_t z1[ 100 ]; + stdlib_complex64_t z2[ 100 ]; + stdlib_complex64_t z3[ 100 ]; + stdlib_complex64_t z4; + double elapsed; + float re; + float im; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + re = ( 1000.0f*rand_float() ) - 500.0f; + im = ( 1000.0f*rand_float() ) - 500.0f; + z1[ i ] = stdlib_complex64( re, im ); + + re = ( 1000.0f*rand_float() ) - 500.0f; + im = ( 1000.0f*rand_float() ) - 500.0f; + z2[ i ] = stdlib_complex64( re, im ); + + re = ( 1000.0f*rand_float() ) - 500.0f; + im = ( 1000.0f*rand_float() ) - 500.0f; + z3[ i ] = stdlib_complex64( re, im ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + z4 = stdlib_base_complex64_add3( z1[ i%100 ], z2[ i%100 ], z3[ i%100 ] ); + stdlib_complex64_reim( z4, &re, &im ); + if ( re != re ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( im != im ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/julia/REQUIRE b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/julia/REQUIRE new file mode 100644 index 000000000000..98645e192e41 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/julia/REQUIRE @@ -0,0 +1,2 @@ +julia 1.5 +BenchmarkTools 0.5.0 diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/julia/benchmark.jl b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/julia/benchmark.jl new file mode 100755 index 000000000000..48c5c47f25b0 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/benchmark/julia/benchmark.jl @@ -0,0 +1,144 @@ +#!/usr/bin/env julia +# +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import BenchmarkTools +using Printf + +# Benchmark variables: +name = "add3"; +repeats = 3; + +""" + print_version() + +Prints the TAP version. + +# Examples + +``` julia +julia> print_version() +``` +""" +function print_version() + @printf( "TAP version 13\n" ); +end + +""" + print_summary( total, passing ) + +Print the benchmark summary. + +# Arguments + +* `total`: total number of tests +* `passing`: number of passing tests + +# Examples + +``` julia +julia> print_summary( 3, 3 ) +``` +""" +function print_summary( total, 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" ); +end + +""" + print_results( iterations, elapsed ) + +Print benchmark results. + +# Arguments + +* `iterations`: number of iterations +* `elapsed`: elapsed time (in seconds) + +# Examples + +``` julia +julia> print_results( 1000000, 0.131009101868 ) +``` +""" +function print_results( iterations, elapsed ) + rate = iterations / elapsed + + @printf( " ---\n" ); + @printf( " iterations: %d\n", iterations ); + @printf( " elapsed: %0.9f\n", elapsed ); + @printf( " rate: %0.9f\n", rate ); + @printf( " ...\n" ); +end + +""" + benchmark() + +Run a benchmark. + +# Notes + +* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. +* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. +* The elapsed time is in seconds. + +# Examples + +``` julia +julia> out = benchmark(); +``` +""" +function benchmark() + t = BenchmarkTools.@benchmark ComplexF32( (rand()*1000.0)-500.0, (rand()*1000.0)-500.0 ) + ComplexF32( (rand()*1000.0)-500.0, (rand()*1000.0)-500.0 ) + ComplexF32( (rand()*1000.0)-500.0, (rand()*1000.0)-500.0 ) samples=1e6 + + # Compute the total "elapsed" time and convert from nanoseconds to seconds: + s = sum( t.times ) / 1.0e9; + + # Determine the number of "iterations": + iter = length( t.times ); + + # Return the results: + [ iter, s ]; +end + +""" + main() + +Run benchmarks. + +# Examples + +``` julia +julia> main(); +``` +""" +function main() + print_version(); + for i in 1:repeats + @printf( "# julia::%s\n", name ); + results = benchmark(); + print_results( results[ 1 ], results[ 2 ] ); + @printf( "ok %d benchmark finished\n", i ); + end + print_summary( repeats, repeats ); +end + +main(); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/binding.gyp b/lib/node_modules/@stdlib/complex/float32/base/add3/binding.gyp new file mode 100644 index 000000000000..0d6508a12e99 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# 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/complex/float32/base/add3/docs/repl.txt b/lib/node_modules/@stdlib/complex/float32/base/add3/docs/repl.txt new file mode 100644 index 000000000000..fca55c4f9d36 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/docs/repl.txt @@ -0,0 +1,133 @@ + +{{alias}}( z1, z2, z3 ) + Computes the sum of three single-precision complex floating-point numbers. + + Parameters + ---------- + z1: Complex64 + Complex number. + + z2: Complex64 + Complex number. + + z3: Complex64 + Complex number. + + Returns + ------- + out: Complex64 + Result. + + Examples + -------- + > var z = new {{alias:@stdlib/complex/float32/ctor}}( 5.0, 3.0 ) + [ 5.0, 3.0 ] + > var out = {{alias}}( z, z, z ) + [ 15.0, 9.0 ] + + +{{alias}}.assign( re1, im1, re2, im2, re3, im3, out, strideOut, offsetOut ) + Computes the sum of three single-precision complex floating-point numbers + and assigns results to a provided output array. + + Parameters + ---------- + re1: number + Real component of the first complex number. + + im1: number + Imaginary component of the first complex number. + + re2: number + Real component of the second complex number. + + im2: number + Imaginary component of the second complex number. + + re3: number + Real component of the third complex number. + + im3: number + Imaginary component of the third complex number. + + out: ArrayLikeObject + Output array. + + strideOut: integer + Stride length. + + offsetOut: integer + Starting index. + + Returns + ------- + out: ArrayLikeObject + Output array. + + Examples + -------- + > var out = new {{alias:@stdlib/array/float32}}( 2 ); + > {{alias}}.assign( 5.0, 3.0, -2.0, 1.0, 5.0, 3.0, out, 1, 0 ) + [ 8.0, 7.0 ] + + +{{alias}}.strided( z1, sz1, oz1, z2, sz2, oz2, z3, sz3, oz3, out, so, oo ) + Computes the sum of three single-precision complex floating-point numbers + stored in real-valued strided array views and assigns results to a provided + strided output array. + + Parameters + ---------- + z1: ArrayLikeObject + First complex number view. + + sz1: integer + Stride length for `z1`. + + oz1: integer + Starting index for `z1`. + + z2: ArrayLikeObject + Second complex number view. + + sz2: integer + Stride length for `z2`. + + oz2: integer + Starting index for `z2`. + + z3: ArrayLikeObject + Third complex number view. + + sz3: integer + Stride length for `z3`. + + oz3: integer + Starting index for `z3`. + + out: ArrayLikeObject + Output array. + + so: integer + Stride length for `out`. + + oo: integer + Starting index for `out`. + + Returns + ------- + out: ArrayLikeObject + Output array. + + Examples + -------- + > var z1 = new {{alias:@stdlib/array/float32}}( [ 5.0, 3.0 ] ); + > var z2 = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0 ] ); + > var z3 = new {{alias:@stdlib/array/float32}}( [ 5.0, 3.0 ] ); + > var out = new {{alias:@stdlib/array/float32}}( 2 ); + > {{alias}}.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ) + [ 8.0, 7.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float32/base/add3/docs/types/index.d.ts new file mode 100644 index 000000000000..28f221835569 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/docs/types/index.d.ts @@ -0,0 +1,145 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +import { Complex64 } from '@stdlib/types/complex'; +import { Collection, NumericArray } from '@stdlib/types/array'; + +/** +* Interface for summing three single-precision complex floating-point numbers. +*/ +interface Add { + /** + * Computes the sum of three single-precision complex floating-point numbers. + * + * @param z1 - first complex number + * @param z2 - second complex number + * @param z3 - third complex number + * @returns result + * + * @example + * var Complex64 = require( '@stdlib/complex/float32/ctor' ); + * + * var z = new Complex64( 5.0, 3.0 ); + * + * var out = add( z, z, z ); + * // returns [ 15.0, 9.0 ] + */ + ( z1: Complex64, z2: Complex64, z3: Complex64 ): Complex64; + + /** + * Computes the sum of three single-precision complex floating-point numbers and assigns results to a provided output array. + * + * @param re1 - real component of the first complex number + * @param im1 - imaginary component of the first complex number + * @param re2 - real component of the second complex number + * @param im2 - imaginary component of the second complex number + * @param re3 - real component of the third complex number + * @param im3 - imaginary component of the third complex number + * @param out - output array + * @param strideOut - stride length + * @param offsetOut - starting index + * @returns output array + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var out = new Float32Array( 2 ); + * var v = add.assign( 5.0, 3.0, 5.0, 3.0, 5.0, 3.0, out, 1, 0 ); + * // returns [ 15.0, 9.0 ] + * + * var bool = ( out === v ); + * // returns true + */ + assign>( re1: number, im1: number, re2: number, im2: number, re3: number, im3: number, out: T, strideOut: number, offsetOut: number ): T; + + /** + * Computes the sum of three single-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array. + * + * @param z1 - first complex number view + * @param strideZ1 - stride length for `z1` + * @param offsetZ1 - starting index for `z1` + * @param z2 - second complex number view + * @param strideZ2 - stride length for `z2` + * @param offsetZ2 - starting index for `z2` + * @param z3 - third complex number view + * @param strideZ3 - stride length for `z3` + * @param offsetZ3 - starting index for `z3` + * @param out - output array + * @param strideOut - stride length for `out` + * @param offsetOut - starting index for `out` + * @returns output array + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var z1 = new Float32Array( [ 5.0, 3.0 ] ); + * var z2 = new Float32Array( [ 5.0, 3.0 ] ); + * var z3 = new Float32Array( [ 5.0, 3.0 ] ); + * + * var out = add.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, new Float32Array( 2 ), 1, 0 ); + * // returns [ 15.0, 9.0 ] + */ + strided, U extends NumericArray | Collection, V extends NumericArray | Collection, W extends NumericArray | Collection>( z1: T, strideZ1: number, offsetZ1: number, z2: U, strideZ2: number, offsetZ2: number, z3: V, strideZ3: number, offsetZ3: number, out: W, strideOut: number, offsetOut: number ): W; +} + +/** +* Computes the sum of three single-precision complex floating-point numbers. +* +* @param z1 - first complex number +* @param z2 - second complex number +* @param z3 - third complex number +* @returns result +* +* @example +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* +* var z = new Complex64( 5.0, 3.0 ); +* +* var out = add( z, z, z ); +* // returns [ 15.0, 9.0 ] +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var out = new Float32Array( 2 ); +* var v = add.assign( 5.0, 3.0, 5.0, 3.0, 5.0, 3.0, out, 1, 0 ); +* // returns [ 15.0, 9.0 ] +* +* var bool = ( out === v ); +* // returns true +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var z1 = new Float32Array( [ 5.0, 3.0 ] ); +* var z2 = new Float32Array( [ 5.0, 3.0 ] ); +* var z3 = new Float32Array( [ 5.0, 3.0 ] ); +* +* var out = add.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, new Float32Array( 2 ), 1, 0 ); +* // returns [ 15.0, 9.0 ] +*/ +declare var add: Add; + + +// EXPORTS // + +export = add; diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/docs/types/test.ts b/lib/node_modules/@stdlib/complex/float32/base/add3/docs/types/test.ts new file mode 100644 index 000000000000..80765ac42041 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/docs/types/test.ts @@ -0,0 +1,465 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import Complex64 = require( '@stdlib/complex/float32/ctor' ); +import add3 = require( './index' ); + + +// TESTS // + +// The function returns a complex number... +{ + const z = new Complex64( 1.0, 1.0 ); + + add3( z, z, z ); // $ExpectType Complex64 +} + +// The compiler throws an error if the function is provided a first argument which is not a complex number... +{ + const z = new Complex64( 1.0, 1.0 ); + + add3( true, z, z ); // $ExpectError + add3( false, z, z ); // $ExpectError + add3( null, z, z ); // $ExpectError + add3( undefined, z, z ); // $ExpectError + add3( '5', z, z ); // $ExpectError + add3( [], z, z ); // $ExpectError + add3( {}, z, z ); // $ExpectError + add3( ( x: number ): number => x, z, z ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a complex number... +{ + const z = new Complex64( 1.0, 1.0 ); + + add3( z, true, z ); // $ExpectError + add3( z, false, z ); // $ExpectError + add3( z, null, z ); // $ExpectError + add3( z, undefined, z ); // $ExpectError + add3( z, '5', z ); // $ExpectError + add3( z, [], z ); // $ExpectError + add3( z, {}, z ); // $ExpectError + add3( z, ( x: number ): number => x, z ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a complex number... +{ + const z = new Complex64( 1.0, 1.0 ); + + add3( z, z, true ); // $ExpectError + add3( z, z, false ); // $ExpectError + add3( z, z, null ); // $ExpectError + add3( z, z, undefined ); // $ExpectError + add3( z, z, '5' ); // $ExpectError + add3( z, z, [] ); // $ExpectError + add3( z, z, {} ); // $ExpectError + add3( z, z, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const z = new Complex64( 1.0, 1.0 ); + + add3(); // $ExpectError + add3( z ); // $ExpectError + add3( z, z ); // $ExpectError + add3( z, z, z, z ); // $ExpectError +} + +// Attached to the main export is an `assign` method which returns a collection... +{ + add3.assign( 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, new Float32Array( 2 ), 1, 0 ); // $ExpectType Float32Array + add3.assign( 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, [ 0.0, 0.0 ], 1, 0 ); // $ExpectType number[] +} + +// The compiler throws an error if the `assign` method is provided a first argument which is not a number... +{ + const out = new Float32Array( 2 ); + + add3.assign( true, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( false, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( null, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( undefined, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( '5', 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( [], 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( {}, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( ( x: number ): number => x, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a second argument which is not a number... +{ + const out = new Float32Array( 2 ); + + add3.assign( 1.0, true, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, false, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, null, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, undefined, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, '5', 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, [], 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, {}, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, ( x: number ): number => x, 3.0, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a third argument which is not a number... +{ + const out = new Float32Array( 2 ); + + add3.assign( 1.0, 2.0, true, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, false, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, null, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, undefined, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, '5', 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, [], 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, {}, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, ( x: number ): number => x, 4.0, 5.0, 6.0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a fourth argument which is not a number... +{ + const out = new Float32Array( 2 ); + + add3.assign( 1.0, 2.0, 3.0, true, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, false, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, null, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, undefined, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, '5', 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, [], 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, {}, 5.0, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, ( x: number ): number => x, 5.0, 6.0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... +{ + const out = new Float32Array( 2 ); + + add3.assign( 1.0, 2.0, 3.0, 4.0, true, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, false, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, null, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, undefined, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, '5', 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, [], 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, {}, 6.0, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, ( x: number ): number => x, 6.0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... +{ + const out = new Float32Array( 2 ); + + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, true, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, false, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, null, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, undefined, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, '5', out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, [], out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, {}, out, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, ( x: number ): number => x, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a seventh argument which is not a collection... +{ + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 1, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, true, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, false, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, null, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, undefined, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, '5', 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, [ '5' ], 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, {}, 1, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided an eighth argument which is not a number... +{ + const out = new Float32Array( 2 ); + + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, true, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, false, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, null, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, undefined, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, '5', 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, [], 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, {}, 0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a ninth argument which is not a number... +{ + const out = new Float32Array( 2 ); + + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, true ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, false ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, null ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, undefined ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, '5' ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, [] ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, {} ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... +{ + const out = new Float32Array( 2 ); + + add3.assign(); // $ExpectError + add3.assign( 1.0 ); // $ExpectError + add3.assign( 1.0, 2.0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1 ); // $ExpectError + add3.assign( 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out, 1, 0, {} ); // $ExpectError +} + +// Attached to the main export is a `strided` method which returns a collection... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, new Float32Array( 2 ), 1, 0 ); // $ExpectType Float32Array + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, [ 0.0, 0.0 ], 1, 0 ); // $ExpectType number[] +} + +// The compiler throws an error if the `strided` method is provided a first argument which is not a collection... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( true, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( false, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( null, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( undefined, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( '5', 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( [ '5' ], 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( {}, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( ( x: number ): number => x, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a second argument which is not a number... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, true, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, false, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, null, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, undefined, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, '5', 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, [], 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, {}, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, ( x: number ): number => x, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a third argument which is not a number... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, true, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, false, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, null, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, undefined, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, '5', z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, [], z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, {}, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, ( x: number ): number => x, z2, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a fourth argument which is not a collection... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, true, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, false, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, null, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, undefined, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, '5', 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, [ '5' ], 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, {}, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, ( x: number ): number => x, 1, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a fifth argument which is not a number... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, true, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, false, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, null, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, undefined, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, '5', 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, [], 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, {}, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, ( x: number ): number => x, 0, z3, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a sixth argument which is not a number... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, 1, true, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, false, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, null, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, undefined, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, '5', z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, [], z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, {}, z3, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, ( x: number ): number => x, z3, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a seventh argument which is not a collection... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, 1, 0, true, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, false, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, null, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, undefined, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, '5', 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, [ '5' ], 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, {}, 1, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, ( x: number ): number => x, 1, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided an eighth argument which is not a number... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, 1, 0, z3, true, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, false, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, null, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, undefined, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, '5', 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, [], 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, {}, 0, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, ( x: number ): number => x, 0, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a ninth argument which is not a number... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, true, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, false, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, null, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, undefined, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, '5', out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, [], out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, {}, out, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, ( x: number ): number => x, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a tenth argument which is not a collection... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, 1, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, true, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, false, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, null, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, undefined, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, '5', 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, [ '5' ], 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, {}, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided an eleventh argument which is not a number... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, true, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, false, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, null, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, undefined, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, '5', 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, [], 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, {}, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided a twelfth argument which is not a number... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, true ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, false ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, null ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, undefined ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, '5' ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, [] ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, {} ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `strided` method is provided an unsupported number of arguments... +{ + const z1 = new Float32Array( 2 ); + const z2 = new Float32Array( z1.length ); + const z3 = new Float32Array( z1.length ); + const out = new Float32Array( z1.length ); + + add3.strided(); // $ExpectError + add3.strided( z1 ); // $ExpectError + add3.strided( z1, 1 ); // $ExpectError + add3.strided( z1, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1 ); // $ExpectError + add3.strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0, {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/examples/c/Makefile b/lib/node_modules/@stdlib/complex/float32/base/add3/examples/c/Makefile new file mode 100644 index 000000000000..c8f8e9a1517b --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# 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/complex/float32/base/add3/examples/c/example.c b/lib/node_modules/@stdlib/complex/float32/base/add3/examples/c/example.c new file mode 100644 index 000000000000..3e108ea07b22 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/examples/c/example.c @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/complex/float32/base/add3.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/reim.h" +#include + +int main( void ) { + const stdlib_complex64_t x[] = { + stdlib_complex64( 3.14f, 1.5f ), + stdlib_complex64( -3.14f, 1.5f ), + stdlib_complex64( 0.0f, -0.0f ), + stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f ) + }; + + stdlib_complex64_t v; + stdlib_complex64_t y; + float re; + float im; + int i; + for ( i = 0; i < 4; i++ ) { + v = x[ i ]; + stdlib_complex64_reim( v, &re, &im ); + printf( "z = %f + %fi\n", re, im ); + + y = stdlib_base_complex64_add3( v, v, v ); + stdlib_complex64_reim( y, &re, &im ); + printf( "add3(z, z, z) = %f + %fi\n", re, im ); + } +} diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/examples/index.js b/lib/node_modules/@stdlib/complex/float32/base/add3/examples/index.js new file mode 100644 index 000000000000..de84735392a6 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/examples/index.js @@ -0,0 +1,32 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var Complex64Array = require( '@stdlib/array/complex64' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var add3 = require( './../lib' ); + +// Generate arrays of random values: +var z1 = new Complex64Array( discreteUniform( 200, -50, 50 ) ); +var z2 = new Complex64Array( discreteUniform( 200, -50, 50 ) ); +var z3 = new Complex64Array( discreteUniform( 200, -50, 50 ) ); + +// Perform element-wise addition: +logEachMap( '(%s) + (%s) + (%s) = %s', z1, z2, z3, add3 ); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/include.gypi b/lib/node_modules/@stdlib/complex/float32/base/add3/include.gypi new file mode 100644 index 000000000000..bee8d41a2caf --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# 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': [ + '[ 8.0, 7.0 ] +*/ +function assign( re1, im1, re2, im2, re3, im3, out, strideOut, offsetOut ) { + out[ offsetOut ] = float64ToFloat32( re1 + re2 + re3 ); + out[ offsetOut+strideOut ] = float64ToFloat32( im1 + im2 + im3 ); + return out; +} + + +// EXPORTS // + +module.exports = assign; diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/lib/index.js b/lib/node_modules/@stdlib/complex/float32/base/add3/lib/index.js new file mode 100644 index 000000000000..f8a74eada33c --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/lib/index.js @@ -0,0 +1,54 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Compute the sum of three single-precision complex floating-point numbers. +* +* @module @stdlib/complex/float32/base/add3 +* +* @example +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* var add3 = require( '@stdlib/complex/float32/base/add3' ); +* +* var z = new Complex64( 5.0, 3.0 ); +* +* var out = add3( z, z, z ); +* // returns [ 15.0, 9.0 ] +*/ + +// MODULES // + +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var main = require( './main.js' ); +var assign = require( './assign.js' ); +var strided = require( './strided.js' ); + + +// MAIN // + +setReadOnly( main, 'assign', assign ); +setReadOnly( main, 'strided', strided ); + + +// EXPORTS // + +module.exports = main; + +// exports: { "assign": "main.assign", "strided": "main.strided" } diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/lib/main.js b/lib/node_modules/@stdlib/complex/float32/base/add3/lib/main.js new file mode 100644 index 000000000000..169532f61a1a --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/lib/main.js @@ -0,0 +1,56 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var f32 = require( '@stdlib/number/float64/base/to-float32' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); + + +// MAIN // + +/** +* Computes the sum of three single-precision complex floating-point numbers. +* +* @param {Complex64} z1 - first complex number +* @param {Complex64} z2 - second complex number +* @param {Complex64} z3 - third complex number +* @returns {Complex64} result +* +* @example +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* +* var z = new Complex64( 5.0, 3.0 ); +* +* var out = add3( z, z, z ); +* // returns [ 15.0, 9.0 ] +*/ +function add3( z1, z2, z3 ) { + var re = f32( realf( z1 ) + realf( z2 ) + realf( z3 ) ); + var im = f32( imagf( z1 ) + imagf( z2 ) + imagf( z3 ) ); + return new Complex64( re, im ); +} + + +// EXPORTS // + +module.exports = add3; diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/lib/native.js b/lib/node_modules/@stdlib/complex/float32/base/add3/lib/native.js new file mode 100644 index 000000000000..5003bac386b2 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/lib/native.js @@ -0,0 +1,54 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Computes the sum of three single-precision complex floating-point numbers. +* +* @private +* @param {Complex64} z1 - first complex number +* @param {Complex64} z2 - second complex number +* @param {Complex64} z3 - third complex number +* @returns {Complex64} result +* +* @example +* var Complex64 = require( '@stdlib/complex/float32/ctor' ); +* +* var z = new Complex64( 5.0, 3.0 ); +* +* var out = add3( z, z, z ); +* // returns [ 15.0, 9.0 ] +*/ +function add3( z1, z2, z3 ) { + var v = addon( z1, z2, z3 ); + return new Complex64( v.re, v.im ); +} + + +// EXPORTS // + +module.exports = add3; diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/lib/strided.js b/lib/node_modules/@stdlib/complex/float32/base/add3/lib/strided.js new file mode 100755 index 000000000000..532cef0e7a24 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/lib/strided.js @@ -0,0 +1,64 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); + + +// MAIN // + +/** +* Computes the sum of three single-precision complex floating-point numbers stored in real-valued strided array views and assigns results to a provided strided output array. +* +* @param {Float32Array} z1 - first complex number view +* @param {integer} strideZ1 - stride length for `z1` +* @param {NonNegativeInteger} offsetZ1 - starting index for `z1` +* @param {Float32Array} z2 - second complex number view +* @param {integer} strideZ2 - stride length for `z2` +* @param {NonNegativeInteger} offsetZ2 - starting index for `z2` +* @param {Float32Array} z3 - third complex number view +* @param {integer} strideZ3 - stride length for `z3` +* @param {NonNegativeInteger} offsetZ3 - starting index for `z3` +* @param {Collection} out - output array +* @param {integer} strideOut - stride length for `out` +* @param {NonNegativeInteger} offsetOut - starting index for `out` +* @returns {Collection} output array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var z1 = new Float32Array( [ 5.0, 3.0 ] ); +* var z2 = new Float32Array( [ -2.0, 1.0 ] ); +* var z3 = new Float32Array( [ 5.0, 3.0 ] ); +* +* var out = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, new Float32Array( 2 ), 1, 0 ); +* // returns [ 8.0, 7.0 ] +*/ +function strided( z1, strideZ1, offsetZ1, z2, strideZ2, offsetZ2, z3, strideZ3, offsetZ3, out, strideOut, offsetOut ) { // eslint-disable-line max-len, max-params + out[ offsetOut ] = float64ToFloat32( z1[ offsetZ1 ] + z2[ offsetZ2 ] + z3[ offsetZ3 ] ); // eslint-disable-line max-len + out[ offsetOut+strideOut ] = float64ToFloat32( z1[ offsetZ1+strideZ1 ] + z2[ offsetZ2+strideZ2 ] + z3[ offsetZ3+strideZ3 ] ); // eslint-disable-line max-len + return out; +} + + +// EXPORTS // + +module.exports = strided; diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/manifest.json b/lib/node_modules/@stdlib/complex/float32/base/add3/manifest.json new file mode 100644 index 000000000000..c9ec3c3088e7 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/manifest.json @@ -0,0 +1,75 @@ +{ + "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/math/base/napi/ternary", + "@stdlib/complex/float32/ctor", + "@stdlib/complex/float32/reim" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float32/ctor", + "@stdlib/complex/float32/reim" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float32/ctor", + "@stdlib/complex/float32/reim" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/package.json b/lib/node_modules/@stdlib/complex/float32/base/add3/package.json new file mode 100644 index 000000000000..8d896ce2af5d --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/complex/float32/base/add3", + "version": "0.0.0", + "description": "Compute the sum of three single-precision complex floating-point numbers.", + "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", + "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", + "add", + "cadd", + "caddf", + "addition", + "sum", + "arithmetic", + "complex", + "cmplx", + "number" + ] +} diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/src/Makefile b/lib/node_modules/@stdlib/complex/float32/base/add3/src/Makefile new file mode 100644 index 000000000000..2caf905cedbe --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2026 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# 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/complex/float32/base/add3/src/addon.c b/lib/node_modules/@stdlib/complex/float32/base/add3/src/addon.c new file mode 100644 index 000000000000..389b361bcd2b --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/src/addon.c @@ -0,0 +1,22 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/complex/float32/base/add3.h" +#include "stdlib/math/base/napi/ternary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_CCC_C( stdlib_base_complex64_add3 ) diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/src/main.c b/lib/node_modules/@stdlib/complex/float32/base/add3/src/main.c new file mode 100644 index 000000000000..f424d45f320f --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/src/main.c @@ -0,0 +1,64 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/complex/float32/base/add3.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/reim.h" + +/** +* Computes the sum of three single-precision complex floating-point numbers. +* +* @param z1 first input value +* @param z2 second input value +* @param z3 third input value +* @return result +* +* @example +* #include "stdlib/complex/float32/ctor.h" +* #include "stdlib/complex/float32/real.h" +* #include "stdlib/complex/float32/imag.h" +* +* stdlib_complex64_t z = stdlib_complex64( 3.0f, -2.0f ); +* +* stdlib_complex64_t out = stdlib_base_complex64_add3( z, z, z ); +* +* float re = stdlib_complex64_real( out ); +* // returns 9.0f +* +* float im = stdlib_complex64_imag( out ); +* // returns -6.0f +*/ +stdlib_complex64_t stdlib_base_complex64_add3( const stdlib_complex64_t z1, const stdlib_complex64_t z2, const stdlib_complex64_t z3 ) { + float re1; + float im1; + float re2; + float im2; + float re3; + float im3; + float re; + float im; + + stdlib_complex64_reim( z1, &re1, &im1 ); + stdlib_complex64_reim( z2, &re2, &im2 ); + stdlib_complex64_reim( z3, &re3, &im3 ); + + re = re1 + re2 + re3; + im = im1 + im2 + im3; + + return stdlib_complex64( re, im ); +} diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.assign.js b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.assign.js new file mode 100755 index 000000000000..bc20edb0da8d --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.assign.js @@ -0,0 +1,132 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isSameFloat32Array = require( '@stdlib/assert/is-same-float32array' ); +var Float32Array = require( '@stdlib/array/float32' ); +var assign = require( './../lib/assign.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof assign, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function sums three complex numbers', function test( t ) { + var expected; + var out; + var v; + + out = new Float32Array( 2 ); + v = assign( 5.0, 3.0, -2.0, 1.0, 5.0, 3.0, out, 1, 0 ); + + expected = new Float32Array( [ 8.0, 7.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 4 ); + v = assign( 5.0, 3.0, -2.0, 1.0, 5.0, 3.0, out, 2, 0 ); + + expected = new Float32Array( [ 8.0, 0.0, 7.0, 0.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 4 ); + v = assign( 5.0, 3.0, -2.0, 1.0, 5.0, 3.0, out, 2, 1 ); + + expected = new Float32Array( [ 0.0, 8.0, 0.0, 7.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 4 ); + v = assign( 5.0, 3.0, -2.0, 1.0, 5.0, 3.0, out, -2, 3 ); + + expected = new Float32Array( [ 0.0, 7.0, 0.0, 8.0 ] ); + + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if a real or imaginary component is `NaN`, the output component is `NaN`', function test( t ) { + var expected; + var out; + var v; + + out = new Float32Array( 2 ); + expected = new Float32Array( [ NaN, 7.0 ] ); + + v = assign( NaN, 3.0, -2.0, 1.0, 5.0, 3.0, out, 1, 0 ); + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 2 ); + expected = new Float32Array( [ NaN, 7.0 ] ); + + v = assign( 5.0, 3.0, NaN, 1.0, 5.0, 3.0, out, 1, 0 ); + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 2 ); + expected = new Float32Array( [ NaN, 7.0 ] ); + + v = assign( NaN, 3.0, NaN, 1.0, NaN, 3.0, out, 1, 0 ); + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 2 ); + expected = new Float32Array( [ 8.0, NaN ] ); + + v = assign( 5.0, NaN, -2.0, 1.0, 5.0, 3.0, out, 1, 0 ); + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 2 ); + expected = new Float32Array( [ 8.0, NaN ] ); + + v = assign( 5.0, 3.0, -2.0, NaN, 5.0, 3.0, out, 1, 0 ); + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 2 ); + expected = new Float32Array( [ 8.0, NaN ] ); + + v = assign( 5.0, NaN, -2.0, NaN, 5.0, NaN, out, 1, 0 ); + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + out = new Float32Array( 2 ); + expected = new Float32Array( [ NaN, NaN ] ); + + v = assign( NaN, NaN, NaN, NaN, NaN, NaN, out, 1, 0 ); + t.strictEqual( v, out, 'returns expected value' ); + t.strictEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.js b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.js new file mode 100644 index 000000000000..6bb8d9bf2a0d --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.js @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isMethod = require( '@stdlib/assert/is-method' ); +var add3 = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof add3, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'attached to the main export is an `assign` method', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( isMethod( add3, 'assign' ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the main export is a `strided` method', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( isMethod( add3, 'strided' ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.main.js b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.main.js new file mode 100755 index 000000000000..c67bb1a6f33b --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.main.js @@ -0,0 +1,120 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); +var add3 = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof add3, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function sums three complex numbers', function test( t ) { + var z1; + var z2; + var z3; + var v; + + z1 = new Complex64( 5.0, 3.0 ); + z2 = new Complex64( -2.0, 1.0 ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + + t.strictEqual( realf( v ), 8.0, 'returns expected value' ); + t.strictEqual( imagf( v ), 7.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if a real or imaginary component is `NaN`, the resulting component is `NaN`', function test( t ) { + var z1; + var z2; + var z3; + var v; + + z1 = new Complex64( NaN, 3.0 ); + z2 = new Complex64( -2.0, 1.0 ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( isnanf( realf( v ) ), true, 'returns expected value' ); + t.strictEqual( imagf( v ), 7.0, 'returns expected value' ); + + z1 = new Complex64( 5.0, 3.0 ); + z2 = new Complex64( NaN, 1.0 ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( isnanf( realf( v ) ), true, 'returns expected value' ); + t.strictEqual( imagf( v ), 7.0, 'returns expected value' ); + + z1 = new Complex64( NaN, 3.0 ); + z2 = new Complex64( NaN, 1.0 ); + z3 = new Complex64( NaN, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( isnanf( realf( v ) ), true, 'returns expected value' ); + t.strictEqual( imagf( v ), 7.0, 'returns expected value' ); + + z1 = new Complex64( 5.0, NaN ); + z2 = new Complex64( -2.0, 1.0 ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( realf( v ), 8.0, 'returns expected value' ); + t.strictEqual( isnanf( imagf( v ) ), true, 'returns expected value' ); + + z1 = new Complex64( 5.0, 3.0 ); + z2 = new Complex64( -2.0, NaN ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( realf( v ), 8.0, 'returns expected value' ); + t.strictEqual( isnanf( imagf( v ) ), true, 'returns expected value' ); + + z1 = new Complex64( 5.0, NaN ); + z2 = new Complex64( -2.0, NaN ); + z3 = new Complex64( 5.0, NaN ); + + v = add3( z1, z2, z3 ); + t.strictEqual( realf( v ), 8.0, 'returns expected value' ); + t.strictEqual( isnanf( imagf( v ) ), true, 'returns expected value' ); + + z1 = new Complex64( NaN, NaN ); + z2 = new Complex64( NaN, NaN ); + z3 = new Complex64( NaN, NaN ); + + v = add3( z1, z2, z3 ); + t.strictEqual( isnanf( realf( v ) ), true, 'returns expected value' ); + t.strictEqual( isnanf( imagf( v ) ), true, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.native.js b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.native.js new file mode 100644 index 000000000000..efc72856f899 --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.native.js @@ -0,0 +1,129 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var add3 = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( add3 instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof add3, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function sums three complex numbers', opts, function test( t ) { + var z1; + var z2; + var z3; + var v; + + z1 = new Complex64( 5.0, 3.0 ); + z2 = new Complex64( -2.0, 1.0 ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + + t.strictEqual( realf( v ), 8.0, 'returns expected value' ); + t.strictEqual( imagf( v ), 7.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if a real or imaginary component is `NaN`, the resulting component is `NaN`', opts, function test( t ) { + var z1; + var z2; + var z3; + var v; + + z1 = new Complex64( NaN, 3.0 ); + z2 = new Complex64( -2.0, 1.0 ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( isnanf( realf( v ) ), true, 'returns expected value' ); + t.strictEqual( imagf( v ), 7.0, 'returns expected value' ); + + z1 = new Complex64( 5.0, 3.0 ); + z2 = new Complex64( NaN, 1.0 ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( isnanf( realf( v ) ), true, 'returns expected value' ); + t.strictEqual( imagf( v ), 7.0, 'returns expected value' ); + + z1 = new Complex64( NaN, 3.0 ); + z2 = new Complex64( NaN, 1.0 ); + z3 = new Complex64( NaN, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( isnanf( realf( v ) ), true, 'returns expected value' ); + t.strictEqual( imagf( v ), 7.0, 'returns expected value' ); + + z1 = new Complex64( 5.0, NaN ); + z2 = new Complex64( -2.0, 1.0 ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( realf( v ), 8.0, 'returns expected value' ); + t.strictEqual( isnanf( imagf( v ) ), true, 'returns expected value' ); + + z1 = new Complex64( 5.0, 3.0 ); + z2 = new Complex64( -2.0, NaN ); + z3 = new Complex64( 5.0, 3.0 ); + + v = add3( z1, z2, z3 ); + t.strictEqual( realf( v ), 8.0, 'returns expected value' ); + t.strictEqual( isnanf( imagf( v ) ), true, 'returns expected value' ); + + z1 = new Complex64( 5.0, NaN ); + z2 = new Complex64( -2.0, NaN ); + z3 = new Complex64( 5.0, NaN ); + + v = add3( z1, z2, z3 ); + t.strictEqual( realf( v ), 8.0, 'returns expected value' ); + t.strictEqual( isnanf( imagf( v ) ), true, 'returns expected value' ); + + z1 = new Complex64( NaN, NaN ); + z2 = new Complex64( NaN, NaN ); + z3 = new Complex64( NaN, NaN ); + + v = add3( z1, z2, z3 ); + t.strictEqual( isnanf( realf( v ) ), true, 'returns expected value' ); + t.strictEqual( isnanf( imagf( v ) ), true, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.strided.js b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.strided.js new file mode 100755 index 000000000000..cc7aa771181d --- /dev/null +++ b/lib/node_modules/@stdlib/complex/float32/base/add3/test/test.strided.js @@ -0,0 +1,171 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isSameFloat32Array = require( '@stdlib/assert/is-same-float32array' ); +var Float32Array = require( '@stdlib/array/float32' ); +var strided = require( './../lib/strided.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof strided, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function sums three complex numbers', function test( t ) { + var expected; + var out; + var z1; + var z2; + var z3; + var v; + + z1 = new Float32Array( [ 5.0, 3.0 ] ); + z2 = new Float32Array( [ -2.0, 1.0 ] ); + z3 = new Float32Array( [ 5.0, 3.0 ] ); + out = new Float32Array( 2 ); + v = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); + + expected = new Float32Array( [ 8.0, 7.0 ] ); + + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ 5.0, 0.0, 3.0, 0.0 ] ); + z2 = new Float32Array( [ -2.0, 1.0 ] ); + z3 = new Float32Array( [ 5.0, 3.0 ] ); + out = new Float32Array( 4 ); + v = strided( z1, 2, 0, z2, 1, 0, z3, 1, 0, out, 2, 0 ); + + expected = new Float32Array( [ 8.0, 0.0, 7.0, 0.0 ] ); + + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ 5.0, 3.0 ] ); + z2 = new Float32Array( [ 0.0, -2.0, 0.0, 1.0 ] ); + z3 = new Float32Array( [ 5.0, 3.0 ] ); + out = new Float32Array( 4 ); + v = strided( z1, 1, 0, z2, 2, 1, z3, 1, 0, out, 2, 1 ); + + expected = new Float32Array( [ 0.0, 8.0, 0.0, 7.0 ] ); + + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ 3.0, 5.0 ] ); + z2 = new Float32Array( [ 1.0, -2.0 ] ); + z3 = new Float32Array( [ 3.0, 5.0 ] ); + out = new Float32Array( 4 ); + v = strided( z1, -1, 1, z2, -1, 1, z3, -1, 1, out, -2, 3 ); + + expected = new Float32Array( [ 0.0, 7.0, 0.0, 8.0 ] ); + + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if a real or imaginary component is `NaN`, the output component is `NaN`', function test( t ) { + var expected; + var out; + var z1; + var z2; + var z3; + var v; + + z1 = new Float32Array( [ NaN, 3.0 ] ); + z2 = new Float32Array( [ -2.0, 1.0 ] ); + z3 = new Float32Array( [ 5.0, 3.0 ] ); + out = new Float32Array( 2 ); + expected = new Float32Array( [ NaN, 7.0 ] ); + + v = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ 5.0, 3.0 ] ); + z2 = new Float32Array( [ NaN, 1.0 ] ); + z3 = new Float32Array( [ 5.0, 3.0 ] ); + out = new Float32Array( 2 ); + expected = new Float32Array( [ NaN, 7.0 ] ); + + v = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ NaN, 3.0 ] ); + z2 = new Float32Array( [ NaN, 1.0 ] ); + z3 = new Float32Array( [ NaN, 3.0 ] ); + out = new Float32Array( 2 ); + expected = new Float32Array( [ NaN, 7.0 ] ); + + v = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ 5.0, NaN ] ); + z2 = new Float32Array( [ -2.0, 1.0 ] ); + z3 = new Float32Array( [ 5.0, 3.0 ] ); + out = new Float32Array( 2 ); + expected = new Float32Array( [ 8.0, NaN ] ); + + v = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ 5.0, 3.0 ] ); + z2 = new Float32Array( [ -2.0, NaN ] ); + z3 = new Float32Array( [ 5.0, 3.0 ] ); + out = new Float32Array( 2 ); + expected = new Float32Array( [ 8.0, NaN ] ); + + v = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ 5.0, NaN ] ); + z2 = new Float32Array( [ -2.0, NaN ] ); + z3 = new Float32Array( [ 5.0, NaN ] ); + out = new Float32Array( 2 ); + expected = new Float32Array( [ 8.0, NaN ] ); + + v = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + z1 = new Float32Array( [ NaN, NaN ] ); + z2 = new Float32Array( [ NaN, NaN ] ); + z3 = new Float32Array( [ NaN, NaN ] ); + out = new Float32Array( 2 ); + expected = new Float32Array( [ NaN, NaN ] ); + + v = strided( z1, 1, 0, z2, 1, 0, z3, 1, 0, out, 1, 0 ); + t.deepEqual( v, out, 'returns expected value' ); + t.deepEqual( isSameFloat32Array( out, expected ), true, 'returns expected value' ); + + t.end(); +});