diff --git a/base/special/ccis/README.md b/base/special/ccis/README.md index e691da272..c6da238d0 100644 --- a/base/special/ccis/README.md +++ b/base/special/ccis/README.md @@ -18,11 +18,11 @@ limitations under the License. --> -# cis +# ccis -> Compute the [cis][cis] function of a complex number. +> Evaluate the [cis][cis] function for a double-precision complex floating-point number. -
+
The [cis][cis] function is defined as @@ -48,33 +48,39 @@ The [cis][cis] function is defined as ## Usage ```javascript -var cis = require( '@stdlib/math/base/special/ccis' ); +var ccis = require( '@stdlib/math/base/special/ccis' ); ``` -#### cis( \[out,] re, im ) +#### ccis( z ) -Evaluates the [cis][cis] function with a `complex` argument comprised of a **real** component `re` and an **imaginary** component `im`. +Evaluates the [cis][cis] function for a double-precision complex floating-point number. ```javascript -var v = cis( 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 = cis( 1.0, 0.0 ); -// returns [ ~0.540, ~0.841 ] -``` +var z = new Complex128( 0.0, 0.0 ); -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 v = ccis( z ); +// returns -```javascript -var Float64Array = require( '@stdlib/array/float64' ); +var re = real( v ); +// returns 1.0 + +var im = imag( v ); +// returns 0.0 -var out = new Float64Array( 2 ); +z = new Complex128( 1.0, 0.0 ); -var v = cis( out, 1.0, 0.0 ); -// returns [ ~0.540, ~0.841 ] +v = ccis( z ); +// returns -var bool = ( v === out ); -// returns true +re = real( v ); +// returns ~0.540 + +im = imag( v ); +// returns ~0.841 ```
@@ -89,28 +95,124 @@ var bool = ( v === out ); ```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 cis = require( '@stdlib/math/base/special/ccis' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var ccis = require( '@stdlib/math/base/special/ccis' ); -var re; -var im; var z1; var z2; -var o; 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 = new Complex128( uniform( -50.0, 50.0 ), uniform( -50.0, 50.0 ) ); + z2 = ccis( z1 ); + console.log( 'ccis(%s) = %s', z1.toString(), z2.toString() ); +} +``` + +
+ + - o = cis( [ 0.0, 0.0 ], real(z1), imag(z1) ); - z2 = new Complex128( o[ 0 ], o[ 1 ] ); + - console.log( 'cis(%s) = %s', z1.toString(), z2.toString() ); +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/ccis.h" +``` + +#### stdlib_base_ccis( z ) + +Evaluates the [cis][cis] function for 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_ccis( 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_ccis( const stdlib_complex128_t z ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/ccis.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 re; + double im; + int i; + for ( i = 0; i < 4; i++ ) { + v = x[ i ]; + stdlib_reim( v, &re, &im ); + printf( "z = %lf + %lfi\n", re, im ); + + y = stdlib_base_ccis( v ); + stdlib_reim( y, &re, &im ); + printf( "ccis(z) = %lf + %lfi\n", re, im ); + } } ``` @@ -118,6 +220,10 @@ for ( i = 0; i < 100; i++ ) { +
+ + +
diff --git a/base/special/ccis/benchmark/benchmark.js b/base/special/ccis/benchmark/benchmark.js index 70d0f7d67..1fdb29c42 100644 --- a/base/special/ccis/benchmark/benchmark.js +++ b/base/special/ccis/benchmark/benchmark.js @@ -21,58 +21,37 @@ // 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( './../../../../base/assert/is-nan' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); +var Complex128 = require( '@stdlib/complex/float64' ); var pkg = require( './../package.json' ).name; -var cis = require( './../lib' ); +var ccis = 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 = cis( 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 = [ 0.0, 0.0 ]; + 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 = cis( out, re, im ); - if ( y.length === 0 ) { - b.fail( 'should not be empty' ); + y = ccis( values[ i%values.length ] ); + if ( isnan( real( y ) ) ) { + b.fail( 'should not return NaN' ); } } b.toc(); - if ( !isArray( y ) ) { - b.fail( 'should return an array' ); + if ( isnan( imag( y ) ) ) { + b.fail( 'should not return NaN' ); } b.pass( 'benchmark finished' ); b.end(); diff --git a/base/special/ccis/benchmark/benchmark.native.js b/base/special/ccis/benchmark/benchmark.native.js new file mode 100644 index 000000000..b4e62f7ac --- /dev/null +++ b/base/special/ccis/benchmark/benchmark.native.js @@ -0,0 +1,69 @@ +/** +* @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 real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var ccis = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( ccis instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var values; + var y; + var z; + 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++ ) { + z = values[ i%values.length ]; + y = ccis( z ); + if ( isnan( real( y ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( imag( y ) ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/base/special/ccis/benchmark/c/native/Makefile b/base/special/ccis/benchmark/c/native/Makefile new file mode 100644 index 000000000..3cbfe3fef --- /dev/null +++ b/base/special/ccis/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @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 + +# 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/base/special/ccis/benchmark/c/native/benchmark.c b/base/special/ccis/benchmark/c/native/benchmark.c new file mode 100644 index 000000000..05f126034 --- /dev/null +++ b/base/special/ccis/benchmark/c/native/benchmark.c @@ -0,0 +1,145 @@ +/** +* @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 `ccis`. +*/ +#include "stdlib/math/base/special/ccis.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include +#include +#include +#include +#include + +#define NAME "ccis" +#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; + int i; + + stdlib_complex128_t z1; + stdlib_complex128_t z2; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + re = ( 1000.0*rand_double() ) - 500.0; + im = ( 1000.0*rand_double() ) - 500.0; + z1 = stdlib_complex128( re, im ); + + z2 = stdlib_base_ccis( z1 ); + stdlib_reim( z2, &re, &im ); + if ( re != re ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( im != im ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/base/special/ccis/binding.gyp b/base/special/ccis/binding.gyp new file mode 100644 index 000000000..f2b466aef --- /dev/null +++ b/base/special/ccis/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/ccis/docs/repl.txt b/base/special/ccis/docs/repl.txt index cb1ca7f4d..6d407160f 100644 --- a/base/special/ccis/docs/repl.txt +++ b/base/special/ccis/docs/repl.txt @@ -1,36 +1,32 @@ -{{alias}}( [out,] re, im ) - Computes the cis function of a complex number. +{{alias}}( z ) + Evaluates the cis function for 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 ] - - > var y = {{alias}}( 1.0, 0.0 ) - [ ~0.540, ~0.841 ] - - > var out = new {{alias:@stdlib/array/float64}}( 2 ); - > var v = {{alias}}( out, 1.0, 0.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}}( 1.0, 0.0 ) ) + + > re = {{alias:@stdlib/complex/real}}( y ) + ~0.540 + > im = {{alias:@stdlib/complex/imag}}( y ) + ~0.841 See Also -------- diff --git a/base/special/ccis/docs/types/index.d.ts b/base/special/ccis/docs/types/index.d.ts index 8c277b838..23fe53830 100644 --- a/base/special/ccis/docs/types/index.d.ts +++ b/base/special/ccis/docs/types/index.d.ts @@ -20,43 +20,48 @@ /// -import { ArrayLike } from '@stdlib/types/array'; +import { Complex128 } from '@stdlib/types/object'; /** -* Computes the cis function of a complex number. +* Evaluates the cis function for 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 out = [ 0.0, 0.0 ]; +* var Complex128 = require( `@stdlib/complex/float64` ); +* var real = require( `@stdlib/complex/real` ); +* var imag = require( `@stdlib/complex/imag` ); * -* var v = cis( out, 1.0, 0.0 ); -* // returns [ ~0.540, ~0.841 ] +* var z = new Complex128( 0.0, 0.0 ); +* // returns * -* var bool = ( v === out ); -* // returns true -*/ -declare function cis( out: ArrayLike, re: number, im: number ): ArrayLike; // tslint-disable-line max-line-length - -/** -* Computes the cis function of a complex number. +* var out = ccis( z ); +* // returns * -* @param re - real component -* @param im - imaginary component -* @returns real and imaginary components +* var re = real( out ); +* // returns 1.0 * +* var im = imag( out ); +* // returns 0.0 * @example -* var v = cis( 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 = cis( 1.0, 0.0 ); -* // returns [ ~0.540, ~0.841 ] +* var z = new Complex128( 1.0, 0.0 ); +* // returns +* +* var out = ccis( z ); +* // returns +* +* var re = real( out ); +* // returns ~0.540 +* +* var im = imag( out ); +* // returns ~0.841 */ -declare function cis( re: number, im: number ): ArrayLike; +declare function cis( z: Complex128 ): Complex128; // EXPORTS // diff --git a/base/special/ccis/docs/types/test.ts b/base/special/ccis/docs/types/test.ts index 9c2e4a708..77fcd66cf 100644 --- a/base/special/ccis/docs/types/test.ts +++ b/base/special/ccis/docs/types/test.ts @@ -16,53 +16,36 @@ * limitations under the License. */ -import cis = require( './index' ); +import Complex128 = require( '@stdlib/complex/float64' ); +import ccis = require( './index' ); // TESTS // -// The function returns an array of numbers... +// The function returns a double-precision complex floating-point number... { - cis( -4, 3 ); // $ExpectType ArrayLike - cis( [], 5, 3 ); // $ExpectType ArrayLike -} + const z = new Complex128( 1.0, 1.0 ); -// The compiler throws an error if the function is provided a real component which is not a number... -{ - cis( true, 3 ); // $ExpectError - cis( false, 3 ); // $ExpectError - cis( null, 3 ); // $ExpectError - cis( undefined, 3 ); // $ExpectError - cis( '5', 3 ); // $ExpectError - cis( [], 3 ); // $ExpectError - cis( {}, 3 ); // $ExpectError - cis( ( x: number ): number => x, 3 ); // $ExpectError + ccis( z ); // $ExpectType Complex128 } -// The compiler throws an error if the function is provided an imaginary component which is not a number... +// The compiler throws an error if the function is provided a first argument which is not a complex number... { - cis( 5, true ); // $ExpectError - cis( 5, false ); // $ExpectError - cis( 5, null ); // $ExpectError - cis( 5, undefined ); // $ExpectError - cis( 5, '5' ); // $ExpectError - cis( 5, [] ); // $ExpectError - cis( 5, {} ); // $ExpectError - cis( 5, ( x: number ): number => x ); // $ExpectError + ccis( true ); // $ExpectError + ccis( false ); // $ExpectError + ccis( null ); // $ExpectError + ccis( undefined ); // $ExpectError + ccis( '5' ); // $ExpectError + ccis( [] ); // $ExpectError + ccis( {} ); // $ExpectError + ccis( ( x: number ): number => x ); // $ExpectError } -// The compiler throws an error if the function is provided an output array which is not array-like... +// The compiler throws an error if the function is provided an unsupported number of arguments... { - cis( true, 5, 3 ); // $ExpectError - cis( false, 5, 3 ); // $ExpectError - cis( 'abc', 5, 3 ); // $ExpectError - cis( {}, 5, 3 ); // $ExpectError - cis( ( x: number ): number => x, 5, 3 ); // $ExpectError - cis( 123, 5, 3 ); // $ExpectError -} + const z = new Complex128( 1.0, 1.0 ); -// The compiler throws an error if the function is provided insufficient arguments... -{ - cis(); // $ExpectError - cis( 2 ); // $ExpectError + ccis(); // $ExpectError + ccis( z, z ); // $ExpectError + ccis( z, z, z ); // $ExpectError } diff --git a/base/special/ccis/examples/c/Makefile b/base/special/ccis/examples/c/Makefile new file mode 100644 index 000000000..70c91f4e1 --- /dev/null +++ b/base/special/ccis/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/base/special/ccis/examples/c/example.c b/base/special/ccis/examples/c/example.c new file mode 100644 index 000000000..1ff4a3945 --- /dev/null +++ b/base/special/ccis/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/ccis.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 re; + double im; + int i; + for ( i = 0; i < 4; i++ ) { + v = x[ i ]; + stdlib_reim( v, &re, &im ); + printf( "z = %lf + %lfi\n", re, im ); + + y = stdlib_base_ccis( v ); + stdlib_reim( y, &re, &im ); + printf( "ccis(z) = %lf + %lfi\n", re, im ); + } +} diff --git a/base/special/ccis/examples/index.js b/base/special/ccis/examples/index.js index 89e584543..c9814c62a 100644 --- a/base/special/ccis/examples/index.js +++ b/base/special/ccis/examples/index.js @@ -19,26 +19,15 @@ 'use strict'; var Complex128 = require( '@stdlib/complex/float64' ); -var randu = require( '@stdlib/random/base/randu' ); -var round = require( './../../../../base/special/round' ); -var real = require( '@stdlib/complex/real' ); -var imag = require( '@stdlib/complex/imag' ); -var cis = require( './../lib' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var ccis = require( './../lib' ); -var re; -var im; var z1; var z2; -var o; 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 ); - - o = cis( [ 0.0, 0.0 ], real(z1), imag(z1) ); - z2 = new Complex128( o[ 0 ], o[ 1 ] ); - - console.log( 'cis(%s) = %s', z1.toString(), z2.toString() ); + z1 = new Complex128( uniform( -50.0, 50.0 ), uniform( -50.0, 50.0 ) ); + z2 = ccis( z1 ); + console.log( 'ccis(%s) = %s', z1.toString(), z2.toString() ); } diff --git a/base/special/ccis/include.gypi b/base/special/ccis/include.gypi new file mode 100644 index 000000000..78db9faf8 --- /dev/null +++ b/base/special/ccis/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 out = ccis( z ); +* // returns +* +* var re = real( out ); +* // returns 1.0 +* +* var im = imag( out ); +* // returns 0.0 * * @example -* var cis = require( '@stdlib/math/base/special/ccis' ); +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* var ccis = require( '@stdlib/math/base/special/ccis' ); +* +* var z = new Complex128( 1.0, 0.0 ); +* // returns * -* var out = [ 0.0, 0.0 ]; +* var out = ccis( z ); +* // returns * -* var v = cis( out, 1.0, 0.0 ); -* // returns [ ~0.540, ~0.841 ] +* var re = real( out ); +* // returns ~0.540 * -* var bool = ( v === out ); -* // returns true +* var im = imag( out ); +* // returns ~0.841 */ // MODULES // diff --git a/base/special/ccis/lib/main.js b/base/special/ccis/lib/main.js index f4e5ba7a6..5ae957dfe 100644 --- a/base/special/ccis/lib/main.js +++ b/base/special/ccis/lib/main.js @@ -20,44 +20,79 @@ // MODULES // -var computeCis = require( './cis.js' ); +var sincos = require( './../../../../base/special/sincos' ).assign; +var exp = require( './../../../../base/special/exp' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); + + +// VARIABLES // + +// Pre-allocate workspace array: +var WORKSPACE = [ 0.0, 0.0 ]; // MAIN // /** -* Computes the cis function of a complex number. +* Evaluates the cis function for a double-precision complex floating-point 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 = cis( 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 = cis( 1.0, 0.0 ); -* // returns [ ~0.540, ~0.841 ] +* var z = new Complex128( 0.0, 0.0 ); +* // returns +* +* var out = ccis( z ); +* // returns +* +* var re = real( out ); +* // returns 1.0 +* +* var im = imag( out ); +* // 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 z = new Complex128( 1.0, 0.0 ); +* // returns +* +* var out = ccis( z ); +* // returns * -* var v = cis( out, 1.0, 0.0 ); -* // returns [ ~0.540, ~0.841 ] +* var re = real( out ); +* // returns ~0.54 * -* var bool = ( v === out ); -* // returns true +* var im = imag( out ); +* // returns ~0.841 */ -function cis( out, re, im ) { - if ( arguments.length === 2 ) { - return computeCis( [ 0.0, 0.0 ], out, re ); +function ccis( z ) { + var re; + var im; + var e; + + re = real( z ); + im = imag( z ); + + sincos( re, WORKSPACE, 1, 0 ); + if ( im !== 0.0 ) { + e = exp( -im ); + WORKSPACE[ 0 ] *= e; + WORKSPACE[ 1 ] *= e; } - return computeCis( out, re, im ); + return new Complex128( WORKSPACE[ 1 ], WORKSPACE[ 0 ] ); } // EXPORTS // -module.exports = cis; +module.exports = ccis; diff --git a/base/special/ccis/lib/native.js b/base/special/ccis/lib/native.js new file mode 100644 index 000000000..5481d09c8 --- /dev/null +++ b/base/special/ccis/lib/native.js @@ -0,0 +1,78 @@ +/** +* @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 cis function for a double-precision complex floating-point number. +* +* @private +* @param {Complex128} z - complex number +* @returns {Complex128} result +* +* @example +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var z = new Complex128( 0.0, 0.0 ); +* // returns +* +* var out = ccis( z ); +* // returns +* +* var re = real( out ); +* // returns 1.0 +* +* var im = imag( out ); +* // returns 0.0 +* +* @example +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var z = new Complex128( 1.0, 0.0 ); +* // returns +* +* var out = ccis( z ); +* // returns +* +* var re = real( out ); +* // returns ~0.540 +* +* var im = imag( out ); +* // returns ~0.841 +*/ +function ccis( z ) { + var v = addon( z ); + return new Complex128( v.re, v.im ); +} + + +// EXPORTS // + +module.exports = ccis; diff --git a/base/special/ccis/manifest.json b/base/special/ccis/manifest.json new file mode 100644 index 000000000..40172d7d0 --- /dev/null +++ b/base/special/ccis/manifest.json @@ -0,0 +1,78 @@ +{ + "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", + "@stdlib/math/base/special/exp" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float64", + "@stdlib/complex/reim", + "@stdlib/math/base/special/exp" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float64", + "@stdlib/complex/reim", + "@stdlib/math/base/special/exp" + ] + } + ] +} diff --git a/base/special/ccis/package.json b/base/special/ccis/package.json index 3c6e089e0..08a64c21f 100644 --- a/base/special/ccis/package.json +++ b/base/special/ccis/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/math/base/special/ccis", "version": "0.0.0", - "description": "Compute the cis function of a complex number.", + "description": "Compute the ccis function of a double-precision complex floating-point number.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -14,6 +14,7 @@ } ], "main": "./lib", + "gypfile": true, "directories": { "benchmark": "./benchmark", "doc": "./docs", diff --git a/base/special/ccis/src/Makefile b/base/special/ccis/src/Makefile new file mode 100644 index 000000000..a28d8988f --- /dev/null +++ b/base/special/ccis/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/base/special/ccis/src/addon.c b/base/special/ccis/src/addon.c new file mode 100644 index 000000000..f041a7256 --- /dev/null +++ b/base/special/ccis/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/ccis.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_Z_Z( stdlib_base_ccis ) diff --git a/base/special/ccis/src/main.c b/base/special/ccis/src/main.c new file mode 100644 index 000000000..bee6c416d --- /dev/null +++ b/base/special/ccis/src/main.c @@ -0,0 +1,79 @@ +/** +* @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/ccis.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include "stdlib/math/base/special/exp.h" +#include + + +/** +* Evaluates the cis function for a double-precision complex floating-point 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_ccis( z ); +* +* double re = stdlib_real( out ); +* // returns 1.0 +* +* double im = stdlib_imag( out ); +* // returns 0.0 +* +* @example +* #include "stdlib/complex/float64.h" +* #include "stdlib/complex/real.h" +* #include "stdlib/complex/imag.h" +* +* stdlib_complex128_t z = stdlib_complex128( 1.0, 0.0 ); +* +* stdlib_complex128_t out = stdlib_base_ccis( z ); +* +* double re = stdlib_real( out ); +* // returns ~0.540 +* +* double im = stdlib_imag( out ); +* // returns ~0.841 +*/ +stdlib_complex128_t stdlib_base_ccis( const stdlib_complex128_t z ) { + double re; + double im; + double y; + double x; + double e; + + stdlib_reim( z, &re, &im ); + + y = sin( re ); //TODO: use stdlib function once available + x = cos( re ); //TODO: use stdlib function once available + if( im != 0.0 ){ + e = stdlib_base_exp( -im ); + y *= e; + x *= e; + } + return stdlib_complex128( x, y ); +} diff --git a/base/special/ccis/test/test.js b/base/special/ccis/test/test.js index e928f3250..60ba3f334 100644 --- a/base/special/ccis/test/test.js +++ b/base/special/ccis/test/test.js @@ -22,11 +22,14 @@ var tape = require( 'tape' ); var isnan = require( './../../../../base/assert/is-nan' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); var abs = require( './../../../../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 cis = require( './../lib' ); +var ccis = require( './../lib' ); // FIXTURES // @@ -39,24 +42,20 @@ var generalComplex = require( './fixtures/julia/general_complex.json' ); tape( 'main export is a function', function test( t ) { t.ok( true, __filename ); - t.strictEqual( typeof cis, 'function', 'main export is a function' ); + t.strictEqual( typeof ccis, 'function', 'main export is a function' ); t.end(); }); -tape( 'the function accepts an optional output array', function test( t ) { - var result; - var out; +tape( 'the function evaluates the cis function for a double-precision complex floating-point number', function test( t ) { + var v; + var z; - out = [ 0.0, 0.0 ]; - result = cis( out, 0.0, 0.0 ); - t.deepEqual( out, [ 1.0, 0.0 ], 'returns expected values' ); - t.equal( out, result, 'returns output array' ); - t.end(); -}); + z = new Complex128( 0.0, 0.0 ); + v = ccis( z ); + + t.strictEqual( real( v ), 1.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); -tape( 'the function works without output array specified', function test( t ) { - var result = cis( 0.0, 0.0 ); - t.deepEqual( result, [ 1.0, 0.0 ], 'returns expected values' ); t.end(); }); @@ -69,6 +68,7 @@ tape( 'the function computes cis(z) for pure real z', function test( t ) { var im; var i; var q; + var z; re = pureReal.re; im = pureReal.im; @@ -76,21 +76,22 @@ tape( 'the function computes cis(z) for pure real z', function test( t ) { cisim = pureReal.cisim; for ( i = 0; i < re.length; i++ ) { - q = cis( re[ i ], im[ i ] ); + z = new Complex128( re[ i ], im[ i ] ); + q = ccis( z ); - if ( q[ 0 ] === cisre[ i ] ) { - t.strictEqual( q[ 0 ], cisre[ i ], 'returns expected real component' ); + if ( real( q ) === cisre[ i ] ) { + t.strictEqual( real( q ), cisre[ i ], 'returns expected real component' ); } else { - delta = abs( q[ 0 ] - cisre[ i ] ); + delta = abs( real( q ) - cisre[ i ] ); tol = EPS * abs( cisre[ i ] ); - t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+q[0]+'. expected: '+cisre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+real( q )+'. expected: '+cisre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); } - if ( q[ 1 ] === cisim[ i ] ) { - t.strictEqual( q[ 1 ], cisim[ i ], 'returns expected imaginary component' ); + if ( imag( q ) === cisim[ i ] ) { + t.strictEqual( imag( q ), cisim[ i ], 'returns expected imaginary component' ); } else { - delta = abs( q[ 1 ] - cisim[ i ] ); + delta = abs( imag( q ) - cisim[ i ] ); tol = EPS * abs( cisim[ i ] ); - t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+q[1]+'. expected: '+cisim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+imag( q )+'. expected: '+cisim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); } } t.end(); @@ -105,6 +106,7 @@ tape( 'the function computes cis(z) for complex z', function test( t ) { var im; var i; var q; + var z; re = generalComplex.re; im = generalComplex.im; @@ -112,72 +114,81 @@ tape( 'the function computes cis(z) for complex z', function test( t ) { cisim = generalComplex.cisim; for ( i = 0; i < re.length; i++ ) { - q = cis( re[ i ], im[ i ] ); + z = new Complex128( re[ i ], im[ i ] ); + q = ccis( z ); - if ( q[ 0 ] === cisre[ i ] ) { - t.strictEqual( q[ 0 ], cisre[ i ], 'returns expected real component' ); + if ( real( q ) === cisre[ i ] ) { + t.strictEqual( real( q ), cisre[ i ], 'returns expected real component' ); } else { - delta = abs( q[ 0 ] - cisre[ i ] ); + delta = abs( real( q ) - cisre[ i ] ); tol = EPS * abs( cisre[ i ] ); - t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+q[0]+'. expected: '+cisre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+real( q )+'. expected: '+cisre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); } - if ( q[ 1 ] === cisim[ i ] ) { - t.strictEqual( q[ 1 ], cisim[ i ], 'returns expected imaginary component' ); + if ( imag( q ) === cisim[ i ] ) { + t.strictEqual( imag( q ), cisim[ i ], 'returns expected imaginary component' ); } else { - delta = abs( q[ 1 ] - cisim[ i ] ); + delta = abs( imag( q ) - cisim[ i ] ); tol = EPS * abs( cisim[ i ] ); - t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+q[1]+'. expected: '+cisim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+imag( q )+'. expected: '+cisim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); } } t.end(); }); -tape( 'if real component is `+Infinity`, the function returns `[NaN, NaN]`', function test( t ) { - var v = cis( PINF, 0.0 ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); +tape( 'if real component is `+Infinity`, all components are `NaN`', function test( t ) { + var v; + + v = ccis( new Complex128( PINF, 0.0 ) ); + 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 `[NaN, NaN]`', function test( t ) { - var v = cis( NINF, 0.0 ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); +tape( 'if real component is `-Infinity`, all components are `NaN`', function test( t ) { + var v; + + v = ccis( new Complex128( NINF, 0.0 ) ); + 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 `[0.0, 0.0]`', function test( t ) { - var v = cis( 1.0, PINF ); - t.strictEqual( v[ 0 ], 0.0, 'returns 0.0' ); - t.strictEqual( v[ 1 ], 0.0, 'returns 0.0' ); +tape( 'if imaginary component is `+Infinity`, all components are zero', function test( t ) { + var v; + + v = ccis( new Complex128( 1.0, PINF ) ); + t.strictEqual( real( v ), 0.0, 'returns 0.0' ); + t.strictEqual( imag( v ), 0.0, 'returns 0.0' ); t.end(); }); tape( 'if imaginary component is `-Infinity`, the function computes the correct result according to IEEE 754 rules', function test( t ) { - var v = cis( 0.0, NINF ); + var v; + + v = ccis( new Complex128( 0.0, NINF ) ); // The real component is computed as Infinity * 1.0 = Infinity: - t.strictEqual( v[ 0 ], PINF, 'returns +Infinity' ); + t.strictEqual( real( v ), PINF, 'returns +Infinity' ); // The imaginary component is computed as Infinity * 0.0 = NaN: - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); t.end(); }); tape( 'if a real or imaginary component is `NaN`, all components are `NaN`', function test( t ) { var v; - v = cis( NaN, 3.0 ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + v = ccis( new Complex128( NaN, 3.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); - v = cis( 5.0, NaN ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + v = ccis( new Complex128( 5.0, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); - v = cis( NaN, NaN ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + v = ccis( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); t.end(); }); diff --git a/base/special/ccis/test/test.native.js b/base/special/ccis/test/test.native.js new file mode 100644 index 000000000..a80193115 --- /dev/null +++ b/base/special/ccis/test/test.native.js @@ -0,0 +1,203 @@ +/** +* @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( './../../../../base/assert/is-nan' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); +var abs = require( './../../../../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 tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var ccis = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( ccis instanceof Error ) +}; + + +// FIXTURES // + +var pureReal = require( './fixtures/julia/pure_real.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 ccis, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function evaluates the cis function for a double-precision complex floating-point number', opts, function test( t ) { + var v; + var z; + + z = new Complex128( 0.0, 0.0 ); + v = ccis( z ); + + t.strictEqual( real( v ), 1.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function computes cis(z) for pure real z', opts, function test( t ) { + var delta; + var cisre; + var cisim; + var tol; + var re; + var im; + var i; + var q; + var z; + + re = pureReal.re; + im = pureReal.im; + cisre = pureReal.cisre; + cisim = pureReal.cisim; + + for ( i = 0; i < re.length; i++ ) { + z = new Complex128( re[ i ], im[ i ] ); + q = ccis( z ); + + if ( real( q ) === cisre[ i ] ) { + t.strictEqual( real( q ), cisre[ i ], 'returns expected real component' ); + } else { + delta = abs( real( q ) - cisre[ i ] ); + tol = EPS * abs( cisre[ i ] ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+real( q )+'. expected: '+cisre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + if ( imag( q ) === cisim[ i ] ) { + t.strictEqual( imag( q ), cisim[ i ], 'returns expected imaginary component' ); + } else { + delta = abs( imag( q ) - cisim[ i ] ); + tol = EPS * abs( cisim[ i ] ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+imag( q )+'. expected: '+cisim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'the function computes cis(z) for complex z', opts, function test( t ) { + var delta; + var cisre; + var cisim; + var tol; + var re; + var im; + var i; + var q; + var z; + + re = generalComplex.re; + im = generalComplex.im; + cisre = generalComplex.cisre; + cisim = generalComplex.cisim; + + for ( i = 0; i < re.length; i++ ) { + z = new Complex128( re[ i ], im[ i ] ); + q = ccis( z ); + + if ( real( q ) === cisre[ i ] ) { + t.strictEqual( real( q ), cisre[ i ], 'returns expected real component' ); + } else { + delta = abs( real( q ) - cisre[ i ] ); + tol = EPS * abs( cisre[ i ] ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. real: '+real( q )+'. expected: '+cisre[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + if ( imag( q ) === cisim[ i ] ) { + t.strictEqual( imag( q ), cisim[ i ], 'returns expected imaginary component' ); + } else { + delta = abs( imag( q ) - cisim[ i ] ); + tol = EPS * abs( cisim[ i ] ); + t.ok( delta <= tol, 'within tolerance. z: '+re[i]+'+ '+im[i]+'i. imag: '+imag( q )+'. expected: '+cisim[i]+'. delta: '+delta+'. tol: '+tol+'.' ); + } + } + t.end(); +}); + +tape( 'if real component is `+Infinity`, all components are `NaN`', opts, function test( t ) { + var v; + + v = ccis( new Complex128( PINF, 0.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if real component is `-Infinity`, all components are `NaN`', opts, function test( t ) { + var v; + + v = ccis( new Complex128( NINF, 0.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if imaginary component is `+Infinity`, all components are zeros', opts, function test( t ) { + var v; + + v = ccis( new Complex128( 1.0, PINF ) ); + t.strictEqual( real( v ), 0.0, 'returns 0.0' ); + t.strictEqual( imag( v ), 0.0, 'returns 0.0' ); + t.end(); +}); + +tape( 'if imaginary component is `-Infinity`, the function computes the correct result according to IEEE 754 rules', opts, function test( t ) { + var v; + + v = ccis( new Complex128( 0.0, NINF ) ); + + // The real component is computed as Infinity * 1.0 = Infinity: + t.strictEqual( real( v ), PINF, 'returns +Infinity' ); + + // The imaginary component is computed as Infinity * 0.0 = NaN: + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'if a real or imaginary component is `NaN`, all components are `NaN`', opts, function test( t ) { + var v; + + v = ccis( new Complex128( NaN, 3.0 ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + + v = ccis( new Complex128( 5.0, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + + v = ccis( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns NaN' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns NaN' ); + + t.end(); +});