From f06adbb2516b48952f4e7c0b55ea454ad5c7f7c8 Mon Sep 17 00:00:00 2001 From: GUNJ JOSHI Date: Tue, 16 Jul 2024 20:30:39 +0530 Subject: [PATCH 1/2] feat: add C implementation for math/base/special/cospi --- .../@stdlib/math/base/special/cospi/README.md | 85 +++++++++ .../cospi/benchmark/benchmark.native.js | 60 +++++++ .../special/cospi/benchmark/c/native/Makefile | 146 +++++++++++++++ .../cospi/benchmark/c/native/benchmark.c | 136 ++++++++++++++ .../math/base/special/cospi/binding.gyp | 170 ++++++++++++++++++ .../base/special/cospi/examples/c/Makefile | 146 +++++++++++++++ .../base/special/cospi/examples/c/example.c | 31 ++++ .../math/base/special/cospi/include.gypi | 53 ++++++ .../include/stdlib/math/base/special/cospi.h | 41 +++++ .../math/base/special/cospi/lib/native.js | 58 ++++++ .../math/base/special/cospi/manifest.json | 102 +++++++++++ .../math/base/special/cospi/src/Makefile | 70 ++++++++ .../math/base/special/cospi/src/addon.c | 22 +++ .../math/base/special/cospi/src/main.c | 84 +++++++++ .../base/special/cospi/test/test.native.js | 137 ++++++++++++++ 15 files changed, 1341 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/include/stdlib/math/base/special/cospi.h create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/cospi/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/cospi/README.md b/lib/node_modules/@stdlib/math/base/special/cospi/README.md index 60e3aeb62f98..ee4799f30f52 100644 --- a/lib/node_modules/@stdlib/math/base/special/cospi/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cospi/README.md @@ -74,6 +74,91 @@ for ( i = 0; i < x.length; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/cospi.h" +``` + +#### stdlib_base_cospi( x ) + +Computes `cos(πx)` more accurately than `cos(pi*x)`, especially for large `x`. + +```c +double out = stdlib_base_cospi( 0.5 ); +// returns 0.0 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double stdlib_base_cospi( const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/cospi.h" +#include + +int main( void ) { + const double x[] = { 0.0, 0.523, 0.785, 1.047, 3.14 }; + + double y; + int i; + for ( i = 0; i < 5; i++ ) { + y = stdlib_base_cospi( x[ i ] ); + printf( "cospi(%lf) = %lf\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/math/base/special/cospi/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/cospi/benchmark/benchmark.native.js new file mode 100644 index 000000000000..dfcb65b76ceb --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cospi/benchmark/benchmark.native.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 randu = require( '@stdlib/random/base/randu' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var cospi = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cospi instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + x = ( randu() * 1.0e7 ) - 5.0e6; + y = cospi( x ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/cospi/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/cospi/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cospi/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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/cospi/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/cospi/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..c911a5d96e50 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cospi/benchmark/c/native/benchmark.c @@ -0,0 +1,136 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 `cospi`. +*/ +#include "stdlib/math/base/special/cospi.h" +#include +#include +#include +#include +#include + +#define NAME "cospi" +#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 x; + double y; + double t; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = ( 1.0e7 * rand_double() ) - 5.0e6; + y = stdlib_base_cospi( x ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + 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/cospi/binding.gyp b/lib/node_modules/@stdlib/math/base/special/cospi/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cospi/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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/cospi/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/cospi/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cospi/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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/cospi/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/cospi/examples/c/example.c new file mode 100644 index 000000000000..199752041836 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cospi/examples/c/example.c @@ -0,0 +1,31 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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/cospi.h" +#include + +int main( void ) { + const double x[] = { 0.0, 0.523, 0.785, 1.047, 3.14 }; + + double y; + int i; + for ( i = 0; i < 5; i++ ) { + y = stdlib_base_cospi( x[ i ] ); + printf( "cospi(%lf) = %lf\n", x[ i ], y ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/cospi/include.gypi b/lib/node_modules/@stdlib/math/base/special/cospi/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cospi/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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': [ + ' cos(-x) = cos(x) +* => sin(-x) = -sin(x) +* => cos(π/2) = 0 +* => cos(0) = 1 +* => cos(π) = -1 +*/ + +#include "stdlib/math/base/special/cospi.h" +#include "stdlib/math/base/assert/is_nan.h" +#include "stdlib/math/base/assert/is_infinite.h" +#include "stdlib/math/base/special/cos.h" +#include "stdlib/math/base/special/sin.h" +#include "stdlib/math/base/special/abs.h" +#include "stdlib/math/base/special/floor.h" +#include "stdlib/math/base/special/fmod.h" +#include "stdlib/constants/float64/pi.h" +#include "stdlib/constants/float64/max_safe_integer.h" + +static const double MAX_INTEGER_P1 = STDLIB_CONSTANT_FLOAT64_MAX_SAFE_INTEGER + 1; + +/** +* Computes the value of `cos(πx)`. +* +* @param x input value +* @return function value +* +* @example +* double y = stdlib_base_cospi( 0.5 ); +* // returns 0.0 +*/ +double stdlib_base_cospi( const double x ) { + double ax; + double ix; + double rx; + double y; + + if ( stdlib_base_is_nan( x ) || stdlib_base_is_infinite( x ) ) { + return 0.0 / 0.0; // NaN + } + ax = stdlib_base_abs( x ); + if ( ax > MAX_INTEGER_P1 ) { + // Always even integer... + return 1.0; + } + + // Argument reduction (reduce to [0,1))... + ix = stdlib_base_floor( ax ); + rx = ax - ix; + if ( rx == 0.5 ) { + return 0.0; + } + if ( rx < 0.25 ) { + y = stdlib_base_cos( STDLIB_CONSTANT_FLOAT64_PI * rx ); + } else if ( rx < 0.75 ) { + rx = 0.5 - rx; + y = stdlib_base_sin( STDLIB_CONSTANT_FLOAT64_PI * rx ); // Recall sin(-x) = -sin(x), thus returned result will be properly signed + } else { + rx = 1.0 - rx; + y = -stdlib_base_cos( STDLIB_CONSTANT_FLOAT64_PI*rx ); + } + + // If the integer of `x` is odd, we need to flip the sign... + return ( stdlib_base_fmod( ix, 2.0 ) == 1.0 ) ? -y : y; +} diff --git a/lib/node_modules/@stdlib/math/base/special/cospi/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/cospi/test/test.native.js new file mode 100644 index 000000000000..39ec3ce602cb --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/cospi/test/test.native.js @@ -0,0 +1,137 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 incrspace = require( '@stdlib/array/base/incrspace' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var EPS = require( '@stdlib/constants/float64/eps' ); +var abs = require( '@stdlib/math/base/special/abs' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var cospi = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( cospi instanceof Error ) +}; + + +// FIXTURES // + +var integers = require( './fixtures/julia/integers.json' ); +var decimals = require( './fixtures/julia/decimals.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof cospi, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided either positive or negative infinity', opts, function test( t ) { + var y; + + y = cospi( PINF ); + t.equal( isnan( y ), true, 'returns expected value when provided +infinity' ); + + y = cospi( NINF ); + t.equal( isnan( y ), true, 'returns expected value when provided -infinity' ); + + t.end(); +}); + +tape( 'if provided `NaN`, the function returns `NaN`', opts, function test( t ) { + var y = cospi( NaN ); + t.equal( isnan( y ), true, 'returns expected value when provided NaN' ); + t.end(); +}); + +tape( 'if provided an integer, the function returns `+-1.0`', opts, function test( t ) { + var expected; + var x; + var y; + var i; + + x = integers.x; + expected = integers.expected; + for ( i = 0; i < x.length; i++ ) { + y = cospi( x[i] ); + t.equal( y, expected[ i ], 'returns '+expected[i] ); + } + t.end(); +}); + +tape( 'if provided a value exceeding `2**53` (max (unsafe) float64 integer), the function always returns `+1.0`', opts, function test( t ) { + var x; + var y; + var i; + + x = pow( 2.0, 53 ) + 1.0; + for ( i = 0; i < 100; i++ ) { + y = cospi( x+i ); + t.equal( y, 1.0, 'returns 1.0' ); + } + t.end(); +}); + +tape( 'the function returns `0` for any value with fractional part equal to 1/2', opts, function test( t ) { + var x; + var y; + var i; + + x = incrspace( 0.5, 100.5, 1.0 ); + for ( i = 0; i < x.length; i++ ) { + y = cospi( x[i] ); + t.equal( y, 0.0, 'x: '+x[i]+'. E: 0' ); + } + t.end(); +}); + +tape( 'the function computes `cos(πx)`', opts, function test( t ) { + var expected; + var delta; + var tol; + var x; + var y; + var i; + + x = decimals.x; + expected = decimals.expected; + for ( i = 0; i < x.length; i++ ) { + y = cospi( x[i] ); + if ( y === expected[ i ] ) { + t.equal( y, expected[ i ], 'x: '+x[i]+'. E: '+expected[i] ); + } else { + delta = abs( y - expected[i] ); + tol = 1.0 * EPS * abs( expected[i] ); + t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+expected[i]+'. tol: '+tol+'. Δ: '+delta+'.' ); + } + } + t.end(); +}); From 84be7d27ec7ebae634f2fd829d76e26f1a36aa2a Mon Sep 17 00:00:00 2001 From: GUNJ JOSHI Date: Wed, 17 Jul 2024 08:58:13 +0530 Subject: [PATCH 2/2] docs: update notes section --- .../@stdlib/math/base/special/cospi/lib/main.js | 17 +++++++---------- .../@stdlib/math/base/special/cospi/src/main.c | 16 +++++++--------- 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cospi/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cospi/lib/main.js index 10a6e8ea3dc5..cff1a979fd81 100644 --- a/lib/node_modules/@stdlib/math/base/special/cospi/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cospi/lib/main.js @@ -18,16 +18,6 @@ 'use strict'; -/* -* Notes: -* => cos(-x) = cos(x) -* => sin(-x) = -sin(x) -* => cos(π/2) = 0 -* => cos(0) = 1 -* => cos(π) = -1 -*/ - - // MODULES // var isnan = require( '@stdlib/math/base/assert/is-nan' ); @@ -50,6 +40,13 @@ var MAX_INTEGER_P1 = MAX_INTEGER + 1; /** * Computes the value of `cos(πx)`. * +* ## Notes +* +* - `sin(-x) = -sin(x)` +* - `sin(+n) = +0`, where `n` is a positive integer +* - `sin(-n) = -sin(+n) = -0`, where `n` is a positive integer +* - `cos(-x) = cos(x)` +* * @param {number} x - input value * @returns {number} function value * diff --git a/lib/node_modules/@stdlib/math/base/special/cospi/src/main.c b/lib/node_modules/@stdlib/math/base/special/cospi/src/main.c index 11427a85eac0..7ab756aefbc1 100644 --- a/lib/node_modules/@stdlib/math/base/special/cospi/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/cospi/src/main.c @@ -16,15 +16,6 @@ * limitations under the License. */ -/* -* Notes: -* => cos(-x) = cos(x) -* => sin(-x) = -sin(x) -* => cos(π/2) = 0 -* => cos(0) = 1 -* => cos(π) = -1 -*/ - #include "stdlib/math/base/special/cospi.h" #include "stdlib/math/base/assert/is_nan.h" #include "stdlib/math/base/assert/is_infinite.h" @@ -41,6 +32,13 @@ static const double MAX_INTEGER_P1 = STDLIB_CONSTANT_FLOAT64_MAX_SAFE_INTEGER + /** * Computes the value of `cos(πx)`. * +* ## Notes +* +* - `sin(-x) = -sin(x)` +* - `sin(+n) = +0`, where `n` is a positive integer +* - `sin(-n) = -sin(+n) = -0`, where `n` is a positive integer +* - `cos(-x) = cos(x)` +* * @param x input value * @return function value *