From 462a99b320560d80db5d1e772b6c5a11ed76c5a1 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Fri, 21 Jul 2023 12:37:55 -0500 Subject: [PATCH 01/15] feat: remove out keyword, add C implementation and addon to cpolar API --- .../math/base/special/cpolar/README.md | 136 +++++++++++--- .../special/cpolar/benchmark/benchmark.js | 26 --- .../cpolar/benchmark/benchmark.native.js | 65 +++++++ .../cpolar/benchmark/c/native/Makefile | 146 +++++++++++++++ .../cpolar/benchmark/c/native/benchmark.c | 144 +++++++++++++++ .../math/base/special/cpolar/binding.gyp | 170 ++++++++++++++++++ .../math/base/special/cpolar/docs/repl.txt | 26 +-- .../base/special/cpolar/docs/types/index.d.ts | 31 +--- .../base/special/cpolar/docs/types/test.ts | 45 ++--- .../base/special/cpolar/examples/c/Makefile | 146 +++++++++++++++ .../base/special/cpolar/examples/c/example.c | 43 +++++ .../base/special/cpolar/examples/index.js | 4 +- .../math/base/special/cpolar/include.gypi | 53 ++++++ .../include/stdlib/math/base/special/cpolar.h | 40 +++++ .../math/base/special/cpolar/lib/cpolar.js | 60 ------- .../math/base/special/cpolar/lib/index.js | 16 +- .../math/base/special/cpolar/lib/main.js | 29 +-- .../math/base/special/cpolar/lib/native.js | 52 ++++++ .../math/base/special/cpolar/manifest.json | 81 +++++++++ .../math/base/special/cpolar/package.json | 3 +- .../math/base/special/cpolar/src/Makefile | 70 ++++++++ .../math/base/special/cpolar/src/addon.c | 140 +++++++++++++++ .../math/base/special/cpolar/src/main.c | 47 +++++ .../math/base/special/cpolar/test/test.js | 62 +------ .../base/special/cpolar/test/test.native.js | 76 ++++++++ 25 files changed, 1428 insertions(+), 283 deletions(-) create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/include/stdlib/math/base/special/cpolar.h delete mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/lib/cpolar.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md index 6f16127ee00..661f84b1c2d 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md @@ -18,9 +18,9 @@ limitations under the License. --> -# polar +# cpolar -> Compute the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a complex number. +> Compute the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a double-precision complex floating-point number.
@@ -36,27 +36,15 @@ limitations under the License. var cpolar = require( '@stdlib/math/base/special/cpolar' ); ``` -#### cpolar( \[out,] re, im ) +#### cpolar( z ) -Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a complex number comprised of a **real** component `re` and an **imaginary** component `im`. +Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a double-precision complex floating-point number. ```javascript -var o = cpolar( 5.0, 3.0 ); -// returns [ ~5.83, ~0.5404 ] -``` - -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. - -```javascript -var Float64Array = require( '@stdlib/array/float64' ); - -var out = new Float64Array( 2 ); - -var o = cpolar( out, 5.0, 3.0 ); -// returns [ ~5.83, ~0.5404 ] +var Complex128 = require( '@stdlib/complex/float64' ); -var bool = ( o === out ); -// returns true +var o = cpolar( new Complex128( 5.0, 3.0 ) ); +// returns [ ~5.83, ~0.5404 ] ```
@@ -87,7 +75,7 @@ for ( i = 0; i < 100; i++ ) { re = round( randu()*100.0 ) - 50.0; im = round( randu()*100.0 ) - 50.0; z = new Complex128( re, im ); - o = cpolar( real(z), imag(z) ); + o = cpolar( z ); z = z.toString(); console.log( 'abs(%s) = %d. arg(%s) = %d', z, o[0], z, o[1] ); } @@ -97,6 +85,110 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/cpolar.h" +``` + +#### stdlib_base_cpolar( z ) + +Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of 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( 5.0, 3.0 ); +double abs; +double cphase; +stdlib_base_cpolar( z, &abs, &cphase ); +``` + +The function accepts the following arguments: + +- **z**: `[in] stdlib_complex128_t` input value. +- **abs**: `[out] double*` destination for the absolute value. +- **cphase**: `[out] double*` destination for the phase value in radians. + +```c +double stdlib_base_cpolar( const stdlib_complex128_t z, double *abs, double *cphase ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/cpolar.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include + +int main( void ) { + const stdlib_complex128_t x[] = { + stdlib_complex128( 3.14, 1.0 ), + stdlib_complex128( -3.14, -1.0 ), + stdlib_complex128( 0.0, 0.0 ), + stdlib_complex128( 0.0/0.0, 0.0/0.0 ) + }; + + int i; + double re; + double im; + double abs; + double cphase; + for ( i = 0; i < 12; i++ ) { + stdlib_base_cpolar( x[i], &abs, &cphase ); + stdlib_reim( x[i], &re, &im ); + printf( "cpolar(%lf + %lfi) => abs: %lf, cphase: %lf\n", re, im, abs, cphase ); + } +} +``` + +
+ + + +
+ + +
@@ -116,10 +208,6 @@ for ( i = 0; i < 100; i++ ) {
-[@stdlib/math/base/special/cabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cabs - -[@stdlib/math/base/special/cphase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cphase - [@stdlib/math/base/special/cabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cabs diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js index 71ff152afb9..e0b407d8df2 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js @@ -51,29 +51,3 @@ bench( pkg, function benchmark( b ) { 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 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - re = ( randu()*1000.0 ) - 500.0; - im = ( randu()*1000.0 ) - 500.0; - y = cpolar( out, 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(); -}); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.native.js new file mode 100644 index 00000000000..0c9f5d28a22 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.native.js @@ -0,0 +1,65 @@ +/** +* @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 isArray = require( '@stdlib/assert/is-array' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var cpolar = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cpolar 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 = cpolar( values[ i%values.length ] ); + 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(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/Makefile new file mode 100644 index 00000000000..3cbfe3fef3b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/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/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/benchmark.c new file mode 100644 index 00000000000..8408651475f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/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 `cpolar`. +*/ +#include "stdlib/math/base/special/cpolar.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include +#include +#include +#include +#include + +#define NAME "cpolar" +#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 cphase; + double abs; + double re; + double im; + double t; + int i; + + stdlib_complex128_t z; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + re = ( 1000.0*rand_double() ) - 500.0; + im = ( 1000.0*rand_double() ) - 500.0; + z = stdlib_complex128( re, im ); + stdlib_base_cpolar( z, &abs, &cphase); + if ( abs != abs ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( cphase != cphase ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/binding.gyp b/lib/node_modules/@stdlib/math/base/special/cpolar/binding.gyp new file mode 100644 index 00000000000..f2b466aef5c --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/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/cpolar/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt index 9749a395c59..ae2adef0003 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt @@ -1,35 +1,23 @@ -{{alias}}( [out,] re, im ) - Returns the absolute value and phase of a complex number. +{{alias}}( z ) + Returns the absolute value and phase 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 + out: Array Absolute value and phase, respectively. Examples -------- - > var out = {{alias}}( 5.0, 3.0 ) + > var out = {{alias}}( new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 ) ) [ ~5.83, ~0.5404 ] - // Provide an output array: - > out = new {{alias:@stdlib/array/float64}}( 2 ); - > var v = {{alias}}( out, 5.0, 3.0 ) - [ ~5.83, ~0.5404 ] - > var bool = ( v === out ) - true - See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts index 0fad2d665aa..ee69cae30d8 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts @@ -21,40 +21,21 @@ /// import { ArrayLike } from '@stdlib/types/array'; +import { Complex128 } from '@stdlib/types/object'; /** -* Computes the absolute value and the phase of a complex number. +* Computes the absolute value and the phase of a double-precision complex floating-point number. * -* @param out - output array -* @param re - real component -* @param im - imaginary component +* @param z - complex number * @returns absolute value and phase, respectively * * @example -* var Float32Array = require( `@stdlib/array/float32` ); +* var Complex128 = require( `@stdlib/complex/float64` ); * -* var out = new Float32Array( 2 ); -* -* var v = cpolar( out, 5.0, 3.0 ); -* // returns [ ~5.83, ~0.5404 ] -* -* var bool = ( v === out ); -* // returns true -*/ -declare function cpolar( out: ArrayLike, re: number, im: number ): ArrayLike; // tslint-disable-line max-line-length - -/** -* Computes the absolute value and the phase of a complex number. -* -* @param re - real component -* @param im - imaginary component -* @returns absolute value and phase, respectively -* -* @example -* var v = cpolar( 5.0, 3.0 ); +* var v = cpolar( new Complex128( 5.0, 3.0 ) ); * // returns [ ~5.83, ~0.5404 ] */ -declare function cpolar( re: number, im: number ): ArrayLike; +declare function cpolar( z: Complex128 ): ArrayLike; // EXPORTS // diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts index 5f153c36f6d..e10fe90f683 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import Complex128 = require( '@stdlib/complex/float64' ); import cpolar = require( './index' ); @@ -23,46 +24,22 @@ import cpolar = require( './index' ); // The function returns an array of numbers... { - cpolar( -4, 3 ); // $ExpectType ArrayLike - cpolar( [], 5, 3 ); // $ExpectType ArrayLike + cpolar( new Complex128( 5.0, 3.0 ) ); // $ExpectType ArrayLike } -// 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 complex number... { - cpolar( true, 3 ); // $ExpectError - cpolar( false, 3 ); // $ExpectError - cpolar( null, 3 ); // $ExpectError - cpolar( undefined, 3 ); // $ExpectError - cpolar( '5', 3 ); // $ExpectError - cpolar( [], 3 ); // $ExpectError - cpolar( {}, 3 ); // $ExpectError - cpolar( ( x: number ): number => x, 3 ); // $ExpectError -} - -// The compiler throws an error if the function is provided an imaginary component which is not a number... -{ - cpolar( 5, true ); // $ExpectError - cpolar( 5, false ); // $ExpectError - cpolar( 5, null ); // $ExpectError - cpolar( 5, undefined ); // $ExpectError - cpolar( 5, '5' ); // $ExpectError - cpolar( 5, [] ); // $ExpectError - cpolar( 5, {} ); // $ExpectError - cpolar( 5, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an output array which is not array-like... -{ - cpolar( true, 5, 3 ); // $ExpectError - cpolar( false, 5, 3 ); // $ExpectError - cpolar( 'abc', 5, 3 ); // $ExpectError - cpolar( {}, 5, 3 ); // $ExpectError - cpolar( ( x: number ): number => x, 5, 3 ); // $ExpectError - cpolar( 123, 5, 3 ); // $ExpectError + cpolar( true ); // $ExpectError + cpolar( false ); // $ExpectError + cpolar( null ); // $ExpectError + cpolar( undefined ); // $ExpectError + cpolar( '5' ); // $ExpectError + cpolar( [] ); // $ExpectError + cpolar( {} ); // $ExpectError + cpolar( ( x: number ): number => x ); // $ExpectError } // The compiler throws an error if the function is provided insufficient arguments... { cpolar(); // $ExpectError - cpolar( 2 ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/Makefile new file mode 100644 index 00000000000..f0ae66fecf0 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/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 := 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/cpolar/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c new file mode 100644 index 00000000000..816a8bd4116 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c @@ -0,0 +1,43 @@ + +/** +* @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/cpolar.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include + +int main( void ) { + const stdlib_complex128_t x[] = { + stdlib_complex128( 3.14, 1.0 ), + stdlib_complex128( -3.14, -1.0 ), + stdlib_complex128( 0.0, 0.0 ), + stdlib_complex128( 0.0/0.0, 0.0/0.0 ) + }; + + int i; + double re; + double im; + double abs; + double cphase; + for ( i = 0; i < 12; i++ ) { + stdlib_base_cpolar( x[i], &abs, &cphase ); + stdlib_reim( x[i], &re, &im ); + printf( "cpolar(%lf + %lfi) => abs: %lf, cphase: %lf\n", re, im, abs, cphase ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/examples/index.js b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/index.js index 3715c605c4a..8eba399d5e0 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/examples/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/index.js @@ -21,8 +21,6 @@ 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 cpolar = require( './../lib' ); var re; @@ -35,7 +33,7 @@ for ( i = 0; i < 100; i++ ) { re = round( randu()*100.0 ) - 50.0; im = round( randu()*100.0 ) - 50.0; z = new Complex128( re, im ); - o = cpolar( real(z), imag(z) ); + o = cpolar( z ); z = z.toString(); console.log( 'abs(%s) = %d. arg(%s) = %d', z, o[0], z, o[1] ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/include.gypi b/lib/node_modules/@stdlib/math/base/special/cpolar/include.gypi new file mode 100644 index 00000000000..78db9faf8c7 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/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': [ + ' + +/** +* Receives JavaScript callback invocation data. +* +* @private +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + napi_status status; + + // Get callback arguments: + size_t argc = 2; + napi_value argv[ 2 ]; + status = napi_get_cb_info( env, info, &argc, argv, NULL, NULL ); + assert( status == napi_ok ); + + // Check whether we were provided the correct number of arguments: + if ( argc < 2 ) { + status = napi_throw_error( env, NULL, "invalid invocation. Insufficient arguments." ); + assert( status == napi_ok ); + return NULL; + } + if ( argc > 2 ) { + status = napi_throw_error( env, NULL, "invalid invocation. Too many arguments." ); + assert( status == napi_ok ); + return NULL; + } + + bool res; + status = napi_is_typedarray( env, argv[ 0 ], &res ); + assert( status == napi_ok ); + if ( res == false ) { + status = napi_throw_type_error( env, NULL, "invalid argument. First argument must be a Float64Array." ); + assert( status == napi_ok ); + return NULL; + } + + // Get the first element out + napi_typedarray_type vtype0; + size_t len; + void *Out; + status = napi_get_typedarray_info( env, argv[ 0 ], &vtype0, &len, &Out, NULL, NULL ); + assert( status == napi_ok ); + if ( vtype0 != napi_float64_array ) { + status = napi_throw_type_error( env, NULL, "invalid argument. First argument must be a Float64Array." ); + assert( status == napi_ok ); + return NULL; + } + if ( len != 2 ) { + status = napi_throw_range_error( env, NULL, "invalid argument. First argument must have 2 elements." ); + assert( status == napi_ok ); + return NULL; + } + + // Get the real component + napi_value xre; + status = napi_get_named_property( env, argv[ 1 ], "re", &xre ); + assert( status == napi_ok ); + + napi_valuetype xretype; + status = napi_typeof( env, xre, &xretype ); + assert( status == napi_ok ); + if ( xretype != napi_number ) { + status = napi_throw_type_error( env, NULL, "invalid argument. First argument must have a real component which is a number." ); + assert( status == napi_ok ); + return NULL; + } + + // Get the imaginary component + napi_value xim; + status = napi_get_named_property( env, argv[ 1 ], "im", &xim ); + assert( status == napi_ok ); + + napi_valuetype ximtype; + status = napi_typeof( env, xim, &ximtype ); + assert( status == napi_ok ); + if ( ximtype != napi_number ) { + status = napi_throw_type_error( env, NULL, "invalid argument. First argument must have an imaginary component which a number." ); + assert( status == napi_ok ); + return NULL; + } + + double re; + status = napi_get_value_double( env, xre, &re ); + assert( status == napi_ok ); + + double im; + status = napi_get_value_double( env, xim, &im ); + assert( status == napi_ok ); + + double abs; + double cphase; + stdlib_base_cpolar( stdlib_complex128( re, im ), &abs, &cphase ); + + double *op = (double *)Out; + op[ 0 ] = abs; + op[ 1 ] = cphase; + + return NULL; +} + +/** +* Initializes a Node-API module. +* +* @private +* @param env environment under which the function is invoked +* @param exports exports object +* @return main export +*/ +static napi_value init( napi_env env, napi_value exports ) { + napi_value fcn; + napi_status status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, addon, NULL, &fcn ); + assert( status == napi_ok ); + return fcn; +} + +NAPI_MODULE( NODE_GYP_MODULE_NAME, init ) \ No newline at end of file diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c new file mode 100644 index 00000000000..954bd2ba6ed --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c @@ -0,0 +1,47 @@ +/** +* @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/cpolar.h" +#include "stdlib/math/base/special/cphase.h" +#include "stdlib/math/base/special/cabs.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include + +/** +* Computes the absolute value and the phase of a complex double-precision complex floating-point number. +* +* @param z input value +* @param out result +* +* @example +* #include "stdlib/complex/float64.h" +* #include "stdlib/complex/real.h" +* #include "stdlib/complex/imag.h" +* +* stdlib_complex128_t z = stdlib_complex128( 5.0, 3.0 ); +* double abs; +* double cphase; +* stdlib_base_cpolar( z, &abs, &cphase ); +* // out = [ ~5.83, ~0.5404 ] +*/ +void stdlib_base_cpolar( const stdlib_complex128_t z, double *abs, double *cphase ) { + *abs = stdlib_base_cabs( z ); + *cphase = stdlib_base_cphase( z ); + return; +} diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.js b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.js index 16c5a3ad51d..d43f7012db3 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.js @@ -25,7 +25,6 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); var cabs = require( '@stdlib/math/base/special/cabs' ); var Complex128 = require( '@stdlib/complex/float64' ); var cphase = require( '@stdlib/math/base/special/cphase' ); -var Float64Array = require( '@stdlib/array/float64' ); var cpolar = require( './../lib' ); @@ -41,7 +40,7 @@ tape( 'the function computes the absolute value and phase of a complex number', var expected; var v; - v = cpolar( 5.0, 3.0 ); + v = cpolar( new Complex128( 5.0, 3.0 ) ); expected = [ cabs( new Complex128( 5.0, 3.0 ) ), cphase( new Complex128( 5.0, 3.0 ) ) ]; t.deepEqual( v, expected, 'returns expected value' ); @@ -49,71 +48,18 @@ tape( 'the function computes the absolute value and phase of a complex number', t.end(); }); -tape( 'the function computes the absolute value and phase of a complex number (output array)', function test( t ) { - var expected; - var out; - var v; - - out = new Array( 2 ); - v = cpolar( out, 5.0, 3.0 ); - - expected = [ cabs( new Complex128( 5.0, 3.0 ) ), cphase( new Complex128( 5.0, 3.0 ) ) ]; - - t.deepEqual( v, expected, 'returns expected value' ); - t.strictEqual( v, out, 'returns output value' ); - - t.end(); -}); - -tape( 'the function computes the absolute value and phase of a complex number (output typed array)', function test( t ) { - var expected; - var out; - var abs; - var v; - - out = new Float64Array( 2 ); - v = cpolar( out, 5.0, 3.0 ); - - abs = cabs( new Complex128( 5.0, 3.0 ) ); - expected = new Float64Array( [ abs, cphase( new Complex128( 5.0, 3.0 ) ) ] ); - - t.deepEqual( v, expected, 'returns expected value' ); - t.strictEqual( v, out, 'returns output value' ); - - t.end(); -}); - -tape( 'the function computes the absolute value and phase of a complex number (output object)', function test( t ) { - var expected; - var out; - var v; - - out = {}; - v = cpolar( out, 5.0, 3.0 ); - - expected = { - '0': cabs( new Complex128( 5.0, 3.0 ) ), - '1': cphase( new Complex128( 5.0, 3.0 ) ) - }; - - t.deepEqual( v, expected, 'returns expected value' ); - t.strictEqual( v, out, 'returns output value' ); - - t.end(); -}); - tape( 'if a real or imaginary component is `NaN`, both the absolute value and phase are `NaN`', function test( t ) { var v; - v = cpolar( NaN, 3.0 ); + v = cpolar( new Complex128( NaN, 3.0 ) ); t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); - v = cpolar( 5.0, NaN ); + v = cpolar( new Complex128( 5.0, NaN ) ); t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); - v = cpolar( NaN, NaN ); + v = cpolar( new Complex128( NaN, NaN ) ); t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.native.js new file mode 100644 index 00000000000..060afd56621 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.native.js @@ -0,0 +1,76 @@ +/** +* @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 cabs = require( '@stdlib/math/base/special/cabs' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var cphase = require( '@stdlib/math/base/special/cphase' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var cpolar = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cpolar instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cpolar, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function computes the absolute value and phase of a complex number', opts, function test( t ) { + var expected; + var v; + + v = cpolar( new Complex128( 5.0, 3.0 ) ); + expected = [ cabs( new Complex128( 5.0, 3.0 ) ), cphase( new Complex128( 5.0, 3.0 ) ) ]; + + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if a real or imaginary component is `NaN`, both the absolute value and phase are `NaN`', opts, function test( t ) { + var v; + + v = cpolar( new Complex128( NaN, 3.0 ) ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + v = cpolar( new Complex128( 5.0, NaN ) ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + v = cpolar( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + t.end(); +}); From 4e0b556c3db793f53ce9a8ac14cf77d76c427185 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Mon, 24 Jul 2023 14:21:04 -0500 Subject: [PATCH 02/15] feat: add assign API to cpolar --- .../math/base/special/cpolar/README.md | 31 +++-- .../special/cpolar/benchmark/benchmark.js | 42 ++++++- .../math/base/special/cpolar/docs/repl.txt | 33 +++++- .../base/special/cpolar/docs/types/index.d.ts | 47 +++++++- .../base/special/cpolar/docs/types/test.ts | 68 ++++++++++- .../math/base/special/cpolar/lib/assign.js | 54 +++++++++ .../math/base/special/cpolar/lib/index.js | 20 ++++ .../math/base/special/cpolar/lib/main.js | 5 +- .../base/special/cpolar/test/test.assign.js | 107 ++++++++++++++++++ .../math/base/special/cpolar/test/test.js | 37 +----- .../base/special/cpolar/test/test.main.js | 68 +++++++++++ 11 files changed, 459 insertions(+), 53 deletions(-) create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/lib/assign.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/test/test.assign.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cpolar/test/test.main.js diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md index 661f84b1c2d..a26489e1b11 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md @@ -47,6 +47,23 @@ var o = cpolar( new Complex128( 5.0, 3.0 ) ); // returns [ ~5.83, ~0.5404 ] ``` +#### cpolar.assign( z, out, stride, offset ) + +Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a double-precision complex floating-point number and assigns results to a provided output array. + +```javascript +var Complex128 = require( '@stdlib/complex/float64' ); +var Float64Array = require( '@stdlib/array/float64' ); + +var out = new Float64Array( 2 ); + +var v = cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, 0 ); +// returns [ ~5.83, ~0.5404 ] + +var bool = ( v === out ); +// returns true +``` +
@@ -111,7 +128,7 @@ for ( i = 0; i < 100; i++ ) { #include "stdlib/math/base/special/cpolar.h" ``` -#### stdlib_base_cpolar( z ) +#### stdlib_base_cpolar( z, abs, cphase ) Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a double-precision complex floating-point number. @@ -168,11 +185,11 @@ int main( void ) { stdlib_complex128( 0.0/0.0, 0.0/0.0 ) }; - int i; + double cphase; double re; double im; double abs; - double cphase; + int i; for ( i = 0; i < 12; i++ ) { stdlib_base_cpolar( x[i], &abs, &cphase ); stdlib_reim( x[i], &re, &im ); @@ -206,14 +223,14 @@ int main( void ) { -
- - - [@stdlib/math/base/special/cabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cabs [@stdlib/math/base/special/cphase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cphase +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js index e0b407d8df2..ad2e9441049 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js @@ -21,8 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var isArray = require( '@stdlib/assert/is-array' ); +var Complex128 = require( '@stdlib/complex/float64' ); var pkg = require( './../package.json' ).name; var cpolar = require( './../lib' ); @@ -30,16 +31,18 @@ var cpolar = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { - var re; - var im; + 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++ ) { - re = ( randu()*1000.0 ) - 500.0; - im = ( randu()*1000.0 ) - 500.0; - y = cpolar( re, im ); + y = cpolar( values[ i%values.length ] ); if ( y.length === 0 ) { b.fail( 'should not be empty' ); } @@ -51,3 +54,30 @@ bench( pkg, function benchmark( b ) { b.pass( 'benchmark finished' ); b.end(); }); + +bench( pkg+':assign', 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 ) ) + ]; + + y = [ 0.0, 0.0 ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + cpolar.assign( values[ i%values.length ], y, 1, 0 ); + if ( y.length === 0 ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( !isArray( y ) ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt index ae2adef0003..4e32997f3a3 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt @@ -18,6 +18,37 @@ > var out = {{alias}}( new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 ) ) [ ~5.83, ~0.5404 ] - See Also + +{{alias}}.assign( z, out, stride, offset ) + Returns the absolute value and phase of a double-precision complex + floating-point number and assigns results to a provided output array. + + Parameters + ---------- + z: Complex128 + Complex number. + + out: Array + Destination array. + + stride: integer + Output array stride. + + offset: integer + Output array index offset. + + Returns + ------- + out: Array + Absolute value and phase, respectively. + + Examples -------- + > var out = new {{alias:@stdlib/array/float64}}( 2 ); + > var v = {{alias}}.assign( new {{alias:@stdlib/complex/float64}}( 5.0, 3.0 ), out, 1, 0 ) + [ ~5.83, ~0.5404 ] + > var bool = ( v === out ) + true + See Also + -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts index ee69cae30d8..30afbc7548c 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts @@ -20,8 +20,49 @@ /// -import { ArrayLike } from '@stdlib/types/array'; -import { Complex128 } from '@stdlib/types/object'; +import { Complex128, Collection } from '@stdlib/types/object'; + +/** + * Interface describing `cpolar`. + */ +interface Cpolar { + /** + * Computes the absolute value and the phase of a double-precision complex floating-point number. + * + * @param z - complex number + * @returns absolute value and phase, respectively + * + * @example + * var Complex128 = require( `@stdlib/complex/float64` ); + * + * var v = cpolar( new Complex128( 5.0, 3.0 ) ); + * // returns [ ~5.83, ~0.5404 ] + */ + ( z: Complex128 ): Array; + + /** + * Computes the absolute value and the phase of a double-precision complex floating-point number and assigns results to a provided output array. + * + * @param z - complex number + * @param out - output array + * @param stride - output array stride + * @param offset - output array index offset + * @returns output array + * + * @example + * var Complex128 = require( `@stdlib/complex/float64` ); + * var Float64Array = require( `@stdlib/array/float64` ); + * + * var out = new Float64Array( 2 ); + * + * var v = cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, 0 ); + * // returns [ ~5.83, ~0.5404 ] + * + * var bool = ( v === out ); + * // returns true + */ + assign( z: Complex128, out: Collection, stride: number, offset: number ): Collection; // tslint-disable-line max-line-length +} /** * Computes the absolute value and the phase of a double-precision complex floating-point number. @@ -35,7 +76,7 @@ import { Complex128 } from '@stdlib/types/object'; * var v = cpolar( new Complex128( 5.0, 3.0 ) ); * // returns [ ~5.83, ~0.5404 ] */ -declare function cpolar( z: Complex128 ): ArrayLike; +declare var cpolar: Cpolar; // EXPORTS // diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts index e10fe90f683..46289b1fc12 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts @@ -24,7 +24,7 @@ import cpolar = require( './index' ); // The function returns an array of numbers... { - cpolar( new Complex128( 5.0, 3.0 ) ); // $ExpectType ArrayLike + cpolar( new Complex128( 5.0, 3.0 ) ); // $ExpectType number[] } // The compiler throws an error if the function is provided a complex number... @@ -43,3 +43,69 @@ import cpolar = require( './index' ); { cpolar(); // $ExpectError } + +// Attached to the main export is an `assign` method which returns an array-like object containing numbers... +{ + const out = [ 0.0, 0.0 ]; + + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, 0 ); // $ExpectType Collection +} + +// The compiler throws an error if the `assign` method is provided a first argument which is not a number... +{ + const out = [ 0.0, 0.0 ]; + + cpolar.assign( true, out, 1, 0 ); // $ExpectError + cpolar.assign( false, out, 1, 0 ); // $ExpectError + cpolar.assign( '5', out, 1, 0 ); // $ExpectError + cpolar.assign( null, out, 1, 0 ); // $ExpectError + cpolar.assign( [], out, 1, 0 ); // $ExpectError + cpolar.assign( {}, out, 1, 0 ); // $ExpectError + cpolar.assign( ( x: number ): number => x, out, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object... +{ + cpolar.assign( new Complex128( 5.0, 3.0 ), 1, 1, 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), true, 1, 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), false, 1, 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), null, 1, 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), {}, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a third argument which is not a number... +{ + const out = [ 0.0, 0 ]; + + cpolar.assign( new Complex128( 5.0, 3.0 ), out, '5', 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, true, 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, false, 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, null, 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, [], 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, {}, 0 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided a fourth argument which is not a number... +{ + const out = [ 0.0, 0 ]; + + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, '5' ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, true ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, false ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, null ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, [] ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, {} ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... +{ + const out = [ 0.0, 0 ]; + + cpolar.assign(); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ) ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1 ); // $ExpectError + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, 0, 1 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/assign.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/assign.js new file mode 100644 index 00000000000..2576232d9f0 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/assign.js @@ -0,0 +1,54 @@ +/** +* @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 cabs = require( '@stdlib/math/base/special/cabs' ); +var cphase = require( '@stdlib/math/base/special/cphase' ); + + +// MAIN // + +/** +* Computes the absolute value and the phase of a double-precision complex floating-point number. +* +* @private +* @param {Complex128} z - complex number +* @param {Collection} out - output array +* @param {integer} stride - output array stride +* @param {NonNegativeInteger} offset - output array index offset +* @returns {Collection} absolute value and phase (in radians) +* +* @example +* var Complex128 = require( '@stdlib/complex/float64' ); +* +* var o = cpolar( new Complex128( 5.0, 3.0 ), [ 0.0, 0.0 ], 1, 0 ); +* // returns [ ~5.83, ~0.5404 ] +*/ +function cpolar( z, out, stride, offset ) { + out[ offset ] = cabs( z ); + out[ offset+stride ] = cphase( z ); + return out; +} + + +// EXPORTS // + +module.exports = cpolar; diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js index aa6987712e5..168e5b17fef 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js @@ -29,11 +29,31 @@ * * var o = cpolar( new Complex128( 5.0, 3.0 ) ); * // returns [ ~5.83, ~0.5404 ] +* +* @example +* var Complex128 = require( '@stdlib/complex/float64' ); +* var cpolar = require( '@stdlib/math/base/special/cpolar' ); +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var out = new Float64Array( 2 ); +* +* var v = cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, 0 ); +* // returns [ ~5.83, ~0.5404 ] +* +* var bool = ( v === out ); +* // returns true */ // MODULES // +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); var main = require( './main.js' ); +var assign = require( './assign.js' ); + + +// MAIN // + +setReadOnly( main, 'assign', assign ); // EXPORTS // diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/main.js index 6858b92d2d8..6c823036fc5 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/main.js @@ -20,8 +20,7 @@ // MODULES // -var cabs = require( '@stdlib/math/base/special/cabs' ); -var cphase = require( '@stdlib/math/base/special/cphase' ); +var computeCpolar = require( './assign.js' ); // MAIN // @@ -39,7 +38,7 @@ var cphase = require( '@stdlib/math/base/special/cphase' ); * // returns [ ~5.83, ~0.5404 ] */ function cpolar( z ) { - return [ cabs( z ), cphase( z ) ]; + return computeCpolar( z, [ 0.0, 0.0 ], 1, 0 ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.assign.js b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.assign.js new file mode 100644 index 00000000000..05b0800f211 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.assign.js @@ -0,0 +1,107 @@ +/** +* @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 tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var cabs = require( '@stdlib/math/base/special/cabs' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var Float64Array = require( '@stdlib/array/float64' ); +var cphase = require( '@stdlib/math/base/special/cphase' ); +var cpolar = require( './../lib/assign.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cpolar, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function computes the absolute value and phase of a complex number', function test( t ) { + var expected; + var out; + var v; + + out = [ 0.0, 0.0 ]; + + v = cpolar( new Complex128( 5.0, 3.0 ), out, 1, 0 ); + expected = [ cabs( new Complex128( 5.0, 3.0 ) ), + cphase( new Complex128( 5.0, 3.0 ) ) ]; + + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if a real or imaginary component is `NaN`, both the absolute value and phase are `NaN`', function test( t ) { + var out; + var v; + + out = [ 0.0, 0.0 ]; + + v = cpolar( new Complex128( NaN, 3.0 ), out, 1, 0 ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + v = cpolar( new Complex128( 5.0, NaN ), out, 1, 0 ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + v = cpolar( new Complex128( NaN, NaN ), out, 1, 0 ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride', function test( t ) { + var out; + var val; + + out = new Float64Array( 4 ); + val = cpolar( new Complex128( 5.0, 3.0 ), out, 2, 0 ); + + t.strictEqual( val, out, 'returns output array' ); + t.strictEqual( val[ 0 ], cabs( new Complex128( 5.0, 3.0 ) ), 'returns expected value' ); + t.strictEqual( val[ 1 ], 0, 'returns expected value' ); + t.strictEqual( val[ 2 ], cphase( new Complex128( 5.0, 3.0 ) ), 'returns expected value' ); + t.strictEqual( val[ 3 ], 0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying an offset', function test( t ) { + var out; + var val; + + out = new Float64Array( 4 ); + val = cpolar( new Complex128( 5.0, 3.0 ), out, 2, 1 ); + + t.strictEqual( val, out, 'returns output array' ); + t.strictEqual( val[ 0 ], 0, 'returns expected value' ); + t.strictEqual( val[ 1 ], cabs( new Complex128( 5.0, 3.0 ) ), 'returns expected value' ); + t.strictEqual( val[ 2 ], 0, 'returns expected value' ); + t.strictEqual( val[ 3 ], cphase( new Complex128( 5.0, 3.0 ) ), 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.js b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.js index d43f7012db3..bbbf1442b7c 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2018 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. @@ -21,10 +21,7 @@ // MODULES // var tape = require( 'tape' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var cabs = require( '@stdlib/math/base/special/cabs' ); -var Complex128 = require( '@stdlib/complex/float64' ); -var cphase = require( '@stdlib/math/base/special/cphase' ); +var hasOwnProp = require( '@stdlib/assert/has-own-property' ); var cpolar = require( './../lib' ); @@ -36,32 +33,8 @@ tape( 'main export is a function', function test( t ) { t.end(); }); -tape( 'the function computes the absolute value and phase of a complex number', function test( t ) { - var expected; - var v; - - v = cpolar( new Complex128( 5.0, 3.0 ) ); - expected = [ cabs( new Complex128( 5.0, 3.0 ) ), cphase( new Complex128( 5.0, 3.0 ) ) ]; - - t.deepEqual( v, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'if a real or imaginary component is `NaN`, both the absolute value and phase are `NaN`', function test( t ) { - var v; - - v = cpolar( new Complex128( NaN, 3.0 ) ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); - - v = cpolar( new Complex128( 5.0, NaN ) ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); - - v = cpolar( new Complex128( NaN, NaN ) ); - t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); - t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); - +tape( 'attached to the main export is an `assign` method', function test( t ) { + t.strictEqual( hasOwnProp( cpolar, 'assign' ), true, 'has property' ); + t.strictEqual( typeof cpolar.assign, 'function', 'has method' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.main.js b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.main.js new file mode 100644 index 00000000000..995696e34e2 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.main.js @@ -0,0 +1,68 @@ +/** +* @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 tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var cabs = require( '@stdlib/math/base/special/cabs' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var cphase = require( '@stdlib/math/base/special/cphase' ); +var cpolar = require( './../lib/main.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cpolar, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function computes the absolute value and phase of a complex number', function test( t ) { + var expected; + var v; + + v = cpolar( new Complex128( 5.0, 3.0 ) ); + expected = [ cabs( new Complex128( 5.0, 3.0 ) ), + cphase( new Complex128( 5.0, 3.0 ) ) ]; + + t.deepEqual( v, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if a real or imaginary component is `NaN`, both the absolute value and phase are `NaN`', function test( t ) { + var v; + + v = cpolar( new Complex128( NaN, 3.0 ) ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + v = cpolar( new Complex128( 5.0, NaN ) ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + v = cpolar( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( v[ 0 ] ), true, 'returns NaN' ); + t.strictEqual( isnan( v[ 1 ] ), true, 'returns NaN' ); + + t.end(); +}); From 63358c6db0146f7a634cbdeb58e0519aca379f4e Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Gacha Date: Tue, 25 Jul 2023 11:18:39 -0500 Subject: [PATCH 03/15] docs: fix assign API type Co-authored-by: Athan --- .../@stdlib/math/base/special/cpolar/docs/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts index 30afbc7548c..272e83377ee 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts @@ -61,7 +61,7 @@ interface Cpolar { * var bool = ( v === out ); * // returns true */ - assign( z: Complex128, out: Collection, stride: number, offset: number ): Collection; // tslint-disable-line max-line-length + assign( z: Complex128, out: Collection, stride: number, offset: number ): Collection; // tslint-disable-line max-line-length } /** From f2df12a0589531905f29cee195d3d99eb371d464 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Gacha Date: Tue, 25 Jul 2023 11:22:22 -0500 Subject: [PATCH 04/15] docs: fix assign API type Co-authored-by: Athan --- .../@stdlib/math/base/special/cpolar/docs/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts index 272e83377ee..1fb38b48d22 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts @@ -61,7 +61,7 @@ interface Cpolar { * var bool = ( v === out ); * // returns true */ - assign( z: Complex128, out: Collection, stride: number, offset: number ): Collection; // tslint-disable-line max-line-length + assign( z: Complex128, out: Collection, stride: number, offset: number ): Collection; // tslint-disable-line max-line-length } /** From 7948d469f2dabe99e40c5669fd5cb71b6b192689 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Gacha Date: Tue, 25 Jul 2023 11:24:55 -0500 Subject: [PATCH 05/15] docs: fix test docs return type Co-authored-by: Athan --- .../@stdlib/math/base/special/cpolar/docs/types/test.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts index 46289b1fc12..8256aa0642a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/test.ts @@ -48,7 +48,8 @@ import cpolar = require( './index' ); { const out = [ 0.0, 0.0 ]; - cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, 0 ); // $ExpectType Collection + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, 0 ); // $ExpectType Collection + cpolar.assign( new Complex128( 5.0, 3.0 ), out, 1, 0 ); // $ExpectType Collection } // The compiler throws an error if the `assign` method is provided a first argument which is not a number... From 42587315c78df8afd4bde3cc0b0eca707ea61db2 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Mon, 31 Jul 2023 11:33:14 -0500 Subject: [PATCH 06/15] fix: add review changes --- .../math/base/special/cpolar/README.md | 16 ++++++------ .../special/cpolar/benchmark/benchmark.js | 2 +- .../cpolar/benchmark/c/native/benchmark.c | 12 ++++----- .../math/base/special/cpolar/docs/repl.txt | 4 +-- .../base/special/cpolar/examples/c/example.c | 14 +++++----- .../include/stdlib/math/base/special/cpolar.h | 4 +-- .../math/base/special/cpolar/lib/assign.js | 3 +-- .../math/base/special/cpolar/lib/index.js | 2 +- .../math/base/special/cpolar/lib/main.js | 6 ++--- .../math/base/special/cpolar/lib/native.js | 3 +-- .../math/base/special/cpolar/manifest.json | 2 +- .../math/base/special/cpolar/src/addon.c | 26 +++++++++---------- .../math/base/special/cpolar/src/main.c | 13 +++++----- .../base/special/cpolar/test/test.assign.js | 6 +++-- .../base/special/cpolar/test/test.main.js | 6 +++-- .../base/special/cpolar/test/test.native.js | 5 +++- 16 files changed, 64 insertions(+), 60 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md index a26489e1b11..429a8a5c457 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md @@ -128,7 +128,7 @@ for ( i = 0; i < 100; i++ ) { #include "stdlib/math/base/special/cpolar.h" ``` -#### stdlib_base_cpolar( z, abs, cphase ) +#### stdlib_base_cpolar( z, cabs, cphase ) Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a double-precision complex floating-point number. @@ -138,19 +138,19 @@ Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdli #include "stdlib/complex/imag.h" stdlib_complex128_t z = stdlib_complex128( 5.0, 3.0 ); -double abs; +double cabs; double cphase; -stdlib_base_cpolar( z, &abs, &cphase ); +stdlib_base_cpolar( z, &cabs, &cphase ); ``` The function accepts the following arguments: - **z**: `[in] stdlib_complex128_t` input value. -- **abs**: `[out] double*` destination for the absolute value. +- **cabs**: `[out] double*` destination for the absolute value. - **cphase**: `[out] double*` destination for the phase value in radians. ```c -double stdlib_base_cpolar( const stdlib_complex128_t z, double *abs, double *cphase ); +double stdlib_base_cpolar( const stdlib_complex128_t z, double *cabs, double *cphase ); ```
@@ -188,12 +188,12 @@ int main( void ) { double cphase; double re; double im; - double abs; + double cabs; int i; for ( i = 0; i < 12; i++ ) { - stdlib_base_cpolar( x[i], &abs, &cphase ); + stdlib_base_cpolar( x[i], &cabs, &cphase ); stdlib_reim( x[i], &re, &im ); - printf( "cpolar(%lf + %lfi) => abs: %lf, cphase: %lf\n", re, im, abs, cphase ); + printf( "cpolar(%lf + %lfi) => cabs: %lf, cphase: %lf\n", re, im, cabs, cphase ); } } ``` diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js index ad2e9441049..d340eeb7b3a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js @@ -71,7 +71,7 @@ bench( pkg+':assign', function benchmark( b ) { for ( i = 0; i < b.iterations; i++ ) { cpolar.assign( values[ i%values.length ], y, 1, 0 ); if ( y.length === 0 ) { - b.fail( 'should not return NaN' ); + b.fail( 'should not be empty' ); } } b.toc(); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/benchmark.c index 8408651475f..994fde2a399 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/c/native/benchmark.c @@ -97,21 +97,21 @@ double rand_double() { double benchmark() { double elapsed; double cphase; - double abs; - double re; - double im; + double cabs; + double re; + double im; double t; int i; - stdlib_complex128_t z; + stdlib_complex128_t z; t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { re = ( 1000.0*rand_double() ) - 500.0; im = ( 1000.0*rand_double() ) - 500.0; z = stdlib_complex128( re, im ); - stdlib_base_cpolar( z, &abs, &cphase); - if ( abs != abs ) { + stdlib_base_cpolar( z, &cabs, &cphase); + if ( cabs != cabs ) { printf( "should not return NaN\n" ); break; } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt index 4e32997f3a3..0c5e05af8c0 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt @@ -28,7 +28,7 @@ z: Complex128 Complex number. - out: Array + out: Array|TypedArray|Object Destination array. stride: integer @@ -39,7 +39,7 @@ Returns ------- - out: Array + out: Array|TypedArray|Object Absolute value and phase, respectively. Examples diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c index 816a8bd4116..aa90d5b781a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c @@ -30,14 +30,14 @@ int main( void ) { stdlib_complex128( 0.0/0.0, 0.0/0.0 ) }; - int i; + int i; double re; double im; - double abs; - double cphase; - for ( i = 0; i < 12; i++ ) { - stdlib_base_cpolar( x[i], &abs, &cphase ); + double cabs; + double cphase; + for ( i = 0; i < 12; i++ ) { + stdlib_base_cpolar( x[i], &cabs, &cphase ); stdlib_reim( x[i], &re, &im ); - printf( "cpolar(%lf + %lfi) => abs: %lf, cphase: %lf\n", re, im, abs, cphase ); - } + printf( "cpolar(%lf + %lfi) => cabs: %lf, cphase: %lf\n", re, im, cabs, cphase ); + } } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/include/stdlib/math/base/special/cpolar.h b/lib/node_modules/@stdlib/math/base/special/cpolar/include/stdlib/math/base/special/cpolar.h index d2a9158592e..d06ddf7db5d 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/include/stdlib/math/base/special/cpolar.h +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/include/stdlib/math/base/special/cpolar.h @@ -29,9 +29,9 @@ extern "C" { #endif /** -* Compute the absolute value and the phase of a double-precision complex floating-point number. +* Computes the absolute value and the phase of a double-precision complex floating-point number. */ -void stdlib_base_cpolar( const stdlib_complex128_t z, double *abs, double *cphase ); +void stdlib_base_cpolar( const stdlib_complex128_t z, double *cabs, double *cphase ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/assign.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/assign.js index 2576232d9f0..8fe7cfcd961 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/assign.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/assign.js @@ -20,8 +20,8 @@ // MODULES // -var cabs = require( '@stdlib/math/base/special/cabs' ); var cphase = require( '@stdlib/math/base/special/cphase' ); +var cabs = require( '@stdlib/math/base/special/cabs' ); // MAIN // @@ -29,7 +29,6 @@ var cphase = require( '@stdlib/math/base/special/cphase' ); /** * Computes the absolute value and the phase of a double-precision complex floating-point number. * -* @private * @param {Complex128} z - complex number * @param {Collection} out - output array * @param {integer} stride - output array stride diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js index 168e5b17fef..476ef533e5c 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js @@ -47,8 +47,8 @@ // MODULES // var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); var assign = require( './assign.js' ); +var main = require( './main.js' ); // MAIN // diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/main.js index 6c823036fc5..405c1525bea 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/main.js @@ -20,7 +20,7 @@ // MODULES // -var computeCpolar = require( './assign.js' ); +var assign = require( './assign.js' ); // MAIN // @@ -29,7 +29,7 @@ var computeCpolar = require( './assign.js' ); * Computes the absolute value and the phase of a double-precision complex floating-point number. * * @param {Complex128} z - complex number -* @returns {Array} absolute value and phase (in radians) +* @returns {Array} absolute value and phase (in radians) * * @example * var Complex128 = require( '@stdlib/complex/float64' ); @@ -38,7 +38,7 @@ var computeCpolar = require( './assign.js' ); * // returns [ ~5.83, ~0.5404 ] */ function cpolar( z ) { - return computeCpolar( z, [ 0.0, 0.0 ], 1, 0 ); + return assign( z, [ 0.0, 0.0 ], 1, 0 ); } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/native.js index b4441ea3865..7ece593c6d0 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/native.js @@ -31,11 +31,10 @@ var addon = require( './../src/addon.node' ); * * @private * @param {Complex128} z - complex number -* @returns {Array} absolute value and phase (in radians) +* @returns {Array} absolute value and phase (in radians) * * @example * var Complex128 = require( '@stdlib/complex/float64' ); -* var cpolar = require( '@stdlib/math/base/special/cpolar' ); * * var o = cpolar( new Complex128( 5.0, 3.0 ) ); * // returns [ ~5.83, ~0.5404 ] diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/manifest.json b/lib/node_modules/@stdlib/math/base/special/cpolar/manifest.json index 1f3ef375d36..1d9c396169a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/manifest.json +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/manifest.json @@ -78,4 +78,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/src/addon.c b/lib/node_modules/@stdlib/math/base/special/cpolar/src/addon.c index 4126c4d9997..eb8e7691dd6 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/src/addon.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/src/addon.c @@ -49,7 +49,7 @@ static napi_value addon( napi_env env, napi_callback_info info ) { return NULL; } - bool res; + bool res; status = napi_is_typedarray( env, argv[ 0 ], &res ); assert( status == napi_ok ); if ( res == false ) { @@ -58,8 +58,8 @@ static napi_value addon( napi_env env, napi_callback_info info ) { return NULL; } - // Get the first element out - napi_typedarray_type vtype0; + // Get the first element out + napi_typedarray_type vtype0; size_t len; void *Out; status = napi_get_typedarray_info( env, argv[ 0 ], &vtype0, &len, &Out, NULL, NULL ); @@ -75,8 +75,8 @@ static napi_value addon( napi_env env, napi_callback_info info ) { return NULL; } - // Get the real component - napi_value xre; + // Get the real component + napi_value xre; status = napi_get_named_property( env, argv[ 1 ], "re", &xre ); assert( status == napi_ok ); @@ -89,7 +89,7 @@ static napi_value addon( napi_env env, napi_callback_info info ) { return NULL; } - // Get the imaginary component + // Get the imaginary component napi_value xim; status = napi_get_named_property( env, argv[ 1 ], "im", &xim ); assert( status == napi_ok ); @@ -103,7 +103,7 @@ static napi_value addon( napi_env env, napi_callback_info info ) { return NULL; } - double re; + double re; status = napi_get_value_double( env, xre, &re ); assert( status == napi_ok ); @@ -111,15 +111,15 @@ static napi_value addon( napi_env env, napi_callback_info info ) { status = napi_get_value_double( env, xim, &im ); assert( status == napi_ok ); - double abs; + double cabs; double cphase; - stdlib_base_cpolar( stdlib_complex128( re, im ), &abs, &cphase ); + stdlib_base_cpolar( stdlib_complex128( re, im ), &cabs, &cphase ); - double *op = (double *)Out; - op[ 0 ] = abs; + double *op = (double *)Out; + op[ 0 ] = cabs; op[ 1 ] = cphase; - return NULL; + return NULL; } /** @@ -137,4 +137,4 @@ static napi_value init( napi_env env, napi_value exports ) { return fcn; } -NAPI_MODULE( NODE_GYP_MODULE_NAME, init ) \ No newline at end of file +NAPI_MODULE( NODE_GYP_MODULE_NAME, init ) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c index 954bd2ba6ed..2c77efbd3ef 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c @@ -35,13 +35,12 @@ * #include "stdlib/complex/imag.h" * * stdlib_complex128_t z = stdlib_complex128( 5.0, 3.0 ); -* double abs; +* double cabs; * double cphase; -* stdlib_base_cpolar( z, &abs, &cphase ); -* // out = [ ~5.83, ~0.5404 ] +* stdlib_base_cpolar( z, &cabs, &cphase ); */ -void stdlib_base_cpolar( const stdlib_complex128_t z, double *abs, double *cphase ) { - *abs = stdlib_base_cabs( z ); - *cphase = stdlib_base_cphase( z ); - return; +void stdlib_base_cpolar( const stdlib_complex128_t z, double *cabs, double *cphase ) { + *cabs = stdlib_base_cabs( z ); + *cphase = stdlib_base_cphase( z ); + return; } diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.assign.js b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.assign.js index 05b0800f211..719c5f5bb10 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.assign.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.assign.js @@ -45,8 +45,10 @@ tape( 'the function computes the absolute value and phase of a complex number', out = [ 0.0, 0.0 ]; v = cpolar( new Complex128( 5.0, 3.0 ), out, 1, 0 ); - expected = [ cabs( new Complex128( 5.0, 3.0 ) ), - cphase( new Complex128( 5.0, 3.0 ) ) ]; + expected = [ + cabs( new Complex128( 5.0, 3.0 ) ), + cphase( new Complex128( 5.0, 3.0 ) ) + ]; t.deepEqual( v, expected, 'returns expected value' ); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.main.js b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.main.js index 995696e34e2..59109240c75 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.main.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.main.js @@ -41,8 +41,10 @@ tape( 'the function computes the absolute value and phase of a complex number', var v; v = cpolar( new Complex128( 5.0, 3.0 ) ); - expected = [ cabs( new Complex128( 5.0, 3.0 ) ), - cphase( new Complex128( 5.0, 3.0 ) ) ]; + expected = [ + cabs( new Complex128( 5.0, 3.0 ) ), + cphase( new Complex128( 5.0, 3.0 ) ) + ]; t.deepEqual( v, expected, 'returns expected value' ); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.native.js index 060afd56621..f2ea8942e2a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.native.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/test/test.native.js @@ -50,7 +50,10 @@ tape( 'the function computes the absolute value and phase of a complex number', var v; v = cpolar( new Complex128( 5.0, 3.0 ) ); - expected = [ cabs( new Complex128( 5.0, 3.0 ) ), cphase( new Complex128( 5.0, 3.0 ) ) ]; + expected = [ + cabs( new Complex128( 5.0, 3.0 ) ), + cphase( new Complex128( 5.0, 3.0 ) ) + ]; t.deepEqual( v, expected, 'returns expected value' ); From 10f17e5627e130194683a3be5e2f2b87917108b7 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 25 Aug 2023 12:09:12 -0700 Subject: [PATCH 07/15] Apply suggestions from code review --- lib/node_modules/@stdlib/math/base/special/cpolar/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md index 429a8a5c457..4e1ca6d79ff 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md @@ -186,9 +186,9 @@ int main( void ) { }; double cphase; + double cabs; double re; double im; - double cabs; int i; for ( i = 0; i < 12; i++ ) { stdlib_base_cpolar( x[i], &cabs, &cphase ); From 7c1c3c77907e94663d338df2d4c2337ec542be02 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 25 Aug 2023 12:11:46 -0700 Subject: [PATCH 08/15] Apply suggestions from code review --- .../@stdlib/math/base/special/cpolar/benchmark/benchmark.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js index d340eeb7b3a..ce118f0b316 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/benchmark/benchmark.js @@ -70,7 +70,7 @@ bench( pkg+':assign', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { cpolar.assign( values[ i%values.length ], y, 1, 0 ); - if ( y.length === 0 ) { + if ( y[ 0 ] !== y[ 0 ] || y[ 1 ] !== y[ 1 ] ) { b.fail( 'should not be empty' ); } } From f25e8d96eaf11df0d0012bfa54619e79dba637e3 Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Fri, 25 Aug 2023 14:13:02 -0500 Subject: [PATCH 09/15] docs: fix readme --- lib/node_modules/@stdlib/math/base/special/cpolar/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md index 429a8a5c457..3e4f9fbbccf 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/README.md @@ -223,12 +223,12 @@ int main( void ) { +
+ [@stdlib/math/base/special/cabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cabs [@stdlib/math/base/special/cphase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cphase -
- From 89327a07b7f36013e86dea7962d9073699255392 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 25 Aug 2023 12:19:46 -0700 Subject: [PATCH 10/15] Apply suggestions from code review --- .../@stdlib/math/base/special/cpolar/docs/repl.txt | 2 +- .../@stdlib/math/base/special/cpolar/examples/c/example.c | 6 +++--- .../@stdlib/math/base/special/cpolar/lib/index.js | 2 +- .../@stdlib/math/base/special/cpolar/src/main.c | 1 - 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt index 0c5e05af8c0..174169eaa1c 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/repl.txt @@ -10,7 +10,7 @@ Returns ------- - out: Array + out: Array Absolute value and phase, respectively. Examples diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c index aa90d5b781a..45ae07b804f 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/examples/c/example.c @@ -30,11 +30,11 @@ int main( void ) { stdlib_complex128( 0.0/0.0, 0.0/0.0 ) }; - int i; + double cphase; + double cabs; double re; double im; - double cabs; - double cphase; + int i; for ( i = 0; i < 12; i++ ) { stdlib_base_cpolar( x[i], &cabs, &cphase ); stdlib_reim( x[i], &re, &im ); diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js index 476ef533e5c..58827be1f89 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/lib/index.js @@ -32,8 +32,8 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64' ); -* var cpolar = require( '@stdlib/math/base/special/cpolar' ); * var Float64Array = require( '@stdlib/array/float64' ); +* var cpolar = require( '@stdlib/math/base/special/cpolar' ); * * var out = new Float64Array( 2 ); * diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c index 2c77efbd3ef..92d0b4ee350 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c @@ -21,7 +21,6 @@ #include "stdlib/math/base/special/cabs.h" #include "stdlib/complex/float64.h" #include "stdlib/complex/reim.h" -#include /** * Computes the absolute value and the phase of a complex double-precision complex floating-point number. From cc65a98aa25abfe4705efd61580cc29985c0db9f Mon Sep 17 00:00:00 2001 From: Stephannie Jimenez Date: Fri, 25 Aug 2023 14:20:34 -0500 Subject: [PATCH 11/15] docs: fix docs in c --- lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c index 2c77efbd3ef..03b1502ef2b 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c @@ -27,6 +27,8 @@ * Computes the absolute value and the phase of a complex double-precision complex floating-point number. * * @param z input value +* @param cabs complex absolute value +* @param cphase complex phase value * @param out result * * @example From 01ab65a1b07866fa3cd84f33adbea8b7016e0748 Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 25 Aug 2023 12:22:09 -0700 Subject: [PATCH 12/15] Apply suggestions from code review --- lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c index 5e4b932cd8c..2c78a9b2fca 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c @@ -26,8 +26,8 @@ * Computes the absolute value and the phase of a complex double-precision complex floating-point number. * * @param z input value -* @param cabs complex absolute value -* @param cphase complex phase value +* @param cabs destination for absolute value +* @param cphase destination for phase value * @param out result * * @example From bd1cbe1182a7a9ca73aebd446163a17fcc9671cd Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 25 Aug 2023 12:22:19 -0700 Subject: [PATCH 13/15] Apply suggestions from code review --- lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c index 2c78a9b2fca..4a12cceb81e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/src/main.c @@ -28,7 +28,6 @@ * @param z input value * @param cabs destination for absolute value * @param cphase destination for phase value -* @param out result * * @example * #include "stdlib/complex/float64.h" From a1582180a12c7586a3d9808f52f4619ea374112a Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 25 Aug 2023 12:44:26 -0700 Subject: [PATCH 14/15] Apply suggestions from code review --- .../@stdlib/math/base/special/cpolar/docs/types/index.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts index 1fb38b48d22..6bbc5394621 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts @@ -20,7 +20,8 @@ /// -import { Complex128, Collection } from '@stdlib/types/object'; +import { Complex128 } from '@stdlib/types/object'; +import { Collection } from '@stdlib/types/array'; /** * Interface describing `cpolar`. From 422ec10e8b593d29cd45c74a8edf78e5a252268d Mon Sep 17 00:00:00 2001 From: Athan Date: Fri, 25 Aug 2023 12:59:52 -0700 Subject: [PATCH 15/15] Apply suggestions from code review --- .../@stdlib/math/base/special/cpolar/docs/types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts index 6bbc5394621..c22969ba018 100644 --- a/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cpolar/docs/types/index.d.ts @@ -20,7 +20,7 @@ /// -import { Complex128 } from '@stdlib/types/object'; +import { Complex128 } from '@stdlib/types/complex'; import { Collection } from '@stdlib/types/array'; /**