diff --git a/base/special/cidentity/README.md b/base/special/cidentity/README.md index 7986ff87d..4d0bffb9a 100644 --- a/base/special/cidentity/README.md +++ b/base/special/cidentity/README.md @@ -18,7 +18,7 @@ limitations under the License. --> -# Identity Function +# cidentity > Evaluate the [identity function][identity-function] of a double-precision [complex][@stdlib/complex/float64] floating-point number. @@ -132,18 +132,26 @@ for ( i = 0; i < 100; i++ ) { Evaluates the identity function for a double-precision complex floating-point number. ```c -#include +#include "stdlib/complex/float64.h" +#include "stdlib/complex/real.h" +#include "stdlib/complex/imag.h" -double complex y = stdlib_base_cidentity( 2.0+2.0*I ); -// returns 2.0+2.0*I +stdlib_complex128_t z = stdlib_complex128( 2.5, -1.5 ); +stdlib_complex128_t out = stdlib_base_cidentity( z ); + +double re = stdlib_real( out ); +// returns 2.5 + +double im = stdlib_imag( out ); +// returns -1.5 ``` The function accepts the following arguments: -- **z**: `[in] double complex` input value. +- **z**: `[in] stdlib_complex128_t` input value. ```c -double complex stdlib_base_cidentity( const double complex z ); +stdlib_complex128_t stdlib_base_cidentity( const stdlib_complex128_t z ); ``` @@ -166,19 +174,31 @@ double complex stdlib_base_cidentity( const double complex z ); ```c #include "stdlib/math/base/special/cidentity.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" #include -#include - -int main( void ) { - const double complex x[] = { 3.14+1.0*I, -3.14-1.0*I, 0.0+0.0*I, 0.0/0.0+0.0/0.0*I }; - double complex v; - double complex y; +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_cidentity( v ); - printf( "f(%lf + %lf) = %lf + %lf\n", creal( v ), cimag( v ), creal( y ), cimag( y ) ); + stdlib_reim( v, &re1, &im1 ); + stdlib_reim( y, &re2, &im2 ); + printf( "cidentity(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 ); } } ``` diff --git a/base/special/cidentity/benchmark/benchmark.native.js b/base/special/cidentity/benchmark/benchmark.native.js new file mode 100644 index 000000000..2f2c768f3 --- /dev/null +++ b/base/special/cidentity/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( './../../../../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 cidentity = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cidentity 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 = cidentity( 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/base/special/cidentity/benchmark/c/Makefile b/base/special/cidentity/benchmark/c/native/Makefile similarity index 98% rename from base/special/cidentity/benchmark/c/Makefile rename to base/special/cidentity/benchmark/c/native/Makefile index 7f6bbc4c2..3cbfe3fef 100644 --- a/base/special/cidentity/benchmark/c/Makefile +++ b/base/special/cidentity/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/base/special/cidentity/benchmark/c/benchmark.c b/base/special/cidentity/benchmark/c/native/benchmark.c similarity index 90% rename from base/special/cidentity/benchmark/c/benchmark.c rename to base/special/cidentity/benchmark/c/native/benchmark.c index 97c3414e9..b3412f794 100644 --- a/base/special/cidentity/benchmark/c/benchmark.c +++ b/base/special/cidentity/benchmark/c/native/benchmark.c @@ -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. @@ -20,7 +20,8 @@ * Benchmark `cidentity`. */ #include "stdlib/math/base/special/cidentity.h" -#include +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" #include #include #include @@ -94,25 +95,29 @@ double rand_double() { * @return elapsed time in seconds */ double benchmark() { - double complex x; - double complex y; 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 = v + v*I; + x = stdlib_complex128( v, v ); y = stdlib_base_cidentity( x ); - if ( creal( y ) != v ) { + stdlib_reim( y, &re, &im ); + if ( re != re ) { printf( "unexpected result\n" ); break; } } elapsed = tic() - t; - if ( cimag( y ) != v ) { + if ( im != im ) { printf( "unexpected result\n" ); } return elapsed; diff --git a/base/special/cidentity/binding.gyp b/base/special/cidentity/binding.gyp new file mode 100644 index 000000000..f2b466aef --- /dev/null +++ b/base/special/cidentity/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/base/special/cidentity/examples/c/Makefile b/base/special/cidentity/examples/c/Makefile index 70c91f4e1..f0ae66fec 100644 --- a/base/special/cidentity/examples/c/Makefile +++ b/base/special/cidentity/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/base/special/cidentity/examples/c/example.c b/base/special/cidentity/examples/c/example.c index a484c8597..89e387683 100644 --- a/base/special/cidentity/examples/c/example.c +++ b/base/special/cidentity/examples/c/example.c @@ -17,19 +17,30 @@ */ #include "stdlib/math/base/special/cidentity.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" #include -#include int main( void ) { - // cppcheck-suppress nanInArithmeticExpression - double complex x[] = { 3.14+1.0*I, -3.14-1.0*I, 0.0+0.0*I, 0.0/0.0+0.0/0.0*I }; + 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 ) + }; - double complex v; - double complex y; + 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_cidentity( v ); - printf( "f(%lf + %lf) = %lf + %lf\n", creal( v ), cimag( v ), creal( y ), cimag( y ) ); + stdlib_reim( v, &re1, &im1 ); + stdlib_reim( y, &re2, &im2 ); + printf( "cidentity(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 ); } } diff --git a/base/special/cidentity/include.gypi b/base/special/cidentity/include.gypi new file mode 100644 index 000000000..78db9faf8 --- /dev/null +++ b/base/special/cidentity/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': [ + ' +#include "stdlib/complex/float64.h" /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. @@ -31,7 +31,7 @@ extern "C" { /** * Evaluates the identity function for a double-precision complex floating-point number. */ -double complex stdlib_base_cidentity( const double complex z ); +stdlib_complex128_t stdlib_base_cidentity( const stdlib_complex128_t z ); #ifdef __cplusplus } diff --git a/base/special/cidentity/lib/native.js b/base/special/cidentity/lib/native.js new file mode 100644 index 000000000..70f02cf86 --- /dev/null +++ b/base/special/cidentity/lib/native.js @@ -0,0 +1,58 @@ +/** +* @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 Complex128 = require( '@stdlib/complex/float64' ); +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Evaluates the identity function for a double-precision complex floating-point number. +* +* @private +* @param {Complex128} z - input value +* @returns {Complex128} input value +* +* @example +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var v = cidentity( new Complex128( -1.0, 2.0 ) ); +* // returns +* +* var re = real( v ); +* // returns -1.0 +* +* var im = imag( v ); +* // returns 2.0 +*/ +function cidentify( z ) { + var v = addon( z ); + return new Complex128( v.re, v.im ); +} + + +// EXPORTS // + +module.exports = cidentify; diff --git a/base/special/cidentity/manifest.json b/base/special/cidentity/manifest.json index 890a937a3..3bb5ad835 100644 --- a/base/special/cidentity/manifest.json +++ b/base/special/cidentity/manifest.json @@ -1,38 +1,76 @@ { - "options": {}, - "fields": [ - { - "field": "src", - "resolve": true, - "relative": true - }, - { - "field": "include", - "resolve": true, - "relative": true - }, - { - "field": "libraries", - "resolve": false, - "relative": false - }, - { - "field": "libpath", - "resolve": true, - "relative": false - } - ], - "confs": [ - { - "src": [ - "./src/main.c" - ], - "include": [ - "./include" - ], - "libraries": [], - "libpath": [], - "dependencies": [] - } - ] + "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/base/special/cidentity/package.json b/base/special/cidentity/package.json index 935c9981a..5d4a2f5b1 100644 --- a/base/special/cidentity/package.json +++ b/base/special/cidentity/package.json @@ -14,6 +14,7 @@ } ], "main": "./lib", + "gypfile": true, "directories": { "benchmark": "./benchmark", "doc": "./docs", diff --git a/base/special/cidentity/src/Makefile b/base/special/cidentity/src/Makefile new file mode 100644 index 000000000..904c7dc4b --- /dev/null +++ b/base/special/cidentity/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @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. +#/ + +# 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/base/special/cidentity/src/addon.c b/base/special/cidentity/src/addon.c new file mode 100644 index 000000000..ac653488d --- /dev/null +++ b/base/special/cidentity/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/cidentity.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_Z_Z( stdlib_base_cidentity ) diff --git a/base/special/cidentity/src/main.c b/base/special/cidentity/src/main.c index d65a6252a..72a4be897 100644 --- a/base/special/cidentity/src/main.c +++ b/base/special/cidentity/src/main.c @@ -17,7 +17,7 @@ */ #include "stdlib/math/base/special/cidentity.h" -#include +#include "stdlib/complex/float64.h" /** * Evaluates the identity function for a double-precision complex floating-point number. @@ -26,8 +26,20 @@ * @return input value * * @example -* double complex y = stdlib_base_cidentity( 3.0+3.0*I ); +* #include "stdlib/complex/float64.h" +* #include "stdlib/complex/real.h" +* #include "stdlib/complex/imag.h" +* +* stdlib_complex128_t z = stdlib_complex128( 3.0, 3.0 ); +* stdlib_complex128_t out = stdlib_base_cidentity( z ); +* +* double re = stdlib_real( out ); +* // returns 3.0 +* +* double im = stdlib_imag( out ); +* // returns 3.0 + */ -double complex stdlib_base_cidentity( const double complex z ) { +stdlib_complex128_t stdlib_base_cidentity( const stdlib_complex128_t z ) { return z; } diff --git a/base/special/cidentity/test/test.native.js b/base/special/cidentity/test/test.native.js new file mode 100644 index 000000000..ba060b582 --- /dev/null +++ b/base/special/cidentity/test/test.native.js @@ -0,0 +1,126 @@ +/** +* @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 isPositiveZero = require( './../../../../base/assert/is-positive-zero' ); +var isNegativeZero = require( './../../../../base/assert/is-negative-zero' ); +var isnan = require( './../../../../base/assert/is-nan' ); +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 cidentity = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cidentity instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.equal( typeof cidentity, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function evaluates the identity function when provided a finite number', opts, function test( t ) { + var v; + + v = cidentity( new Complex128( -2.0, 1.0 ) ); + t.equal( real( v ), -2.0, 'returns expected value' ); + t.equal( imag( v ), 1.0, 'returns expected value' ); + + v = cidentity( new Complex128( 3.0, -2.0 ) ); + t.equal( real( v ), 3.0, 'returns expected value' ); + t.equal( imag( v ), -2.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function evaluates the identity function when provided +-zero', opts, function test( t ) { + var v; + + v = cidentity( new Complex128( -0.0, -0.0 ) ); + t.equal( isNegativeZero( real( v ) ), true, 'returns expected value' ); + t.equal( isNegativeZero( imag( v ) ), true, 'returns expected value' ); + + v = cidentity( new Complex128( 0.0, 0.0 ) ); + t.equal( isPositiveZero( real( v ) ), true, 'returns expected value' ); + t.equal( isPositiveZero( imag( v ) ), true, 'returns expected value' ); + + v = cidentity( new Complex128( -0.0, 0.0 ) ); + t.equal( isNegativeZero( real( v ) ), true, 'returns expected value' ); + t.equal( isPositiveZero( imag( v ) ), true, 'returns expected value' ); + + v = cidentity( new Complex128( 0.0, -0.0 ) ); + t.equal( isPositiveZero( real( v ) ), true, 'returns expected value' ); + t.equal( isNegativeZero( imag( v ) ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function evaluates the identity function when provided +-infinity', opts, function test( t ) { + var v; + + v = cidentity( new Complex128( PINF, PINF ) ); + t.equal( real( v ), PINF, 'returns expected value' ); + t.equal( imag( v ), PINF, 'returns expected value' ); + + v = cidentity( new Complex128( NINF, NINF ) ); + t.equal( real( v ), NINF, 'returns expected value' ); + t.equal( imag( v ), NINF, 'returns expected value' ); + + v = cidentity( new Complex128( NINF, PINF ) ); + t.equal( real( v ), NINF, 'returns expected value' ); + t.equal( imag( v ), PINF, 'returns expected value' ); + + v = cidentity( new Complex128( PINF, NINF ) ); + t.equal( real( v ), PINF, 'returns expected value' ); + t.equal( imag( v ), NINF, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function evaluates the identity function when provided `NaN`', opts, function test( t ) { + var v; + + v = cidentity( new Complex128( NaN, NaN ) ); + t.equal( isnan( real( v ) ), true, 'returns expected value' ); + t.equal( isnan( imag( v ) ), true, 'returns expected value' ); + + v = cidentity( new Complex128( 1.0, NaN ) ); + t.equal( real( v ), 1.0, 'returns expected value' ); + t.equal( isnan( imag( v ) ), true, 'returns expected value' ); + + v = cidentity( new Complex128( NaN, 1.0 ) ); + t.equal( isnan( real( v ) ), true, 'returns expected value' ); + t.equal( imag( v ), 1.0, 'returns expected value' ); + + t.end(); +});