From 01c52aba821909c8373f9f753ee155582ba07257 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Tue, 14 Mar 2023 16:15:18 -0500 Subject: [PATCH 1/4] remove: remove out keyword and add support for Complex128 data type in cexp BREAKING CHANGE: out keyword no longer supported, now downstream libraries need to create a complex dtype to use this API --- .../@stdlib/math/base/special/cexp/README.md | 40 ++-- .../base/special/cexp/benchmark/benchmark.js | 45 ++--- .../math/base/special/cexp/docs/repl.txt | 42 ++--- .../base/special/cexp/docs/types/index.d.ts | 52 +++--- .../math/base/special/cexp/docs/types/test.ts | 48 ++--- .../math/base/special/cexp/examples/index.js | 6 +- .../math/base/special/cexp/lib/cexp.js | 87 --------- .../math/base/special/cexp/lib/index.js | 22 +-- .../math/base/special/cexp/lib/main.js | 87 +++++++-- .../math/base/special/cexp/package.json | 2 +- .../math/base/special/cexp/test/test.js | 175 ++++++++++-------- 11 files changed, 265 insertions(+), 341 deletions(-) delete mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/lib/cexp.js diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/README.md b/lib/node_modules/@stdlib/math/base/special/cexp/README.md index da53b36fccd9..127fa0b27d6e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cexp/README.md @@ -20,9 +20,9 @@ limitations under the License. # exp -> Compute the [exponential][exponential-function] function of a complex number. +> Compute the [exponential][exponential-function] function of double-precision complex floating-point number. -
+
The [exponential][exponential-function] function of a complex number is defined as @@ -51,30 +51,32 @@ The [exponential][exponential-function] function of a complex number is defined var cexp = require( '@stdlib/math/base/special/cexp' ); ``` -#### cexp( \[out,] re, im ) +#### cexp( z ) -Evaluates the [exponential][exponential-function] function with a `complex` argument comprised of a **real** component `re` and an **imaginary** component `im`. +Evaluates the [exponential][exponential-function] function with a double-precision complex floating-point number. ```javascript -var v = cexp( 0.0, 0.0 ); -// returns [ 1.0, 0.0 ] +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); -v = cexp( 0.0, 1.0 ); -// returns [ ~0.540, ~0.841 ] -``` +var v = cexp( new Complex128( 0.0, 0.0 ) ); +// returns -By default, the function returns real and imaginary components as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object. +var re = real( v ); +// returns 1.0 -```javascript -var Float64Array = require( '@stdlib/array/float64' ); +var im = imag( v ); +// returns 0.0 -var out = new Float64Array( 2 ); +v = cexp( new Complex128( 0.0, 1.0 ) ); +// returns -var v = cexp( out, 0.0, 1.0 ); -// returns [ ~0.540, ~0.841 ] +re = real( v ); +// returns ~0.540 -var bool = ( v === out ); -// returns true +im = imag( v ); +// returns ~0.841 ```
@@ -99,7 +101,6 @@ var re; var im; var z1; var z2; -var o; var i; for ( i = 0; i < 100; i++ ) { @@ -107,8 +108,7 @@ for ( i = 0; i < 100; i++ ) { im = round( randu()*100.0 ) - 50.0; z1 = new Complex128( re, im ); - o = cexp( real(z1), imag(z1) ); - z2 = new Complex128( o[ 0 ], o[ 1 ] ); + z2 = cexp( z1 ); console.log( 'cexp(%s) = %s', z1.toString(), z2.toString() ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.js index 0f1d94f6de1c..0130f19e4c59 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.js @@ -21,8 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); -var isArray = require( '@stdlib/assert/is-array' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Complex128 = require( '@stdlib/complex/float64' ); var pkg = require( './../package.json' ).name; var cexp = require( './../lib' ); @@ -30,48 +31,24 @@ var cexp = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { - var re; - var im; + var values; var y; var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - re = ( randu()*100.0 ) - 50.0; - im = ( randu()*100.0 ) - 50.0; - y = cexp( re, im ); - if ( y.length === 0 ) { - b.fail( 'should not be empty' ); - } - } - b.toc(); - if ( !isArray( y ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse', function benchmark( b ) { - var out; - var re; - var im; - var y; - var i; - - out = new Array( 2 ); + values = [ + new Complex128( uniform( -50.0, 50.0 ), uniform( -50.0, 50.0 ) ), + new Complex128( uniform( -50.0, 50.0 ), uniform( -50.0, 50.0 ) ) + ]; b.tic(); for ( i = 0; i < b.iterations; i++ ) { - re = ( randu()*100.0 ) - 50.0; - im = ( randu()*100.0 ) - 50.0; - y = cexp( out, re, im ); - if ( y.length === 0 ) { + y = cexp( values[ i%values.length ] ); + if ( isnan( y ) ) { b.fail( 'should not be empty' ); } } b.toc(); - if ( !isArray( y ) ) { + if ( isnan( y ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt index a922294f6ba5..cf205d280cdb 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt @@ -1,36 +1,32 @@ -{{alias}}( [out,] re, im ) - Computes the exponential function of a complex number. +{{alias}}( z ) + Computes the exponential function of a double-precision complex + floating-point number. Parameters ---------- - out: Array|TypedArray|Object (optional) - Output array. - - re: number - Real component. - - im: number - Imaginary component. + z: Complex128 + Complex number. Returns ------- - out: Array|TypedArray|Object - Real and imaginary components. + out: Complex128 + Complex number. Examples -------- - > var y = {{alias}}( 0.0, 0.0 ) - [ 1.0, 0.0 ] - - > y = {{alias}}( 0.0, 1.0 ) - [ ~0.540, ~0.841 ] - - > var out = new {{alias:@stdlib/array/float64}}( 2 ); - > var v = {{alias}}( out, 0.0, 1.0 ) - [ ~0.540, ~0.841 ] - > var bool = ( v === out ) - true + > var y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 0.0, 0.0 ) ) + + > var re = {{alias:@stdlib/complex/real}}( y ) + 1.0 + > var im = {{alias:@stdlib/complex/imag}}( y ) + 0.0 + > y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 0.0, 1.0 ) ) + + > var re = {{alias:@stdlib/complex/real}}( y ) + ~0.540 + > var im = {{alias:@stdlib/complex/imag}}( y ) + ~0.841 See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/index.d.ts index 636085591b39..b297f48e58ad 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/index.d.ts @@ -20,45 +20,43 @@ /// -import { ArrayLike } from '@stdlib/types/array'; +import { Complex128 } from '@stdlib/types/object'; /** -* Computes the exponential function of a complex number. +* Computes the exponential function of a double-precision complex floating-point number. * -* @param out - output array -* @param re - real component -* @param im - imaginary component -* @returns real and imaginary components +* @param z - complex number +* @returns result * * @example -* var Float32Array = require( `@stdlib/array/float32` ); +* var Complex128 = require( `@stdlib/complex/float64` ); +* var real = require( `@stdlib/complex/real` ); +* var imag = require( `@stdlib/complex/imag` ); * -* var out = new Float32Array( 2 ); +* var v = cexp( new Complex128( 0.0, 0.0 ) ); +* // returns * -* var v = cexp( out, 0.0, 1.0 ); -* // returns [ ~0.540, ~0.841 ] +* var re = real( v ); +* // returns 1.0 * -* var bool = ( v === out ); -* // returns true -*/ -declare function cexp( out: ArrayLike, re: number, im: number ): ArrayLike; // tslint-disable-line max-line-length - -/** -* Computes the exponential function of a complex number. -* -* @param re - real component -* @param im - imaginary component -* @returns real and imaginary components +* var im = imag( v ); +* // returns 0.0 * * @example -* var v = cexp( 0.0, 0.0 ); -* // returns [ 1.0, 0.0 ] +* var Complex128 = require( `@stdlib/complex/float64` ); +* var real = require( `@stdlib/complex/real` ); +* var imag = require( `@stdlib/complex/imag` ); * -* @example -* var v = cexp( 1.0, 0.0 ); -* // returns [ ~2.718, 0.0 ] +* var v = cexp( new Complex128( 1.0, 0.0 ) ); +* // returns +* +* var re = real( v ); +* // returns ~2.718 +* +* var im = imag( v ); +* // returns 0.0 */ -declare function cexp( re: number, im: number ): ArrayLike; +declare function cexp( z: Complex128 ): Complex128; // EXPORTS // diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/test.ts index fdf1ce056d3f..46820cc42abf 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/test.ts @@ -16,53 +16,31 @@ * limitations under the License. */ +import Complex128 = require( '@stdlib/complex/float64' ); import cexp = require( './index' ); // TESTS // -// The function returns an array of numbers... +// The function returns a complex number... { - cexp( 5, 3 ); // $ExpectType ArrayLike - cexp( [], 5, 3 ); // $ExpectType ArrayLike + cexp( new Complex128( 1.0, 2.0 ) ); // $ExpectType Complex128 } -// The compiler throws an error if the function is provided a real component which is not a number... +// The compiler throws an error if the function is provided a value other than a complex number... { - cexp( true, 3 ); // $ExpectError - cexp( false, 3 ); // $ExpectError - cexp( null, 3 ); // $ExpectError - cexp( undefined, 3 ); // $ExpectError - cexp( '5', 3 ); // $ExpectError - cexp( [], 3 ); // $ExpectError - cexp( {}, 3 ); // $ExpectError - cexp( ( x: number ): number => x, 3 ); // $ExpectError -} - -// The compiler throws an error if the function is provided an imaginary component which is not a number... -{ - cexp( 5, true ); // $ExpectError - cexp( 5, false ); // $ExpectError - cexp( 5, null ); // $ExpectError - cexp( 5, undefined ); // $ExpectError - cexp( 5, '5' ); // $ExpectError - cexp( 5, [] ); // $ExpectError - cexp( 5, {} ); // $ExpectError - cexp( 5, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an output array which is not array-like... -{ - cexp( true, 5, 3 ); // $ExpectError - cexp( false, 5, 3 ); // $ExpectError - cexp( 'abc', 5, 3 ); // $ExpectError - cexp( {}, 5, 3 ); // $ExpectError - cexp( ( x: number ): number => x, 5, 3 ); // $ExpectError - cexp( 123, 5, 3 ); // $ExpectError + cexp( 2 ); // $ExpectError + cexp( true ); // $ExpectError + cexp( false ); // $ExpectError + cexp( null ); // $ExpectError + cexp( undefined ); // $ExpectError + cexp( '5' ); // $ExpectError + cexp( [] ); // $ExpectError + cexp( {} ); // $ExpectError + cexp( ( x: number ): number => x ); // $ExpectError } // The compiler throws an error if the function is provided insufficient arguments... { cexp(); // $ExpectError - cexp( 2 ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/examples/index.js b/lib/node_modules/@stdlib/math/base/special/cexp/examples/index.js index 8d8403ab855b..c245c7be2a54 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/examples/index.js @@ -21,15 +21,12 @@ var Complex128 = require( '@stdlib/complex/float64' ); var randu = require( '@stdlib/random/base/randu' ); var round = require( '@stdlib/math/base/special/round' ); -var real = require( '@stdlib/complex/real' ); -var imag = require( '@stdlib/complex/imag' ); var cexp = require( './../lib' ); var re; var im; var z1; var z2; -var o; var i; for ( i = 0; i < 100; i++ ) { @@ -37,8 +34,7 @@ for ( i = 0; i < 100; i++ ) { im = round( randu()*100.0 ) - 50.0; z1 = new Complex128( re, im ); - o = cexp( real(z1), imag(z1) ); - z2 = new Complex128( o[ 0 ], o[ 1 ] ); + z2 = cexp( z1 ); console.log( 'cexp(%s) = %s', z1.toString(), z2.toString() ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/lib/cexp.js b/lib/node_modules/@stdlib/math/base/special/cexp/lib/cexp.js deleted file mode 100644 index a02b72f9ddaa..000000000000 --- a/lib/node_modules/@stdlib/math/base/special/cexp/lib/cexp.js +++ /dev/null @@ -1,87 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 copysign = require( '@stdlib/math/base/special/copysign' ); -var sincos = require( '@stdlib/math/base/special/sincos' ).assign; -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isInfinite = require( '@stdlib/math/base/assert/is-infinite' ); -var exp = require( '@stdlib/math/base/special/exp' ); -var PINF = require( '@stdlib/constants/float64/pinf' ); -var NINF = require( '@stdlib/constants/float64/ninf' ); - - -// MAIN // - -/** -* Computes the exponential function of a complex number. -* -* @private -* @param {(Array|TypedArray|Object)} out - output array -* @param {number} re - real component -* @param {number} im - imaginary component -* @returns {(Array|TypedArray|Object)} output array -* -* @example -* var out = [ 0.0, 0.0 ]; -* -* var v = cexp( out, 0.0, 1.0 ); -* // returns [ ~0.540, ~0.841 ] -* -* var bool = ( v === out ); -* // returns true -*/ -function cexp( out, re, im ) { - var tmp; - var e; - if ( isnan( re ) ) { - out[ 0 ] = NaN; - out[ 1 ] = ( im === 0.0 ) ? im : re; - } else if ( isInfinite( im ) ) { - if ( re === PINF ) { - out[ 0 ] = -re; - out[ 1 ] = NaN; - } else if ( re === NINF ) { - out[ 0 ] = -0.0; - out[ 1 ] = copysign( 0.0, im ); - } else { - out[ 0 ] = NaN; - out[ 1 ] = NaN; - } - } else { - e = exp( re ); - if ( im === 0.0 ) { - out[ 0 ] = e; - out[ 1 ] = im; - } else { - sincos( im, out, 1, 0 ); - tmp = out[ 0 ]; - out[ 0 ] = out[ 1 ] * e; - out[ 1 ] = tmp * e; - } - } - return out; -} - - -// EXPORTS // - -module.exports = cexp; diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cexp/lib/index.js index 044969f5e226..1506d7360f09 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/lib/index.js @@ -19,26 +19,24 @@ 'use strict'; /** -* Compute the exponential function of a complex number. +* Compute the exponential function of a double-precision floating-point complex number. * * @module @stdlib/math/base/special/cexp * * @example +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); * var cexp = require( '@stdlib/math/base/special/cexp' ); * -* var v = cexp( 0.0, 0.0 ); -* // returns [ 1.0, 0.0 ] +* var v = cexp( new Complex128( 0.0, 0.0 ) ); +* // returns * -* @example -* var cexp = require( '@stdlib/math/base/special/cexp' ); -* -* var out = [ 0.0, 0.0 ]; -* -* var v = cexp( out, 0.0, 1.0 ); -* // returns [ ~0.540, ~0.841 ] +* var re = real( v ); +* // returns 1.0 * -* var bool = ( v === out ); -* // returns true +* var im = imag( v ); +* // returns 0.0 */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cexp/lib/main.js index 2b82b2c95c56..2a3bd427cc0c 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/lib/main.js @@ -20,7 +20,16 @@ // MODULES // -var computeExp = require( './cexp.js' ); +var Complex128 = require('@stdlib/complex/float64'); +var copysign = require( '@stdlib/math/base/special/copysign' ); +var sincos = require( '@stdlib/math/base/special/sincos' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isInfinite = require( '@stdlib/math/base/assert/is-infinite' ); +var exp = require( '@stdlib/math/base/special/exp' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); // MAIN // @@ -28,33 +37,73 @@ var computeExp = require( './cexp.js' ); /** * Computes the exponential function of a complex number. * -* @param {(Array|TypedArray|Object)} [out] - output array -* @param {number} re - real component -* @param {number} im - imaginary component -* @returns {(Array|TypedArray|Object)} output array +* @param {Complex128} z - complex number +* @returns {Complex128} result * * @example -* var v = cexp( 0.0, 0.0 ); -* // returns [ 1.0, 0.0 ] +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* var cexp = require( '@stdlib/math/base/special/cexp' ); * -* @example -* var v = cexp( 1.0, 0.0 ); -* // returns [ ~2.718, 0.0 ] +* var v = cexp( new Complex128( 0.0, 0.0 ) ); +* // returns +* +* var re = real( v ); +* // returns 1.0 +* +* var im = imag( v ); +* // returns 0.0 * * @example -* var out = [ 0.0, 0.0 ]; +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* var cexp = require( '@stdlib/math/base/special/cexp' ); * -* var v = cexp( out, 1.0, 0.0 ); -* // returns [ ~2.718, 0.0 ] +* var v = cexp( new Complex128( 1.0, 0.0 ) ); +* // returns * -* var bool = ( v === out ); -* // returns true +* var re = real( v ); +* // returns ~2.718 +* +* var im = imag( v ); +* // returns 0.0 */ -function cexp( out, re, im ) { - if ( arguments.length === 2 ) { - return computeExp( [ 0.0, 0.0 ], out, re ); +function cexp( z ) { + var out; + var im; + var re; + var e; + + re = real( z ); + im = imag( z ); + + if ( isnan( re ) ) { + re = NaN; + im = ( im === 0.0 ) ? im : re; + } else if ( isInfinite( im ) ) { + if ( re === PINF ) { + re = -re; + im = NaN; + } else if ( re === NINF ) { + re = -0.0; + im = copysign( 0.0, im ); + } else { + re = NaN; + im = NaN; + } + } else { + e = exp( re ); + if ( im === 0.0 ) { + re = e; + } else { + out = sincos( im ); + re = out[ 1 ] * e; + im = out[ 0 ] * e; + } } - return computeExp( out, re, im ); + return new Complex128( re, im ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/package.json b/lib/node_modules/@stdlib/math/base/special/cexp/package.json index 8b848adea9fb..cf8cd514048a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/package.json +++ b/lib/node_modules/@stdlib/math/base/special/cexp/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/math/base/special/cexp", "version": "0.0.0", - "description": "Compute the exponential function of a complex number.", + "description": "Compute the exponential function of a double-precision complex floating-point number.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js index 9171ef2a9610..f3a0336b7d5f 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js @@ -22,13 +22,15 @@ var tape = require( 'tape' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isArray = require( '@stdlib/assert/is-array' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); var abs = require( '@stdlib/math/base/special/abs' ); var EPS = require( '@stdlib/constants/float64/eps' ); var PINF = require( '@stdlib/constants/float64/pinf' ); var NINF = require( '@stdlib/constants/float64/ninf' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); var cexp = require( './../lib' ); @@ -47,20 +49,11 @@ tape( 'main export is a function', function test( t ) { }); tape( 'the function returns an output array', function test( t ) { - var result = cexp( 0.0, 0.0 ); - t.strictEqual( isArray( result ), true, 'returns expected value' ); - t.deepEqual( result, [ 1.0, 0.0 ], 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an optional output array', function test( t ) { - var result; - var out; + var v; - out = [ 0.0, 0.0 ]; - result = cexp( out, 0.0, 0.0 ); - t.deepEqual( out, [ 1.0, 0.0 ], 'returns expected value' ); - t.strictEqual( out, result, 'returns output array' ); + v = cexp( new Complex128( 0.0, 0.0 ) ); + t.strictEqual( real( v ), 1.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); t.end(); }); @@ -80,20 +73,20 @@ tape( 'the function computes exp(z) for pure imaginary z', function test( t ) { expim = pureImaginary.expim; for ( i = 0; i < re.length; i++ ) { - q = cexp( re[ i ], im[ i ] ); - if ( q[ 0 ] === expre[ i ] ) { - t.strictEqual( q[ 0 ], expre[ i ], 'returns expected real component' ); + q = cexp( new Complex128( re[ i ], im[ i ] ) ); + if ( real( q ) === expre[ i ] ) { + t.strictEqual( real( q ), expre[ i ], 'returns expected real component' ); } else { - delta = abs( q[ 0 ] - expre[ i ] ); + delta = abs( real( q ) - expre[ i ] ); tol = EPS * abs( expre[ i ] ); - t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+q[0]+'. expected: '+expre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+real( q )+'. expected: '+expre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); } - if ( q[ 1 ] === expim[ i ] ) { - t.strictEqual( q[ 1 ], expim[ i ], 'returns expected imaginary component' ); + if ( imag( q ) === expim[ i ] ) { + t.strictEqual( imag( q ), expim[ i ], 'returns expected imaginary component' ); } else { - delta = abs( q[ 1 ] - expim[ i ] ); + delta = abs( imag( q ) - expim[ i ] ); tol = EPS * abs( expim[ i ] ); - t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+q[1]+'. expected: '+expim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+imag( q )+'. expected: '+expim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); } } t.end(); @@ -115,128 +108,154 @@ tape( 'the function computes exp(z) for complex z', function test( t ) { expim = generalComplex.expim; for ( i = 0; i < re.length; i++ ) { - q = cexp( re[ i ], im[ i ] ); - if ( q[ 0 ] === expre[ i ] ) { - t.strictEqual( q[ 0 ], expre[ i ], 'returns expected real component' ); + q = cexp( new Complex128( re[ i ], im[ i ] ) ); + if ( real( q ) === expre[ i ] ) { + t.strictEqual( real( q ), expre[ i ], 'returns expected real component' ); } else { - delta = abs( q[ 0 ] - expre[ i ] ); + delta = abs( real( q ) - expre[ i ] ); tol = EPS * abs( expre[ i ] ); - t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+q[0]+'. expected: '+expre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+real( q )+'. expected: '+expre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); } - if ( q[ 1 ] === expim[ i ] ) { - t.strictEqual( q[ 1 ], expim[ i ], 'returns expected imaginary component' ); + if ( imag( q ) === expim[ i ] ) { + t.strictEqual( imag( q ), expim[ i ], 'returns expected imaginary component' ); } else { - delta = abs( q[ 1 ] - expim[ i ] ); + delta = abs( imag( q ) - expim[ i ] ); tol = EPS * abs( expim[ i ] ); - t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+q[1]+'. expected: '+expim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+imag( q )+'. expected: '+expim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); } } t.end(); }); tape( 'if imaginary component is `+Infinity`, the function returns `[NaN, NaN]`', function test( t ) { - var v = cexp( 0.0, PINF ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + var v; + + v = cexp( new Complex128( 0.0, PINF ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); t.end(); }); tape( 'if imaginary component is `-Infinity`, the function returns `[NaN, NaN]`', function test( t ) { - var v = cexp( 0.0, NINF ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + var v; + + v = cexp( new Complex128( 0.0, NINF ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); t.end(); }); tape( 'if real component is `-Infinity`, the function returns `[0.0, 0.0]`', function test( t ) { - var v = cexp( NINF, 1.0 ); - t.strictEqual( v[ 0 ], 0.0, 'returns 0.0' ); - t.strictEqual( v[ 1 ], 0.0, 'returns 0.0' ); + var v; + + v = cexp( new Complex128( NINF, 1.0 ) ); + t.strictEqual( real( v ), 0.0, 'returns 0.0' ); + t.strictEqual( imag( v ), 0.0, 'returns 0.0' ); t.end(); }); tape( 'if real component is `+Infinity` and imaginary component is `0.0`, the function returns `[+Infinity, 0.0]`', function test( t ) { - var v = cexp( PINF, 0.0 ); - t.strictEqual( v[ 0 ], PINF, 'returns +Infinity' ); - t.strictEqual( v[ 1 ], 0.0, 'returns 0.0' ); + var v; + + v = cexp( new Complex128( PINF, 0.0 ) ); + t.strictEqual( real( v ), PINF, 'returns +Infinity' ); + t.strictEqual( imag( v ), 0.0, 'returns 0.0' ); t.end(); }); tape( 'if real component is `NaN` and imaginary component is `0.0`, the function returns `[NaN, 0.0]`', function test( t ) { - var v = cexp( NaN, 0.0 ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( v[ 1 ], 0.0, 'returns 0.0' ); + var v; + + v = cexp( new Complex128( NaN, 0.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( imag( v ), 0.0, 'returns 0.0' ); t.end(); }); tape( 'if imaginary component is `NaN`, all components are `NaN`', function test( t ) { var v; - v = cexp( 5.0, NaN ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + v = cexp( new Complex128( 5.0, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); - v = cexp( 0.0, NaN ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + v = cexp( new Complex128( 0.0, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); - v = cexp( NaN, NaN ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + v = cexp( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); t.end(); }); tape( 'if imaginary component is `+0.0`, imaginary component of output is `+0.0`', function test( t ) { - var v = cexp( 3.0, 0.0 ); - t.strictEqual( isPositiveZero( v[ 1 ] ), true, 'returns +0.0' ); + var v; + + v = cexp( new Complex128( 3.0, 0.0 ) ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns +0.0' ); t.end(); }); tape( 'if imaginary component is `-0.0`, imaginary component of output is `-0.0`', function test( t ) { - var v = cexp( 3.0, -0.0 ); - t.strictEqual( isNegativeZero( v[ 1 ] ), true, 'returns -0.0' ); + var v; + + v = cexp( new Complex128( 3.0, -0.0 ) ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns -0.0' ); t.end(); }); tape( 'if real component is `NaN` and imaginary component is nonzero, all components are `NaN`', function test( t ) { - var v = cexp( NaN, 3.0 ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + var v; + + v = cexp( new Complex128( NaN, 3.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); t.end(); }); tape( 'if real component is `NaN` and imaginary component is `+0.0`, imaginary component is `+0.0`', function test( t ) { - var v = cexp( NaN, 0.0 ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isPositiveZero( v[ 1 ] ), true, 'returns +0.0' ); + var v; + + v = cexp( new Complex128( NaN, 0.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns +0.0' ); t.end(); }); tape( 'if real component is `NaN` and imaginary component is `-0.0`, imaginary component is `-0.0`', function test( t ) { - var v = cexp( NaN, -0.0 ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isNegativeZero( v[ 1 ] ), true, 'returns +0.0' ); + var v; + + v = cexp( new Complex128( NaN, -0.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns +0.0' ); t.end(); }); tape( 'if real component is `+Infinity` and imaginary component is `+Infinity`, real part is `-Infinity` and imaginary part is `NaN`', function test( t ) { - var v = cexp( PINF, PINF ); - t.strictEqual( v[ 0 ], NINF, 'returns -Infinity' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + var v; + + v = cexp( new Complex128( PINF, PINF ) ); + t.strictEqual( real( v ), NINF, 'returns -Infinity' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); t.end(); }); tape( 'if real component is `-Infinity` and imaginary component is `+Infinity`, real part is `-0.0` and imaginary part is `+0.0`', function test( t ) { - var v = cexp( NINF, PINF ); - t.strictEqual( isNegativeZero( v[ 0 ] ), true, 'returns -0.0' ); - t.strictEqual( isPositiveZero( v[ 1 ] ), true, 'returns +0.0' ); + var v; + + v = cexp( new Complex128( NINF, PINF ) ); + t.strictEqual( isNegativeZero( real( v ) ), true, 'returns -0.0' ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns +0.0' ); t.end(); }); tape( 'if real component is `-Infinity` and imaginary component is `-Infinity`, real part is `-0.0` and imaginary part is `-0.0`', function test( t ) { - var v = cexp( NINF, NINF ); - t.strictEqual( isNegativeZero( v[ 0 ] ), true, 'returns -0.0' ); - t.strictEqual( isNegativeZero( v[ 1 ] ), true, 'returns -0.0' ); + var v; + + v = cexp( new Complex128( NINF, NINF ) ); + t.strictEqual( isNegativeZero( real( v ) ), true, 'returns -0.0' ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns -0.0' ); t.end(); }); From 8661f9262564def9203ca8acc13b19f7c30a4531 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Tue, 14 Mar 2023 16:45:13 -0500 Subject: [PATCH 2/4] feat: add C implementation and native addon to cexp --- .../@stdlib/math/base/special/cexp/README.md | 111 +++++++ .../cexp/benchmark/benchmark.native.js | 66 +++++ .../special/cexp/benchmark/c/native/Makefile | 146 ++++++++++ .../cexp/benchmark/c/native/benchmark.c | 144 ++++++++++ .../math/base/special/cexp/binding.gyp | 170 +++++++++++ .../base/special/cexp/examples/c/Makefile | 146 ++++++++++ .../base/special/cexp/examples/c/example.c | 46 +++ .../math/base/special/cexp/include.gypi | 53 ++++ .../include/stdlib/math/base/special/cexp.h | 40 +++ .../math/base/special/cexp/lib/main.js | 2 +- .../math/base/special/cexp/lib/native.js | 73 +++++ .../math/base/special/cexp/manifest.json | 76 +++++ .../math/base/special/cexp/package.json | 1 + .../math/base/special/cexp/src/Makefile | 70 +++++ .../math/base/special/cexp/src/addon.c | 23 ++ .../@stdlib/math/base/special/cexp/src/main.c | 81 ++++++ .../base/special/cexp/test/test.native.js | 270 ++++++++++++++++++ 17 files changed, 1517 insertions(+), 1 deletion(-) create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/include/stdlib/math/base/special/cexp.h create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/README.md b/lib/node_modules/@stdlib/math/base/special/cexp/README.md index 127fa0b27d6e..ed91b9be7e30 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cexp/README.md @@ -118,6 +118,117 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/cexp.h" +``` + +#### stdlib_base_cexp( z ) + +Evaluates the [exponential][exponential-function] function with a double-precision complex floating-point number. + +```c +#include "stdlib/complex/float64.h" +#include "stdlib/complex/real.h" +#include "stdlib/complex/imag.h" + +stdlib_complex128_t z = stdlib_complex128( 0.0, 0.0 ); + +stdlib_complex128_t out = stdlib_base_cexp( z ); + +double re = stdlib_real( out ); +// returns 1.0 + +double im = stdlib_imag( out ); +// returns 0.0 +``` + +The function accepts the following arguments: + +- **z**: `[in] stdlib_complex128_t` input value. + +```c +stdlib_complex128_t stdlib_base_cexp( const stdlib_complex128_t z ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/cexp.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include + +int main() { + const stdlib_complex128_t x[] = { + stdlib_complex128( 3.14, 1.5 ), + stdlib_complex128( -3.14, -1.5 ), + stdlib_complex128( 0.0, 0.0 ), + stdlib_complex128( 0.0/0.0, 0.0/0.0 ) + }; + + stdlib_complex128_t v; + stdlib_complex128_t y; + double re1; + double im1; + double re2; + double im2; + int i; + for ( i = 0; i < 4; i++ ) { + v = x[ i ]; + y = stdlib_base_cexp( v ); + stdlib_reim( v, &re1, &im1 ); + stdlib_reim( y, &re2, &im2 ); + printf( "cexp(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.native.js new file mode 100644 index 000000000000..d8f14597df39 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.native.js @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var cexp = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cexp instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var values; + var y; + var i; + + values = [ + new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ), + new Complex128( uniform( -500.0, 500.0 ), uniform( -500.0, 500.0 ) ) + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = cexp( values[ i%values.length ] ); + if ( isnan( real( y ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( real( y ) ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/Makefile new file mode 100644 index 000000000000..7f6bbc4c205c --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2021 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/math/base/special/cexp/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..990f3ad76e63 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/benchmark.c @@ -0,0 +1,144 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/** +* Benchmark `cexp`. +*/ +#include "stdlib/math/base/special/cexp.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include +#include +#include +#include +#include + +#define NAME "cexp" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +void print_version() { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +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 +*/ +double tic() { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1]. +* +* @return random number +*/ +double rand_double() { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +double benchmark() { + double elapsed; + double re; + double im; + double t; + double v; + int i; + + stdlib_complex128_t x; + stdlib_complex128_t y; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + v = ( 1000.0*rand_double() ) - 500.0; + x = stdlib_complex128( v, v ); + y = stdlib_base_cexp( x ); + stdlib_reim( y, &re, &im ); + if ( re != re ) { + printf( "unexpected result\n" ); + break; + } + } + elapsed = tic() - t; + if ( im != im ) { + printf( "unexpected result\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/math/base/special/cexp/binding.gyp b/lib/node_modules/@stdlib/math/base/special/cexp/binding.gyp new file mode 100644 index 000000000000..f2b466aef5c4 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2023 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/math/base/special/cexp/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/cexp/examples/c/Makefile new file mode 100644 index 000000000000..70c91f4e1313 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2021 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/math/base/special/cexp/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/cexp/examples/c/example.c new file mode 100644 index 000000000000..e4baaccbee41 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/examples/c/example.c @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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/math/base/special/cexp.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include + +int main() { + const stdlib_complex128_t x[] = { + stdlib_complex128( 3.14, 1.5 ), + stdlib_complex128( -3.14, -1.5 ), + stdlib_complex128( 0.0, 0.0 ), + stdlib_complex128( 0.0/0.0, 0.0/0.0 ) + }; + + stdlib_complex128_t v; + stdlib_complex128_t y; + double re1; + double im1; + double re2; + double im2; + int i; + for ( i = 0; i < 4; i++ ) { + v = x[ i ]; + y = stdlib_base_cexp( v ); + stdlib_reim( v, &re1, &im1 ); + stdlib_reim( y, &re2, &im2 ); + printf( "cexp(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/include.gypi b/lib/node_modules/@stdlib/math/base/special/cexp/include.gypi new file mode 100644 index 000000000000..78db9faf8c74 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2023 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': [ + ' +* +* var re = real( v ); +* // returns 1.0 +* +* var im = imag( v ); +* // returns 0.0 +* +* @example +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* var cexp = require( '@stdlib/math/base/special/cexp' ); +* +* var v = cexp( new Complex128( 1.0, 0.0 ) ); +* // returns +* +* var re = real( v ); +* // returns ~2.718 +* +* var im = imag( v ); +* // returns 0.0 +*/ +function cexp( z ) { + var v = addon( z ); + return new Complex128( v.re, v.im ); +} + + +// EXPORTS // + +module.exports = cexp; diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/manifest.json b/lib/node_modules/@stdlib/math/base/special/cexp/manifest.json new file mode 100644 index 000000000000..5df85fcb1140 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/manifest.json @@ -0,0 +1,76 @@ +{ + "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/unary", + "@stdlib/complex/float64", + "@stdlib/complex/reim" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float64", + "@stdlib/complex/reim" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float64", + "@stdlib/complex/reim" + ] + } + ] +} + diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/package.json b/lib/node_modules/@stdlib/math/base/special/cexp/package.json index cf8cd514048a..2a35e623a9df 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/package.json +++ b/lib/node_modules/@stdlib/math/base/special/cexp/package.json @@ -14,6 +14,7 @@ } ], "main": "./lib", + "gypfile": true, "directories": { "benchmark": "./benchmark", "doc": "./docs", diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/src/Makefile b/lib/node_modules/@stdlib/math/base/special/cexp/src/Makefile new file mode 100644 index 000000000000..a28d8988fb47 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2021 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/math/base/special/cexp/src/addon.c b/lib/node_modules/@stdlib/math/base/special/cexp/src/addon.c new file mode 100644 index 000000000000..35ed511adf1a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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/math/base/special/cexp.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_Z_Z( stdlib_base_cexp ) diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c b/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c new file mode 100644 index 000000000000..f315300bad50 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c @@ -0,0 +1,81 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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/math/base/special/cexp.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include + +/** +* Computes the exponential function of a double-precision floating-point complex number. +* +* @param z input value +* @return result +* +* @example +* #include "stdlib/complex/float64.h" +* #include "stdlib/complex/real.h" +* #include "stdlib/complex/imag.h" +* +* stdlib_complex128_t z = stdlib_complex128( 0.0, 0.0 ); +* +* stdlib_complex128_t out = stdlib_base_cexp( z ); +* +* double re = stdlib_real( out ); +* // returns 1.0 +* +* double im = stdlib_imag( out ); +* // returns 0.0 +*/ +stdlib_complex128_t stdlib_base_cexp( const stdlib_complex128_t z ) { + double re; + double im; + double e; + + stdlib_reim( z, &re, &im ); + + if ( isnan( re ) ){ + re = NAN; + im = ( im == 0.0 ) ? im : re; + } + else if ( isinf( im ) ){ + if ( re == INFINITY ) { + re = -re; + im = NAN; + } + else if ( re == -INFINITY ) { + re = -0.0; + im = copysign( 0.0, im ); + } + else { + re = NAN; + im = NAN; + } + } + else { + e = exp( re ); + if ( im == 0.0 ) { + re = e; + } + else { + re = cos( im ) * e; + im = sin( im ) * e; + } + } + return stdlib_complex128( re, im ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js new file mode 100644 index 000000000000..4d9ad29401dc --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js @@ -0,0 +1,270 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var cexp = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cexp instanceof Error ) +}; + + +// FIXTURES // + +var pureImaginary = require( './fixtures/julia/pure_imaginary.json' ); +var generalComplex = require( './fixtures/julia/general_complex.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cexp, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns an output array', opts, function test( t ) { + var v; + + v = cexp( new Complex128( 0.0, 0.0 ) ); + t.strictEqual( real( v ), 1.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function computes exp(z) for pure imaginary z', opts, function test( t ) { + var delta; + var expre; + var expim; + var tol; + var re; + var im; + var i; + var q; + + re = pureImaginary.re; + im = pureImaginary.im; + expre = pureImaginary.expre; + expim = pureImaginary.expim; + + for ( i = 0; i < re.length; i++ ) { + q = cexp( new Complex128( re[ i ], im[ i ] ) ); + if ( real( q ) === expre[ i ] ) { + t.strictEqual( real( q ), expre[ i ], 'returns expected real component' ); + } else { + delta = abs( real( q ) - expre[ i ] ); + tol = EPS * abs( expre[ i ] ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+real( q )+'. expected: '+expre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + if ( imag( q ) === expim[ i ] ) { + t.strictEqual( imag( q ), expim[ i ], 'returns expected imaginary component' ); + } else { + delta = abs( imag( q ) - expim[ i ] ); + tol = EPS * abs( expim[ i ] ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+imag( q )+'. expected: '+expim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function computes exp(z) for complex z', opts, function test( t ) { + var delta; + var expre; + var expim; + var tol; + var re; + var im; + var i; + var q; + + re = generalComplex.re; + im = generalComplex.im; + expre = generalComplex.expre; + expim = generalComplex.expim; + + for ( i = 0; i < re.length; i++ ) { + q = cexp( new Complex128( re[ i ], im[ i ] ) ); + if ( real( q ) === expre[ i ] ) { + t.strictEqual( real( q ), expre[ i ], 'returns expected real component' ); + } else { + delta = abs( real( q ) - expre[ i ] ); + tol = EPS * abs( expre[ i ] ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+real( q )+'. expected: '+expre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + if ( imag( q ) === expim[ i ] ) { + t.strictEqual( imag( q ), expim[ i ], 'returns expected imaginary component' ); + } else { + delta = abs( imag( q ) - expim[ i ] ); + tol = EPS * abs( expim[ i ] ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+imag( q )+'. expected: '+expim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'if imaginary component is `+Infinity`, the function returns `[NaN, NaN]`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( 0.0, PINF ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if imaginary component is `-Infinity`, the function returns `[NaN, NaN]`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( 0.0, NINF ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if real component is `-Infinity`, the function returns `[0.0, 0.0]`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( NINF, 1.0 ) ); + t.strictEqual( real( v ), 0.0, 'returns 0.0' ); + t.strictEqual( imag( v ), 0.0, 'returns 0.0' ); + t.end(); +}); + +tape( 'if real component is `+Infinity` and imaginary component is `0.0`, the function returns `[+Infinity, 0.0]`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( PINF, 0.0 ) ); + t.strictEqual( real( v ), PINF, 'returns +Infinity' ); + t.strictEqual( imag( v ), 0.0, 'returns 0.0' ); + t.end(); +}); + +tape( 'if real component is `NaN` and imaginary component is `0.0`, the function returns `[NaN, 0.0]`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( NaN, 0.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( imag( v ), 0.0, 'returns 0.0' ); + t.end(); +}); + +tape( 'if imaginary component is `NaN`, all components are `NaN`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( 5.0, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + + v = cexp( new Complex128( 0.0, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + + v = cexp( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'if imaginary component is `+0.0`, imaginary component of output is `+0.0`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( 3.0, 0.0 ) ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns +0.0' ); + t.end(); +}); + +tape( 'if imaginary component is `-0.0`, imaginary component of output is `-0.0`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( 3.0, -0.0 ) ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns -0.0' ); + t.end(); +}); + +tape( 'if real component is `NaN` and imaginary component is nonzero, all components are `NaN`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( NaN, 3.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if real component is `NaN` and imaginary component is `+0.0`, imaginary component is `+0.0`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( NaN, 0.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns +0.0' ); + t.end(); +}); + +tape( 'if real component is `NaN` and imaginary component is `-0.0`, imaginary component is `-0.0`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( NaN, -0.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns +0.0' ); + t.end(); +}); + +tape( 'if real component is `+Infinity` and imaginary component is `+Infinity`, real part is `-Infinity` and imaginary part is `NaN`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( PINF, PINF ) ); + t.strictEqual( real( v ), NINF, 'returns -Infinity' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if real component is `-Infinity` and imaginary component is `+Infinity`, real part is `-0.0` and imaginary part is `+0.0`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( NINF, PINF ) ); + t.strictEqual( isNegativeZero( real( v ) ), true, 'returns -0.0' ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns +0.0' ); + t.end(); +}); + +tape( 'if real component is `-Infinity` and imaginary component is `-Infinity`, real part is `-0.0` and imaginary part is `-0.0`', opts, function test( t ) { + var v; + + v = cexp( new Complex128( NINF, NINF ) ); + t.strictEqual( isNegativeZero( real( v ) ), true, 'returns -0.0' ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns -0.0' ); + t.end(); +}); From b86af28f4fbc23fc6e2473cf3dc3fa051cd4637b Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Mon, 27 Mar 2023 15:41:33 -0500 Subject: [PATCH 3/4] fix: add code review --- .../@stdlib/math/base/special/cexp/README.md | 25 ++++----- .../base/special/cexp/benchmark/benchmark.js | 10 ++-- .../cexp/benchmark/benchmark.native.js | 7 ++- .../math/base/special/cexp/docs/repl.txt | 4 +- .../base/special/cexp/examples/c/Makefile | 2 +- .../math/base/special/cexp/examples/index.js | 20 +++---- .../include/stdlib/math/base/special/cexp.h | 2 +- .../math/base/special/cexp/lib/native.js | 1 + .../@stdlib/math/base/special/cexp/src/main.c | 55 +++++++++---------- .../math/base/special/cexp/test/test.js | 30 +++++----- .../base/special/cexp/test/test.native.js | 30 +++++----- 11 files changed, 90 insertions(+), 96 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/README.md b/lib/node_modules/@stdlib/math/base/special/cexp/README.md index ed91b9be7e30..f083eb014e9b 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cexp/README.md @@ -53,7 +53,7 @@ var cexp = require( '@stdlib/math/base/special/cexp' ); #### cexp( z ) -Evaluates the [exponential][exponential-function] function with a double-precision complex floating-point number. +Evaluates the [exponential][exponential-function] function for a double-precision complex floating-point number. ```javascript var Complex128 = require( '@stdlib/complex/float64' ); @@ -91,25 +91,21 @@ im = imag( v ); ```javascript var Complex128 = require( '@stdlib/complex/float64' ); -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var real = require( '@stdlib/complex/real' ); -var imag = require( '@stdlib/complex/imag' ); +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); var cexp = require( '@stdlib/math/base/special/cexp' ); -var re; -var im; +function randomComplex() { + var re = discreteUniform( -50, 50 ); + var im = discreteUniform( -50, 50 ); + return new Complex128( re, im ); +} + var z1; var z2; var i; - for ( i = 0; i < 100; i++ ) { - re = round( randu()*100.0 ) - 50.0; - im = round( randu()*100.0 ) - 50.0; - z1 = new Complex128( re, im ); - + z1 = randomComplex(); z2 = cexp( z1 ); - console.log( 'cexp(%s) = %s', z1.toString(), z2.toString() ); } ``` @@ -146,7 +142,7 @@ for ( i = 0; i < 100; i++ ) { #### stdlib_base_cexp( z ) -Evaluates the [exponential][exponential-function] function with a double-precision complex floating-point number. +Evaluates the [exponential][exponential-function] function for a double-precision complex floating-point number. ```c #include "stdlib/complex/float64.h" @@ -154,7 +150,6 @@ Evaluates the [exponential][exponential-function] function with a double-precisi #include "stdlib/complex/imag.h" stdlib_complex128_t z = stdlib_complex128( 0.0, 0.0 ); - stdlib_complex128_t out = stdlib_base_cexp( z ); double re = stdlib_real( out ); diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.js index 0130f19e4c59..4b86e292b25a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.js @@ -24,6 +24,8 @@ var bench = require( '@stdlib/bench' ); var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); var pkg = require( './../package.json' ).name; var cexp = require( './../lib' ); @@ -43,13 +45,13 @@ bench( pkg, function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { y = cexp( values[ i%values.length ] ); - if ( isnan( y ) ) { - b.fail( 'should not be empty' ); + if ( typeof y !== 'object' ) { + b.fail( 'should return a complex number' ); } } b.toc(); - if ( isnan( y ) ) { - b.fail( 'should return an array' ); + if ( isnan( real( y ) ) || isnan( imag( y ) ) ) { + b.fail( 'should not return NaN' ); } b.pass( 'benchmark finished' ); b.end(); diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.native.js index d8f14597df39..c47d13def3f6 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/benchmark.native.js @@ -26,6 +26,7 @@ var uniform = require( '@stdlib/random/base/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Complex128 = require( '@stdlib/complex/float64' ); var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -53,12 +54,12 @@ bench( pkg+'::native', opts, function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { y = cexp( values[ i%values.length ] ); - if ( isnan( real( y ) ) ) { - b.fail( 'should not return NaN' ); + if ( typeof y !== 'object' ) { + b.fail( 'should return a complex number' ); } } b.toc(); - if ( isnan( real( y ) ) ) { + if ( isnan( real( y ) ) || isnan( imag( y ) ) ) { b.fail( 'should not return NaN' ); } b.pass( 'benchmark finished' ); diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt index cf205d280cdb..7ae5c2326be4 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt @@ -23,9 +23,9 @@ 0.0 > y = {{alias}}( new {{alias:@stdlib/complex/float64}}( 0.0, 1.0 ) ) - > var re = {{alias:@stdlib/complex/real}}( y ) + > re = {{alias:@stdlib/complex/real}}( y ) ~0.540 - > var im = {{alias:@stdlib/complex/imag}}( y ) + > im = {{alias:@stdlib/complex/imag}}( y ) ~0.841 See Also diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/cexp/examples/c/Makefile index 70c91f4e1313..f0ae66fecf01 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/examples/c/Makefile +++ b/lib/node_modules/@stdlib/math/base/special/cexp/examples/c/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2021 The Stdlib Authors. +# Copyright (c) 2023 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. diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/examples/index.js b/lib/node_modules/@stdlib/math/base/special/cexp/examples/index.js index c245c7be2a54..cd8266a344e6 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/examples/index.js @@ -19,22 +19,20 @@ 'use strict'; var Complex128 = require( '@stdlib/complex/float64' ); -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var cexp = require( './../lib' ); +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var cexp = require( '@stdlib/math/base/special/cexp' ); + +function randomComplex() { + var re = discreteUniform( -50, 50 ); + var im = discreteUniform( -50, 50 ); + return new Complex128( re, im ); +} -var re; -var im; var z1; var z2; var i; - for ( i = 0; i < 100; i++ ) { - re = round( randu()*100.0 ) - 50.0; - im = round( randu()*100.0 ) - 50.0; - z1 = new Complex128( re, im ); - + z1 = randomComplex(); z2 = cexp( z1 ); - console.log( 'cexp(%s) = %s', z1.toString(), z2.toString() ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/include/stdlib/math/base/special/cexp.h b/lib/node_modules/@stdlib/math/base/special/cexp/include/stdlib/math/base/special/cexp.h index e2128ab57671..e7eb33b75898 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/include/stdlib/math/base/special/cexp.h +++ b/lib/node_modules/@stdlib/math/base/special/cexp/include/stdlib/math/base/special/cexp.h @@ -29,7 +29,7 @@ extern "C" { #endif /** -* Rounds a double-precision complex floating-point number toward positive infinity. +* Evaluates the exponential function for a double-precision complex floating-point number. */ stdlib_complex128_t stdlib_base_cexp( const stdlib_complex128_t z ); diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js index 8ed7f310b6e7..91339feb946a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js @@ -29,6 +29,7 @@ var addon = require( './../src/addon.node' ); /** * Computes the exponential function of a double-precision floating-point complex number. * +* @private * @param {Complex128} z - complex number * @returns {Complex128} result * diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c b/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c index f315300bad50..911192498c7d 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c @@ -33,7 +33,6 @@ * #include "stdlib/complex/imag.h" * * stdlib_complex128_t z = stdlib_complex128( 0.0, 0.0 ); -* * stdlib_complex128_t out = stdlib_base_cexp( z ); * * double re = stdlib_real( out ); @@ -45,37 +44,35 @@ stdlib_complex128_t stdlib_base_cexp( const stdlib_complex128_t z ) { double re; double im; - double e; + double e; stdlib_reim( z, &re, &im ); if ( isnan( re ) ){ - re = NAN; - im = ( im == 0.0 ) ? im : re; - } - else if ( isinf( im ) ){ - if ( re == INFINITY ) { - re = -re; - im = NAN; - } - else if ( re == -INFINITY ) { - re = -0.0; - im = copysign( 0.0, im ); - } - else { - re = NAN; - im = NAN; - } - } - else { - e = exp( re ); - if ( im == 0.0 ) { - re = e; - } - else { - re = cos( im ) * e; - im = sin( im ) * e; - } - } + re = NAN; + im = ( im == 0.0 ) ? im : re; + } else if ( isinf( im ) ){ + if ( re == INFINITY ) { + re = -re; + im = NAN; + } + else if ( re == -INFINITY ) { + re = -0.0; + im = copysign( 0.0, im ); + } + else { + re = NAN; + im = NAN; + } + } else { + e = exp( re ); + if ( im == 0.0 ) { + re = e; + } + else { + re = cos( im ) * e; + im = sin( im ) * e; + } + } return stdlib_complex128( re, im ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js index f3a0336b7d5f..ada23cf7698a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js @@ -48,7 +48,7 @@ tape( 'main export is a function', function test( t ) { t.end(); }); -tape( 'the function returns an output array', function test( t ) { +tape( 'the function returns a double-presicion complex floating-point number', function test( t ) { var v; v = cexp( new Complex128( 0.0, 0.0 ) ); @@ -127,7 +127,7 @@ tape( 'the function computes exp(z) for complex z', function test( t ) { t.end(); }); -tape( 'if imaginary component is `+Infinity`, the function returns `[NaN, NaN]`', function test( t ) { +tape( 'if imaginary component is `+Infinity`, the function returns a complex number having `NaN` components', function test( t ) { var v; v = cexp( new Complex128( 0.0, PINF ) ); @@ -136,7 +136,7 @@ tape( 'if imaginary component is `+Infinity`, the function returns `[NaN, NaN]`' t.end(); }); -tape( 'if imaginary component is `-Infinity`, the function returns `[NaN, NaN]`', function test( t ) { +tape( 'if imaginary component is `-Infinity`, the function returns a complex number having `NaN` components', function test( t ) { var v; v = cexp( new Complex128( 0.0, NINF ) ); @@ -145,7 +145,7 @@ tape( 'if imaginary component is `-Infinity`, the function returns `[NaN, NaN]`' t.end(); }); -tape( 'if real component is `-Infinity`, the function returns `[0.0, 0.0]`', function test( t ) { +tape( 'if real component is `-Infinity`, the function returns a complex number with both components equal to `0`', function test( t ) { var v; v = cexp( new Complex128( NINF, 1.0 ) ); @@ -154,7 +154,7 @@ tape( 'if real component is `-Infinity`, the function returns `[0.0, 0.0]`', fun t.end(); }); -tape( 'if real component is `+Infinity` and imaginary component is `0.0`, the function returns `[+Infinity, 0.0]`', function test( t ) { +tape( 'if real component is `+Infinity` and imaginary component is `0.0`, the function returns a complex number with the real component equal to `+Infinity` and imaginary component equal to `0.0`', function test( t ) { var v; v = cexp( new Complex128( PINF, 0.0 ) ); @@ -163,7 +163,7 @@ tape( 'if real component is `+Infinity` and imaginary component is `0.0`, the fu t.end(); }); -tape( 'if real component is `NaN` and imaginary component is `0.0`, the function returns `[NaN, 0.0]`', function test( t ) { +tape( 'if real component is `NaN` and imaginary component is `0.0`, the function returns a complex number with the real component equal to `NaN` and imaginary component equal to `0.0`', function test( t ) { var v; v = cexp( new Complex128( NaN, 0.0 ) ); @@ -172,7 +172,7 @@ tape( 'if real component is `NaN` and imaginary component is `0.0`, the function t.end(); }); -tape( 'if imaginary component is `NaN`, all components are `NaN`', function test( t ) { +tape( 'if imaginary component is `NaN`, the function returns a complex number with both components equal to `NaN`', function test( t ) { var v; v = cexp( new Complex128( 5.0, NaN ) ); @@ -190,7 +190,7 @@ tape( 'if imaginary component is `NaN`, all components are `NaN`', function test t.end(); }); -tape( 'if imaginary component is `+0.0`, imaginary component of output is `+0.0`', function test( t ) { +tape( 'if imaginary component is `+0.0`, the function returns a complex number with an imaginary component equal to `+0.0`', function test( t ) { var v; v = cexp( new Complex128( 3.0, 0.0 ) ); @@ -198,7 +198,7 @@ tape( 'if imaginary component is `+0.0`, imaginary component of output is `+0.0` t.end(); }); -tape( 'if imaginary component is `-0.0`, imaginary component of output is `-0.0`', function test( t ) { +tape( 'if imaginary component is `-0.0`, the function returns a complex number with an imaginary component equal to `-0.0`', function test( t ) { var v; v = cexp( new Complex128( 3.0, -0.0 ) ); @@ -206,7 +206,7 @@ tape( 'if imaginary component is `-0.0`, imaginary component of output is `-0.0` t.end(); }); -tape( 'if real component is `NaN` and imaginary component is nonzero, all components are `NaN`', function test( t ) { +tape( 'if real component is `NaN` and imaginary component is nonzero, the function returns a complex number with both components equal to `NaN`', function test( t ) { var v; v = cexp( new Complex128( NaN, 3.0 ) ); @@ -215,7 +215,7 @@ tape( 'if real component is `NaN` and imaginary component is nonzero, all compon t.end(); }); -tape( 'if real component is `NaN` and imaginary component is `+0.0`, imaginary component is `+0.0`', function test( t ) { +tape( 'if real component is `NaN` and imaginary component is `+0.0`, the function returns a complex number with an imaginary component equal to `+0.0`', function test( t ) { var v; v = cexp( new Complex128( NaN, 0.0 ) ); @@ -224,7 +224,7 @@ tape( 'if real component is `NaN` and imaginary component is `+0.0`, imaginary c t.end(); }); -tape( 'if real component is `NaN` and imaginary component is `-0.0`, imaginary component is `-0.0`', function test( t ) { +tape( 'if real component is `NaN` and imaginary component is `-0.0`, the function returns a complex number with an imaginary component equal to `-0.0`', function test( t ) { var v; v = cexp( new Complex128( NaN, -0.0 ) ); @@ -233,7 +233,7 @@ tape( 'if real component is `NaN` and imaginary component is `-0.0`, imaginary c t.end(); }); -tape( 'if real component is `+Infinity` and imaginary component is `+Infinity`, real part is `-Infinity` and imaginary part is `NaN`', function test( t ) { +tape( 'if real component is `+Infinity` and imaginary component is `+Infinity`, the function returns a complex number with the real component equal to `-Infinity` and imaginary component equal to `NaN`', function test( t ) { var v; v = cexp( new Complex128( PINF, PINF ) ); @@ -242,7 +242,7 @@ tape( 'if real component is `+Infinity` and imaginary component is `+Infinity`, t.end(); }); -tape( 'if real component is `-Infinity` and imaginary component is `+Infinity`, real part is `-0.0` and imaginary part is `+0.0`', function test( t ) { +tape( 'if real component is `-Infinity` and imaginary component is `+Infinity`, the function returns a complex number with the real component equal to `-0.0` and imaginary component equal to `+0.0`', function test( t ) { var v; v = cexp( new Complex128( NINF, PINF ) ); @@ -251,7 +251,7 @@ tape( 'if real component is `-Infinity` and imaginary component is `+Infinity`, t.end(); }); -tape( 'if real component is `-Infinity` and imaginary component is `-Infinity`, real part is `-0.0` and imaginary part is `-0.0`', function test( t ) { +tape( 'if real component is `-Infinity` and imaginary component is `-Infinity`, the function returns a complex number with the real component equal to `-0.0` and imaginary component equal to `-0.0`', function test( t ) { var v; v = cexp( new Complex128( NINF, NINF ) ); diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js index 4d9ad29401dc..e876d8da93cf 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js @@ -57,7 +57,7 @@ tape( 'main export is a function', opts, function test( t ) { t.end(); }); -tape( 'the function returns an output array', opts, function test( t ) { +tape( 'the function returns a double-presicion complex floating-point number', opts, function test( t ) { var v; v = cexp( new Complex128( 0.0, 0.0 ) ); @@ -136,7 +136,7 @@ tape( 'the function computes exp(z) for complex z', opts, function test( t ) { t.end(); }); -tape( 'if imaginary component is `+Infinity`, the function returns `[NaN, NaN]`', opts, function test( t ) { +tape( 'if imaginary component is `+Infinity`, the function returns a complex number having `NaN` components', opts, function test( t ) { var v; v = cexp( new Complex128( 0.0, PINF ) ); @@ -145,7 +145,7 @@ tape( 'if imaginary component is `+Infinity`, the function returns `[NaN, NaN]`' t.end(); }); -tape( 'if imaginary component is `-Infinity`, the function returns `[NaN, NaN]`', opts, function test( t ) { +tape( 'if imaginary component is `-Infinity`, the function returns a complex number having `NaN` components', opts, function test( t ) { var v; v = cexp( new Complex128( 0.0, NINF ) ); @@ -154,7 +154,7 @@ tape( 'if imaginary component is `-Infinity`, the function returns `[NaN, NaN]`' t.end(); }); -tape( 'if real component is `-Infinity`, the function returns `[0.0, 0.0]`', opts, function test( t ) { +tape( 'if real component is `-Infinity`, the function returns a complex number with both components equal to `0`', opts, function test( t ) { var v; v = cexp( new Complex128( NINF, 1.0 ) ); @@ -163,7 +163,7 @@ tape( 'if real component is `-Infinity`, the function returns `[0.0, 0.0]`', opt t.end(); }); -tape( 'if real component is `+Infinity` and imaginary component is `0.0`, the function returns `[+Infinity, 0.0]`', opts, function test( t ) { +tape( 'if real component is `+Infinity` and imaginary component is `0.0`, the function returns a complex number with the real component equal to `+Infinity` and imaginary component equal to `0.0`', opts, function test( t ) { var v; v = cexp( new Complex128( PINF, 0.0 ) ); @@ -172,7 +172,7 @@ tape( 'if real component is `+Infinity` and imaginary component is `0.0`, the fu t.end(); }); -tape( 'if real component is `NaN` and imaginary component is `0.0`, the function returns `[NaN, 0.0]`', opts, function test( t ) { +tape( 'if real component is `NaN` and imaginary component is `0.0`, the function returns a complex number with the real component equal to `NaN` and imaginary component equal to `0.0`', opts, function test( t ) { var v; v = cexp( new Complex128( NaN, 0.0 ) ); @@ -181,7 +181,7 @@ tape( 'if real component is `NaN` and imaginary component is `0.0`, the function t.end(); }); -tape( 'if imaginary component is `NaN`, all components are `NaN`', opts, function test( t ) { +tape( 'if imaginary component is `NaN`, the function returns a complex number with both components equal to `NaN`', opts, function test( t ) { var v; v = cexp( new Complex128( 5.0, NaN ) ); @@ -199,7 +199,7 @@ tape( 'if imaginary component is `NaN`, all components are `NaN`', opts, functio t.end(); }); -tape( 'if imaginary component is `+0.0`, imaginary component of output is `+0.0`', opts, function test( t ) { +tape( 'if imaginary component is `+0.0`, the function returns a complex number with an imaginary component equal to `+0.0`', opts, function test( t ) { var v; v = cexp( new Complex128( 3.0, 0.0 ) ); @@ -207,7 +207,7 @@ tape( 'if imaginary component is `+0.0`, imaginary component of output is `+0.0` t.end(); }); -tape( 'if imaginary component is `-0.0`, imaginary component of output is `-0.0`', opts, function test( t ) { +tape( 'if imaginary component is `-0.0`, the function returns a complex number with an imaginary component equal to `-0.0`', opts, function test( t ) { var v; v = cexp( new Complex128( 3.0, -0.0 ) ); @@ -215,7 +215,7 @@ tape( 'if imaginary component is `-0.0`, imaginary component of output is `-0.0` t.end(); }); -tape( 'if real component is `NaN` and imaginary component is nonzero, all components are `NaN`', opts, function test( t ) { +tape( 'if real component is `NaN` and imaginary component is nonzero, the function returns a complex number with both components equal to `NaN`', opts, function test( t ) { var v; v = cexp( new Complex128( NaN, 3.0 ) ); @@ -224,7 +224,7 @@ tape( 'if real component is `NaN` and imaginary component is nonzero, all compon t.end(); }); -tape( 'if real component is `NaN` and imaginary component is `+0.0`, imaginary component is `+0.0`', opts, function test( t ) { +tape( 'if real component is `NaN` and imaginary component is `+0.0`, the function returns a complex number with an imaginary component equal to `+0.0`', opts, function test( t ) { var v; v = cexp( new Complex128( NaN, 0.0 ) ); @@ -233,7 +233,7 @@ tape( 'if real component is `NaN` and imaginary component is `+0.0`, imaginary c t.end(); }); -tape( 'if real component is `NaN` and imaginary component is `-0.0`, imaginary component is `-0.0`', opts, function test( t ) { +tape( 'if real component is `NaN` and imaginary component is `-0.0`, the function returns a complex number with an imaginary component equal to `-0.0`', opts, function test( t ) { var v; v = cexp( new Complex128( NaN, -0.0 ) ); @@ -242,7 +242,7 @@ tape( 'if real component is `NaN` and imaginary component is `-0.0`, imaginary c t.end(); }); -tape( 'if real component is `+Infinity` and imaginary component is `+Infinity`, real part is `-Infinity` and imaginary part is `NaN`', opts, function test( t ) { +tape( 'if real component is `+Infinity` and imaginary component is `+Infinity`, the function returns a complex number with the real component equal to `-Infinity` and imaginary component equal to `NaN`', opts, function test( t ) { var v; v = cexp( new Complex128( PINF, PINF ) ); @@ -251,7 +251,7 @@ tape( 'if real component is `+Infinity` and imaginary component is `+Infinity`, t.end(); }); -tape( 'if real component is `-Infinity` and imaginary component is `+Infinity`, real part is `-0.0` and imaginary part is `+0.0`', opts, function test( t ) { +tape( 'if real component is `-Infinity` and imaginary component is `+Infinity`, the function returns a complex number with the real component equal to `-0.0` and imaginary component equal to `+0.0`', opts, function test( t ) { var v; v = cexp( new Complex128( NINF, PINF ) ); @@ -260,7 +260,7 @@ tape( 'if real component is `-Infinity` and imaginary component is `+Infinity`, t.end(); }); -tape( 'if real component is `-Infinity` and imaginary component is `-Infinity`, real part is `-0.0` and imaginary part is `-0.0`', opts, function test( t ) { +tape( 'if real component is `-Infinity` and imaginary component is `-Infinity`, the function returns a complex number with the real component equal to `-0.0` and imaginary component equal to `-0.0`', opts, function test( t ) { var v; v = cexp( new Complex128( NINF, NINF ) ); From 764a2269d322ac7d688798b5613ac6ba6a87b6e2 Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 13 Apr 2023 02:22:34 -0700 Subject: [PATCH 4/4] Apply suggestions from code review --- .../@stdlib/math/base/special/cexp/README.md | 2 +- .../base/special/cexp/benchmark/c/native/Makefile | 2 +- .../@stdlib/math/base/special/cexp/docs/repl.txt | 4 ++-- .../math/base/special/cexp/docs/types/index.d.ts | 2 +- .../@stdlib/math/base/special/cexp/lib/index.js | 2 +- .../@stdlib/math/base/special/cexp/lib/main.js | 2 +- .../@stdlib/math/base/special/cexp/lib/native.js | 2 +- .../@stdlib/math/base/special/cexp/package.json | 2 +- .../@stdlib/math/base/special/cexp/src/Makefile | 2 +- .../@stdlib/math/base/special/cexp/src/main.c | 11 ++++------- .../@stdlib/math/base/special/cexp/test/test.js | 2 +- .../math/base/special/cexp/test/test.native.js | 2 +- 12 files changed, 16 insertions(+), 19 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/README.md b/lib/node_modules/@stdlib/math/base/special/cexp/README.md index f083eb014e9b..3ddd0e1c7bb7 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cexp/README.md @@ -20,7 +20,7 @@ limitations under the License. # exp -> Compute the [exponential][exponential-function] function of double-precision complex floating-point number. +> Evaluate the [exponential][exponential-function] function for a double-precision complex floating-point number.
diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/Makefile index 7f6bbc4c205c..3cbfe3fef3b6 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/Makefile +++ b/lib/node_modules/@stdlib/math/base/special/cexp/benchmark/c/native/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2021 The Stdlib Authors. +# Copyright (c) 2023 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. diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt index 7ae5c2326be4..9f413271df5a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cexp/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( z ) - Computes the exponential function of a double-precision complex - floating-point number. + Evaluates the exponential function for a double-precision complex floating- + point number. Parameters ---------- diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/index.d.ts index b297f48e58ad..9fd3f24e4702 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cexp/docs/types/index.d.ts @@ -23,7 +23,7 @@ import { Complex128 } from '@stdlib/types/object'; /** -* Computes the exponential function of a double-precision complex floating-point number. +* Evaluates the exponential function for a double-precision complex floating-point number. * * @param z - complex number * @returns result diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cexp/lib/index.js index 1506d7360f09..823e5a326c97 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Compute the exponential function of a double-precision floating-point complex number. +* Evaluate the exponential function for a double-precision complex floating-point number. * * @module @stdlib/math/base/special/cexp * diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cexp/lib/main.js index 5d7127729ab8..fac8ab833758 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/lib/main.js @@ -35,7 +35,7 @@ var imag = require( '@stdlib/complex/imag' ); // MAIN // /** -* Computes the exponential function of a double-precision floating-point complex number. +* Evaluates the exponential function for a double-precision complex floating-point number. * * @param {Complex128} z - complex number * @returns {Complex128} result diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js index 91339feb946a..ed37bad0bb88 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/lib/native.js @@ -27,7 +27,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Computes the exponential function of a double-precision floating-point complex number. +* Evaluates the exponential function for a double-precision complex floating-point number. * * @private * @param {Complex128} z - complex number diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/package.json b/lib/node_modules/@stdlib/math/base/special/cexp/package.json index 2a35e623a9df..a9654c539381 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/package.json +++ b/lib/node_modules/@stdlib/math/base/special/cexp/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/math/base/special/cexp", "version": "0.0.0", - "description": "Compute the exponential function of a double-precision complex floating-point number.", + "description": "Evaluate the exponential function for a double-precision complex floating-point number.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/src/Makefile b/lib/node_modules/@stdlib/math/base/special/cexp/src/Makefile index a28d8988fb47..904c7dc4bd7a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/src/Makefile +++ b/lib/node_modules/@stdlib/math/base/special/cexp/src/Makefile @@ -1,7 +1,7 @@ #/ # @license Apache-2.0 # -# Copyright (c) 2021 The Stdlib Authors. +# Copyright (c) 2023 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. diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c b/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c index 911192498c7d..9bcea2697ac4 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cexp/src/main.c @@ -22,7 +22,7 @@ #include /** -* Computes the exponential function of a double-precision floating-point complex number. +* Evaluates the exponential function of a double-precision complex floating-point number. * * @param z input value * @return result @@ -55,12 +55,10 @@ stdlib_complex128_t stdlib_base_cexp( const stdlib_complex128_t z ) { if ( re == INFINITY ) { re = -re; im = NAN; - } - else if ( re == -INFINITY ) { + } else if ( re == -INFINITY ) { re = -0.0; im = copysign( 0.0, im ); - } - else { + } else { re = NAN; im = NAN; } @@ -68,8 +66,7 @@ stdlib_complex128_t stdlib_base_cexp( const stdlib_complex128_t z ) { e = exp( re ); if ( im == 0.0 ) { re = e; - } - else { + } else { re = cos( im ) * e; im = sin( im ) * e; } diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js index ada23cf7698a..8cd7e00df55b 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.js @@ -48,7 +48,7 @@ tape( 'main export is a function', function test( t ) { t.end(); }); -tape( 'the function returns a double-presicion complex floating-point number', function test( t ) { +tape( 'the function returns a double-precision complex floating-point number', function test( t ) { var v; v = cexp( new Complex128( 0.0, 0.0 ) ); diff --git a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js index e876d8da93cf..3d9e8a6e20b3 100644 --- a/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js +++ b/lib/node_modules/@stdlib/math/base/special/cexp/test/test.native.js @@ -57,7 +57,7 @@ tape( 'main export is a function', opts, function test( t ) { t.end(); }); -tape( 'the function returns a double-presicion complex floating-point number', opts, function test( t ) { +tape( 'the function returns a double-precision complex floating-point number', opts, function test( t ) { var v; v = cexp( new Complex128( 0.0, 0.0 ) );