diff --git a/LICENSE b/LICENSE index 0273186f2..9f357146a 100644 --- a/LICENSE +++ b/LICENSE @@ -181,6 +181,28 @@ The library links against the following external libraries or contains implementations from the following external libraries, which have their own licenses: +* Cephes + +Copyright (c) 1984-2000 Stephen L. Moshier + +Some software in this archive may be from the book _Methods and Programs for +Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) +or from the Cephes Mathematical Library, a commercial product. In either event, +it is copyrighted by the author. What you see here may be used freely but it +comes with no support or guarantee. + +Stephen L. Moshier +moshier@na-net.ornl.gov + +* FreeBSD + +Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved. + +Developed at SunPro, a Sun Microsystems, Inc. business. +Permission to use, copy, modify, and distribute this +software is freely granted, provided that this notice +is preserved. + * Boost Boost Software License - Version 1.0 - August 17th, 2003 @@ -207,27 +229,9 @@ FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* FreeBSD - -Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved. - -Developed at SunPro, a Sun Microsystems, Inc. business. -Permission to use, copy, modify, and distribute this -software is freely granted, provided that this notice -is preserved. - -* Cephes - -Copyright (c) 1984-2000 Stephen L. Moshier - -Some software in this archive may be from the book _Methods and Programs for -Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) -or from the Cephes Mathematical Library, a commercial product. In either event, -it is copyrighted by the author. What you see here may be used freely but it -comes with no support or guarantee. +* SLATEC Common Mathematical Library -Stephen L. Moshier -moshier@na-net.ornl.gov +Public domain. * FDLIBM @@ -260,6 +264,40 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +* Faddeeva + +Copyright (c) 2012 Massachusetts Institute of Technology + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * Go Copyright (c) 2009 The Go Authors. All rights reserved. @@ -290,33 +328,3 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -* SLATEC Common Mathematical Library - -Public domain. - -* Faddeeva - -Copyright (c) 2012 Massachusetts Institute of Technology - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - diff --git a/base/special/cround/README.md b/base/special/cround/README.md index 66766a1ab..5ec9d15f3 100644 --- a/base/special/cround/README.md +++ b/base/special/cround/README.md @@ -18,9 +18,9 @@ limitations under the License. --> -# Round +# cround -> Round a complex number to the nearest integer. +> Round each component of a double-precision complex floating-point number to the nearest integer.
@@ -30,36 +30,50 @@ limitations under the License. var cround = require( '@stdlib/math/base/special/cround' ); ``` -#### cround( \[out,] re, im ) +#### cround( z ) -Rounds a `complex` number comprised of a **real** component `re` and an **imaginary** component `im` to the nearest integer. +Rounds each component of a double-precision complex floating-point number to the nearest integer. ```javascript -var v = cround( -4.2, 5.5 ); -// returns [ -4.0, 6.0 ] +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); -v = cround( 9.99999, 0.1 ); -// returns [ 10.0, 0.0 ] +var v = cround( new Complex128( -4.2, 5.5 ) ); +// returns -v = cround( 0.0, 0.0 ); -// returns [ 0.0, 0.0 ] +var re = real( v ); +// returns -4.0 -v = cround( NaN, NaN ); -// returns [ NaN, NaN ] -``` +var im = imag( v ); +// returns 6.0 -By default, the function returns real and imaginary components as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object. +v = cround( new Complex128( 9.99999, 0.1 ) ); +// returns -```javascript -var Float64Array = require( '@stdlib/array/float64' ); +re = real( v ); +// returns 10.0 + +im = imag( v ); +// returns 0.0 + +v = cround( new Complex128( 0.0, 0.0 ) ); +// returns + +re = real( v ); +// returns 0.0 -var out = new Float64Array( 2 ); +im = imag( v ); +// returns 0.0 -var v = cround( out, -4.2, 5.5 ); -// returns [ -4.0, 6.0 ] +v = cround( new Complex128( NaN, NaN ) ); +// returns -var bool = ( v === out ); -// returns true +re = real( v ); +// returns NaN + +im = imag( v ); +// returns NaN ```
@@ -73,26 +87,17 @@ var bool = ( v === out ); ```javascript +var uniform = require( '@stdlib/random/base/uniform' ).factory; var Complex128 = require( '@stdlib/complex/float64' ); -var randu = require( '@stdlib/random/base/randu' ); -var real = require( '@stdlib/complex/real' ); -var imag = require( '@stdlib/complex/imag' ); var cround = require( '@stdlib/math/base/special/cround' ); -var re; -var im; +var rand = uniform( -50.0, 50.0 ); + var z; -var o; -var w; var i; - for ( i = 0; i < 100; i++ ) { - re = ( randu()*100.0 ) - 50.0; - im = ( randu()*100.0 ) - 50.0; - z = new Complex128( re, im ); - o = cround( real(z), imag(z) ); - w = new Complex128( o[ 0 ], o[ 1 ] ); - console.log( 'round(%s) = %s', z.toString(), w.toString() ); + z = new Complex128( rand(), rand() ); + console.log( 'cround(%s) = %s', z, cround( z ) ); } ``` @@ -100,6 +105,117 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/cround.h" +``` + +#### stdlib_base_cround( z ) + +Rounds each component of a double-precision complex floating-point number to the nearest integer. + +```c +#include "stdlib/complex/float64.h" +#include "stdlib/complex/real.h" +#include "stdlib/complex/imag.h" + +stdlib_complex128_t z = stdlib_complex128( -4.2, 5.5 ); + +stdlib_complex128_t out = stdlib_base_cround( z ); + +double re = stdlib_real( out ); +// returns -4.0 + +double im = stdlib_imag( out ); +// returns 6.0 +``` + +The function accepts the following arguments: + +- **z**: `[in] stdlib_complex128_t` input value. + +```c +stdlib_complex128_t stdlib_base_cround( const stdlib_complex128_t z ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/cround.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.5 ), + stdlib_complex128( -3.14, -1.5 ), + stdlib_complex128( 0.0, 0.0 ), + stdlib_complex128( 0.0/0.0, 0.0/0.0 ) + }; + + stdlib_complex128_t v; + stdlib_complex128_t y; + double re1; + double im1; + double re2; + double im2; + int i; + for ( i = 0; i < 4; i++ ) { + v = x[ i ]; + y = stdlib_base_cround( v ); + stdlib_reim( v, &re1, &im1 ); + stdlib_reim( y, &re2, &im2 ); + printf( "cround(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 ); + } +} +``` + +
+ + + +
+ + +
diff --git a/base/special/cround/benchmark/benchmark.js b/base/special/cround/benchmark/benchmark.js index d90d993d6..d0c784e33 100644 --- a/base/special/cround/benchmark/benchmark.js +++ b/base/special/cround/benchmark/benchmark.js @@ -21,9 +21,11 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); -var isArray = require( '@stdlib/assert/is-array' ); -var round = require( './../../../../base/special/round' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var isnan = require( './../../../../base/assert/is-nan' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); var pkg = require( './../package.json' ).name; var cround = require( './../lib' ); @@ -31,98 +33,25 @@ var cround = require( './../lib' ); // MAIN // bench( pkg, function benchmark( b ) { - var re; - var im; + var values; var y; var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - re = ( randu()*1000.0 ) - 500.0; - im = ( randu()*1000.0 ) - 500.0; - y = cround( re, im ); - if ( y.length === 0 ) { - b.fail( 'should not be empty' ); - } - } - b.toc(); - if ( !isArray( y ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse', function benchmark( b ) { - var out; - var re; - var im; - var y; - var i; - - out = new Array( 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - re = ( randu()*1000.0 ) - 500.0; - im = ( randu()*1000.0 ) - 500.0; - y = cround( 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(); -}); - -bench( pkg+'::manual', function benchmark( b ) { - var re; - var im; - var y; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - re = ( randu()*1000.0 ) - 500.0; - im = ( randu()*1000.0 ) - 500.0; - y = [ round( re ), round( im ) ]; - if ( y.length === 0 ) { - b.fail( 'should not be empty' ); - } - } - b.toc(); - if ( !isArray( y ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::manual,memory_reuse', function benchmark( b ) { - var re; - var im; - var y; - var i; - - y = new Array( 2 ); + 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[ 0 ] = round( re ); - y[ 1 ] = round( im ); - if ( y.length === 0 ) { - b.fail( 'should not be empty' ); + y = cround( values[ i%values.length ] ); + if ( isnan( real( y ) ) ) { + b.fail( 'should not return NaN' ); } } b.toc(); - if ( !isArray( y ) ) { - b.fail( 'should return an array' ); + if ( isnan( imag( y ) ) ) { + b.fail( 'should not return not NaN' ); } b.pass( 'benchmark finished' ); b.end(); diff --git a/base/special/cround/benchmark/benchmark.native.js b/base/special/cround/benchmark/benchmark.native.js new file mode 100644 index 000000000..42b412380 --- /dev/null +++ b/base/special/cround/benchmark/benchmark.native.js @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var isnan = require( './../../../../base/assert/is-nan' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var cround = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cround 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 = cround( values[ i%values.length ] ); + if ( isnan( real( y ) ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( real( y ) ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/base/special/cround/benchmark/c/native/Makefile b/base/special/cround/benchmark/c/native/Makefile new file mode 100644 index 000000000..7f6bbc4c2 --- /dev/null +++ b/base/special/cround/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2021 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/base/special/cround/benchmark/c/native/benchmark.c b/base/special/cround/benchmark/c/native/benchmark.c new file mode 100644 index 000000000..bce5e185f --- /dev/null +++ b/base/special/cround/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 `cround`. +*/ +#include "stdlib/math/base/special/cround.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include +#include +#include +#include +#include + +#define NAME "cround" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +void print_version() { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +void print_results( double elapsed ) { + double rate = (double)ITERATIONS / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", ITERATIONS ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +double tic() { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1]. +* +* @return random number +*/ +double rand_double() { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +double benchmark() { + double elapsed; + double re; + double im; + double t; + double v; + int i; + + stdlib_complex128_t x; + stdlib_complex128_t y; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + v = ( 1000.0*rand_double() ) - 500.0; + x = stdlib_complex128( v, v ); + y = stdlib_base_cround( x ); + stdlib_reim( y, &re, &im ); + if ( re != re ) { + printf( "unexpected result\n" ); + break; + } + } + elapsed = tic() - t; + if ( im != im ) { + printf( "unexpected result\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/base/special/cround/binding.gyp b/base/special/cround/binding.gyp new file mode 100644 index 000000000..f2b466aef --- /dev/null +++ b/base/special/cround/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2023 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/base/special/cround/docs/repl.txt b/base/special/cround/docs/repl.txt index cb5624941..19e18d6d7 100644 --- a/base/special/cround/docs/repl.txt +++ b/base/special/cround/docs/repl.txt @@ -1,34 +1,26 @@ -{{alias}}( [out,] re, im ) - Rounds a complex number to the nearest integer. +{{alias}}( z ) + Rounds each component of a double-precision complex floating-point number + to the nearest integer. 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 - Rounded components. + out: Complex128 + Rounded complex number. Examples -------- - > var out = {{alias}}( 5.5, 3.3 ) - [ 6.0, 3.0 ] - - // Provide an output array: - > out = new {{alias:@stdlib/array/float64}}( 2 ); - > var v = {{alias}}( out, 5.5, 3.3 ) - [ 6.0, 3.0 ] - > var bool = ( v === out ) - true + > var v = {{alias}}( new {{alias:@stdlib/complex/float64}}( 5.5, 3.3 ) ) + + > var re = {{alias:@stdlib/complex/real}}( v ) + 6.0 + > var im = {{alias:@stdlib/complex/imag}}( v ) + 3.0 See Also -------- diff --git a/base/special/cround/docs/types/index.d.ts b/base/special/cround/docs/types/index.d.ts index 50d35de80..f78b0d1da 100644 --- a/base/special/cround/docs/types/index.d.ts +++ b/base/special/cround/docs/types/index.d.ts @@ -20,41 +20,29 @@ /// -import { ArrayLike } from '@stdlib/types/array'; +import { Complex128 } from '@stdlib/types/object'; /** -* Rounds a complex number to the nearest integer. +* Rounds each component of a double-precision complex floating-point number to the nearest integer. * -* @param out - output array -* @param re - real component -* @param im - imaginary component -* @returns real and imaginary components +* @param z - input value +* @returns result * * @example -* var Float32Array = require( `@stdlib/array/float32` ); +* var Complex128 = require( `@stdlib/complex/float64` ); +* var real = require( `@stdlib/complex/real` ); +* var imag = require( `@stdlib/complex/imag` ); * -* var out = new Float32Array( 2 ); +* var v = cceil( new Complex128( -4.2, 5.5 ) ); +* // returns * -* var v = cround( out, -4.2, 5.5 ); -* // returns [ -4.0, 6.0 ] +* var re = real( v ); +* // returns -4.0 * -* var bool = ( v === out ); -* // returns true +* var im = imag( v ); +* // returns 6.0 */ -declare function cround( out: ArrayLike, re: number, im: number ): ArrayLike; // tslint-disable-line max-line-length - -/** -* Rounds a complex number to the nearest integer. -* -* @param re - real component -* @param im - imaginary component -* @returns real and imaginary components -* -* @example -* var out = cround( 5.5, 3.3 ); -* // returns [ 6.0, 3.0 ] -*/ -declare function cround( re: number, im: number ): ArrayLike; +declare function cround( z: Complex128 ): Complex128; // EXPORTS // diff --git a/base/special/cround/docs/types/test.ts b/base/special/cround/docs/types/test.ts index a0d207d96..8fca91534 100644 --- a/base/special/cround/docs/types/test.ts +++ b/base/special/cround/docs/types/test.ts @@ -16,53 +16,30 @@ * limitations under the License. */ +import Complex128 = require( '@stdlib/complex/float64' ); import cround = require( './index' ); // TESTS // -// The function returns an array of numbers... +// The function returns a double-precision complex floating-point number... { - cround( 5, 3 ); // $ExpectType ArrayLike - cround( [], 5, 3 ); // $ExpectType ArrayLike + cround( new Complex128( 1.0, 2.0 ) ); // $ExpectType Complex128 } // The compiler throws an error if the function is provided a real component which is not a number... { - cround( true, 3 ); // $ExpectError - cround( false, 3 ); // $ExpectError - cround( null, 3 ); // $ExpectError - cround( undefined, 3 ); // $ExpectError - cround( '5', 3 ); // $ExpectError - cround( [], 3 ); // $ExpectError - cround( {}, 3 ); // $ExpectError - cround( ( x: number ): number => x, 3 ); // $ExpectError -} - -// The compiler throws an error if the function is provided an imaginary component which is not a number... -{ - cround( 5, true ); // $ExpectError - cround( 5, false ); // $ExpectError - cround( 5, null ); // $ExpectError - cround( 5, undefined ); // $ExpectError - cround( 5, '5' ); // $ExpectError - cround( 5, [] ); // $ExpectError - cround( 5, {} ); // $ExpectError - cround( 5, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an output array which is not array-like... -{ - cround( true, 5, 3 ); // $ExpectError - cround( false, 5, 3 ); // $ExpectError - cround( 'abc', 5, 3 ); // $ExpectError - cround( {}, 5, 3 ); // $ExpectError - cround( ( x: number ): number => x, 5, 3 ); // $ExpectError - cround( 123, 5, 3 ); // $ExpectError + cround( true ); // $ExpectError + cround( false ); // $ExpectError + cround( null ); // $ExpectError + cround( undefined ); // $ExpectError + cround( '5' ); // $ExpectError + cround( [] ); // $ExpectError + cround( {} ); // $ExpectError + cround( ( x: number ): number => x ); // $ExpectError } // The compiler throws an error if the function is provided insufficient arguments... { cround(); // $ExpectError - cround( 2 ); // $ExpectError } diff --git a/base/special/cround/examples/c/Makefile b/base/special/cround/examples/c/Makefile new file mode 100644 index 000000000..70c91f4e1 --- /dev/null +++ b/base/special/cround/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2021 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/base/special/cround/examples/c/example.c b/base/special/cround/examples/c/example.c new file mode 100644 index 000000000..3e3aee1dd --- /dev/null +++ b/base/special/cround/examples/c/example.c @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/cround.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.5 ), + stdlib_complex128( -3.14, -1.5 ), + stdlib_complex128( 0.0, 0.0 ), + stdlib_complex128( 0.0/0.0, 0.0/0.0 ) + }; + + stdlib_complex128_t v; + stdlib_complex128_t y; + double re1; + double im1; + double re2; + double im2; + int i; + for ( i = 0; i < 4; i++ ) { + v = x[ i ]; + y = stdlib_base_cround( v ); + stdlib_reim( v, &re1, &im1 ); + stdlib_reim( y, &re2, &im2 ); + printf( "cround(%lf + %lfi) = %lf + %lfi\n", re1, im1, re2, im2 ); + } +} diff --git a/base/special/cround/examples/index.js b/base/special/cround/examples/index.js index 461e7df16..dfbf798cc 100644 --- a/base/special/cround/examples/index.js +++ b/base/special/cround/examples/index.js @@ -18,24 +18,15 @@ 'use strict'; +var uniform = require( '@stdlib/random/base/uniform' ).factory; var Complex128 = require( '@stdlib/complex/float64' ); -var randu = require( '@stdlib/random/base/randu' ); -var real = require( '@stdlib/complex/real' ); -var imag = require( '@stdlib/complex/imag' ); var cround = require( './../lib' ); -var re; -var im; +var rand = uniform( -50.0, 50.0 ); + var z; -var o; -var w; var i; - for ( i = 0; i < 100; i++ ) { - re = ( randu()*100.0 ) - 50.0; - im = ( randu()*100.0 ) - 50.0; - z = new Complex128( re, im ); - o = cround( real(z), imag(z) ); - w = new Complex128( o[ 0 ], o[ 1 ] ); - console.log( 'round(%s) = %s', z.toString(), w.toString() ); + z = new Complex128( rand(), rand() ); + console.log( 'cround(%s) = %s', z, cround( z ) ); } diff --git a/base/special/cround/include.gypi b/base/special/cround/include.gypi new file mode 100644 index 000000000..78db9faf8 --- /dev/null +++ b/base/special/cround/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': [ + ' * -* v = cround( 9.99999, 0.1 ); -* // returns [ 10.0, 0.0 ] +* var re = real( v ); +* // returns -5.0 * -* v = cround( 0.0, 0.0 ); -* // returns [ 0.0, 0.0 ] +* var im = imag( v ); +* // returns 6.0 * -* v = cround( NaN, NaN ); -* // returns [ NaN, NaN ] +* v = cround( new Complex128( 9.99999, 0.1 ) ); +* // returns * -* @example -* var cround = require( '@stdlib/math/base/special/cround' ); +* re = real( v ); +* // returns 10.0 +* +* im = imag( v ); +* // returns 0.0 +* +* v = cround( new Complex128( 0.0, 0.0 ) ); +* // returns +* +* re = real( v ); +* // returns 0.0 +* +* im = imag( v ); +* // returns 0.0 * -* var out = new Array( 2 ); +* v = cround( new Complex128( NaN, NaN ) ); +* // returns * -* var v = cround( out, -4.2, 5.5 ); -* // returns [ -5.0, 6.0 ] +* re = real( v ); +* // returns NaN * -* var bool = ( v === out ); -* // returns true +* im = imag( v ); +* // returns NaN */ // MODULES // diff --git a/base/special/cround/lib/main.js b/base/special/cround/lib/main.js index 0c2edc144..5f304179d 100644 --- a/base/special/cround/lib/main.js +++ b/base/special/cround/lib/main.js @@ -20,49 +20,63 @@ // MODULES // -var round = require( './cround.js' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var round = require( './../../../../base/special/round' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); // MAIN // /** -* Rounds a complex number to the nearest integer. +* Rounds each component of a double-precision complex floating-point number to the nearest integer. * -* @param {(Array|TypedArray|Object)} [out] - output array -* @param {number} re - real component -* @param {number} im - imaginary component -* @returns {(Array|TypedArray|Object)} rounded components +* @param {Complex128} z - complex number +* @returns {Complex128} rounded complex number * * @example -* var v = cround( -4.2, 5.5 ); -* // returns [ -4.0, 6.0 ] +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); * -* @example -* var out = new Array( 2 ); +* var v = cround( new Complex128( -4.2, 5.5 ) ); +* // returns * -* var v = cround( out, -4.2, 5.5 ); -* // returns [ -4.0, 6.0 ] +* var re = real( v ); +* // returns -4 * -* var bool = ( v === out ); -* // returns true +* var im = imag( v ); +* // returns 6.0 * -* @example -* var v = cround( 9.99999, 0.1 ); -* // returns [ 10.0, 0.0 ] +* v = cround( new Complex128( 9.99999, 0.1 ) ); +* // returns * -* @example -* var v = cround( 0.0, 0.0 ); -* // returns [ 0.0, 0.0 ] +* re = real( v ); +* // returns 10.0 * -* @example -* var v = cround( NaN, NaN ); -* // returns [ NaN, NaN ] +* im = imag( v ); +* // returns 0.0 +* +* v = cround( new Complex128( 0.0, 0.0 ) ); +* // returns +* +* re = real( v ); +* // returns 0.0 +* +* im = imag( v ); +* // returns 0.0 +* +* v = cround( new Complex128( NaN, NaN ) ); +* // returns +* +* re = real( v ); +* // returns NaN +* +* im = imag( v ); +* // returns NaN */ -function cround( out, re, im ) { - if ( arguments.length === 2 ) { - return round( [ 0.0, 0.0 ], out, re ); - } - return round( out, re, im ); +function cround( z ) { + return new Complex128( round( real( z ) ), round( imag( z ) ) ); } diff --git a/base/special/cround/lib/native.js b/base/special/cround/lib/native.js new file mode 100644 index 000000000..3145cc919 --- /dev/null +++ b/base/special/cround/lib/native.js @@ -0,0 +1,58 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var Complex128 = require( '@stdlib/complex/float64' ); +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Rounds each component of a double-precision complex floating-point number to the nearest integer. +* +* @private +* @param {Complex128} z - complex number +* @returns {Complex128} result +* +* @example +* var Complex128 = require( '@stdlib/complex/float64' ); +* var real = require( '@stdlib/complex/real' ); +* var imag = require( '@stdlib/complex/imag' ); +* +* var v = cround( new Complex128( -4.2, 5.5 ) ); +* // returns +* +* var re = real( v ); +* // returns -4 +* +* var im = imag( v ); +* // returns 6.0 +*/ +function cround( z ) { + var v = addon( z ); + return new Complex128( v.re, v.im ); +} + + +// EXPORTS // + +module.exports = cround; diff --git a/base/special/cround/manifest.json b/base/special/cround/manifest.json new file mode 100644 index 000000000..fa3b792b4 --- /dev/null +++ b/base/special/cround/manifest.json @@ -0,0 +1,76 @@ +{ + "options": { + "task": "build" + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "task": "build", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/unary", + "@stdlib/complex/float64", + "@stdlib/complex/reim" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float64", + "@stdlib/complex/reim" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/complex/float64", + "@stdlib/complex/reim" + ] + } + ] +} + diff --git a/base/special/cround/package.json b/base/special/cround/package.json index 781562a19..97b1db083 100644 --- a/base/special/cround/package.json +++ b/base/special/cround/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/math/base/special/cround", "version": "0.0.0", - "description": "Round a complex number to the nearest integer.", + "description": "Round each component of a double-precision complex floating-point number to the nearest integer.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -14,6 +14,7 @@ } ], "main": "./lib", + "gypfile": true, "directories": { "benchmark": "./benchmark", "doc": "./docs", diff --git a/base/special/cround/src/Makefile b/base/special/cround/src/Makefile new file mode 100644 index 000000000..904c7dc4b --- /dev/null +++ b/base/special/cround/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2023 The Stdlib Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/base/special/cround/src/addon.c b/base/special/cround/src/addon.c new file mode 100644 index 000000000..274a22f4b --- /dev/null +++ b/base/special/cround/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/math/base/special/cround.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_Z_Z( stdlib_base_cround ) diff --git a/base/special/cround/src/main.c b/base/special/cround/src/main.c new file mode 100644 index 000000000..35b986b82 --- /dev/null +++ b/base/special/cround/src/main.c @@ -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. +*/ + +#include "stdlib/math/base/special/cround.h" +#include "stdlib/complex/float64.h" +#include "stdlib/complex/reim.h" +#include + +/** +* Rounds each component of a double-precision complex floating-point number to the nearest integer. +* +* @param z input value +* @return result +* +* @example +* #include "stdlib/complex/float64.h" +* #include "stdlib/complex/real.h" +* #include "stdlib/complex/imag.h" +* +* stdlib_complex128_t z = stdlib_complex128( -4.2, 5.5 ); +* +* stdlib_complex128_t out = stdlib_base_cround( z ); +* +* double re = stdlib_real( out ); +* // returns -5.0 +* +* double im = stdlib_imag( out ); +* // returns 6.0 +*/ +stdlib_complex128_t stdlib_base_cround( const stdlib_complex128_t z ) { + double re; + double im; + + stdlib_reim( z, &re, &im ); + + re = round( re ); // TODO: replace with stdlib function once available + im = round( im ); // TODO: replace with stdlib function once available + return stdlib_complex128( re, im ); +} diff --git a/base/special/cround/test/test.js b/base/special/cround/test/test.js index b13499332..46731d43e 100644 --- a/base/special/cround/test/test.js +++ b/base/special/cround/test/test.js @@ -26,7 +26,9 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); var isnan = require( './../../../../base/assert/is-nan' ); var isNegativeZero = require( './../../../../base/assert/is-negative-zero' ); var isPositiveZero = require( './../../../../base/assert/is-positive-zero' ); -var Float64Array = require( '@stdlib/array/float64' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); var cround = require( './../lib' ); @@ -39,106 +41,64 @@ tape( 'main export is a function', function test( t ) { }); tape( 'the function rounds real and imaginary components to the nearest integer', function test( t ) { - var expected; - var actual; + var v; - actual = cround( -4.2, 5.5 ); - expected = [ -4.0, 6.0 ]; - t.deepEqual( actual, expected, 'returns expected value' ); + v = cround( new Complex128( -4.2, 5.5 ) ); + t.strictEqual( real( v ), -4.0, 'returns expected value' ); + t.strictEqual( imag( v ), 6.0, 'returns expected value' ); - actual = cround( 9.99999, 0.1 ); - expected = [ 10.0, 0.0 ]; - t.deepEqual( actual, expected, 'returns expected value' ); + v = cround( new Complex128( 9.99999, 0.1 ) ); + t.strictEqual( real( v ), 10.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); - actual = cround( 0.0, 0.0 ); - expected = [ 0.0, 0.0 ]; - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function rounds real and imaginary components to the nearest integer (output array)', function test( t ) { - var expected; - var actual; - var out; - - out = new Array( 2 ); - actual = cround( out, -4.2, 5.5 ); - - expected = [ -4.0, 6.0 ]; - - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( actual, out, 'returns output value' ); - - t.end(); -}); - -tape( 'the function rounds real and imaginary components to the nearest integer (output typed array)', function test( t ) { - var expected; - var actual; - var out; - - out = new Float64Array( 2 ); - actual = cround( out, 9.99999, 0.1 ); - - expected = new Float64Array( [ 10.0, 0.0 ] ); - - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( actual, out, 'returns output value' ); - - t.end(); -}); - -tape( 'the function rounds real and imaginary components to the nearest integer (output object)', function test( t ) { - var expected; - var actual; - var out; - - out = {}; - actual = cround( out, 0.0, 0.0 ); - - expected = { - '0': 0.0, - '1': 0.0 - }; - - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( actual, out, 'returns output value' ); + v = cround( new Complex128( 0.0, 0.0 ) ); + t.strictEqual( real( v ), 0.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); t.end(); }); tape( 'the function returns a `NaN` if provided a `NaN`', function test( t ) { - var val = cround( NaN, NaN ); - t.strictEqual( isnan( val[ 0 ] ), true, 'returns expected value' ); - t.strictEqual( isnan( val[ 1 ] ), true, 'returns expected value' ); + var v; + + v = cround( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns expected value' ); t.end(); }); tape( 'the function returns `-0` if provided `-0`', function test( t ) { - var val = cround( -0.0, -0.0 ); - t.strictEqual( isNegativeZero( val[ 0 ] ), true, 'returns expected value' ); - t.strictEqual( isNegativeZero( val[ 1 ] ), true, 'returns expected value' ); + var v; + + v = cround( new Complex128( -0.0, -0.0 ) ); + t.strictEqual( isNegativeZero( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns expected value' ); t.end(); }); tape( 'the function returns `+0` if provided `+0`', function test( t ) { - var val = cround( +0.0, +0.0 ); - t.strictEqual( isPositiveZero( val[ 0 ] ), true, 'returns expected value' ); - t.strictEqual( isPositiveZero( val[ 1 ] ), true, 'returns expected value' ); + var v; + + v = cround( new Complex128( +0.0, +0.0 ) ); + t.strictEqual( isPositiveZero( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns expected value' ); t.end(); }); tape( 'the function returns `+infinity` if provided `+infinity`', function test( t ) { - var val = cround( PINF, PINF ); - t.strictEqual( val[ 0 ], PINF, 'returns expected value' ); - t.strictEqual( val[ 1 ], PINF, 'returns expected value' ); + var v; + + v = cround( new Complex128( PINF, PINF ) ); + t.strictEqual( real( v ), PINF, 'returns expected value' ); + t.strictEqual( imag( v ), PINF, 'returns expected value' ); t.end(); }); tape( 'the function returns `-infinity` if provided `-infinity`', function test( t ) { - var val = cround( NINF, NINF ); - t.strictEqual( val[ 0 ], NINF, 'returns expected value' ); - t.strictEqual( val[ 1 ], NINF, 'returns expected value' ); + var v; + + v = cround( new Complex128( NINF, NINF ) ); + t.strictEqual( real( v ), NINF, 'returns expected value' ); + t.strictEqual( imag( v ), NINF, 'returns expected value' ); t.end(); }); diff --git a/base/special/cround/test/test.native.js b/base/special/cround/test/test.native.js new file mode 100644 index 000000000..8ab942dd9 --- /dev/null +++ b/base/special/cround/test/test.native.js @@ -0,0 +1,113 @@ +/** +* @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 PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var isnan = require( './../../../../base/assert/is-nan' ); +var isNegativeZero = require( './../../../../base/assert/is-negative-zero' ); +var isPositiveZero = require( './../../../../base/assert/is-positive-zero' ); +var Complex128 = require( '@stdlib/complex/float64' ); +var real = require( '@stdlib/complex/real' ); +var imag = require( '@stdlib/complex/imag' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var cround = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cround instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cround, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds real and imaginary components to the nearest integer', opts, function test( t ) { + var v; + + v = cround( new Complex128( -4.2, 5.5 ) ); + t.strictEqual( real( v ), -4.0, 'returns expected value' ); + t.strictEqual( imag( v ), 6.0, 'returns expected value' ); + + v = cround( new Complex128( 9.99999, 0.1 ) ); + t.strictEqual( real( v ), 10.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); + + v = cround( new Complex128( 0.0, 0.0 ) ); + t.strictEqual( real( v ), 0.0, 'returns expected value' ); + t.strictEqual( imag( v ), 0.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a `NaN` if provided a `NaN`', opts, function test( t ) { + var v; + + v = cround( new Complex128( NaN, NaN ) ); + t.strictEqual( isnan( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isnan( imag( v ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', opts, function test( t ) { + var v; + + v = cround( new Complex128( -0.0, -0.0 ) ); + t.strictEqual( isNegativeZero( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isNegativeZero( imag( v ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+0` if provided `+0`', opts, function test( t ) { + var v; + + v = cround( new Complex128( +0.0, +0.0 ) ); + t.strictEqual( isPositiveZero( real( v ) ), true, 'returns expected value' ); + t.strictEqual( isPositiveZero( imag( v ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `+infinity` if provided `+infinity`', opts, function test( t ) { + var v; + + v = cround( new Complex128( PINF, PINF ) ); + t.strictEqual( real( v ), PINF, 'returns expected value' ); + t.strictEqual( imag( v ), PINF, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided `-infinity`', opts, function test( t ) { + var v; + + v = cround( new Complex128( NINF, NINF ) ); + t.strictEqual( real( v ), NINF, 'returns expected value' ); + t.strictEqual( imag( v ), NINF, 'returns expected value' ); + t.end(); +});