From 981d1938cc7caa803b67deb13a2e92bf545d7807 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:16:16 +0530 Subject: [PATCH 01/13] Add c-api documentation in readme.md --- .../@stdlib/math/base/special/round/README.md | 92 ++++++++++++++++++- 1 file changed, 91 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/round/README.md b/lib/node_modules/@stdlib/math/base/special/round/README.md index 0cc1505c2cf1..fdfa3724d414 100644 --- a/lib/node_modules/@stdlib/math/base/special/round/README.md +++ b/lib/node_modules/@stdlib/math/base/special/round/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2018 The Stdlib Authors. +Copyright (c) 2022 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. @@ -106,6 +106,96 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/round.h" +``` + +#### stdlib_base_round( x ) + +Rounds a `numeric` value to the nearest `integer`. + +```c +double out = stdlib_base_round( 3.14 ); +// returns 3.0 + +out = stdlib_base_round( -4.2 ); +// returns -4.0 +``` + +The function accepts the following arguments: + +- **x**: `[in] double` input value. + +```c +double stdlib_base_round(const double x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/round.h" +#include +#include + +int main() { + double x; + double v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( randu() * 100.0 ) - 50.0; + v = stdlib_base_round( x ); + printf( "Value: %lf. Rounded: %lf.\n", x, v ); + } +} +``` + +
+ + + +
+ + +
From e6d25609e5abc4131a9ba4afe478a69d05b5ce76 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:17:34 +0530 Subject: [PATCH 02/13] fix spacing in readme --- lib/node_modules/@stdlib/math/base/special/round/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/round/README.md b/lib/node_modules/@stdlib/math/base/special/round/README.md index fdfa3724d414..8f50650523b7 100644 --- a/lib/node_modules/@stdlib/math/base/special/round/README.md +++ b/lib/node_modules/@stdlib/math/base/special/round/README.md @@ -149,7 +149,7 @@ The function accepts the following arguments: - **x**: `[in] double` input value. ```c -double stdlib_base_round(const double x ); +double stdlib_base_round( const double x ); ```
From 285e42b37a28aae7865b283e59c7321e50bfb070 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:18:00 +0530 Subject: [PATCH 03/13] add include.gypi and binding.gyp --- .../math/base/special/round/binding.gyp | 170 ++++++++++++++++++ .../math/base/special/round/include.gypi | 53 ++++++ 2 files changed, 223 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/round/include.gypi diff --git a/lib/node_modules/@stdlib/math/base/special/round/binding.gyp b/lib/node_modules/@stdlib/math/base/special/round/binding.gyp new file mode 100644 index 000000000000..1058b57bab16 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2022 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/round/include.gypi b/lib/node_modules/@stdlib/math/base/special/round/include.gypi new file mode 100644 index 000000000000..3b437d524797 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2022 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': [ + ' Date: Tue, 20 Dec 2022 12:19:54 +0530 Subject: [PATCH 04/13] add round.h --- .../include/stdlib/math/base/special/round.h | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round/include/stdlib/math/base/special/round.h diff --git a/lib/node_modules/@stdlib/math/base/special/round/include/stdlib/math/base/special/round.h b/lib/node_modules/@stdlib/math/base/special/round/include/stdlib/math/base/special/round.h new file mode 100644 index 000000000000..708e5dfdc924 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/include/stdlib/math/base/special/round.h @@ -0,0 +1,38 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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. +*/ + +#ifndef STDLIB_MATH_BASE_SPECIAL_ROUND_H +#define STDLIB_MATH_BASE_SPECIAL_ROUND_H + +/* +* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** +* Rounds a numeric value to the nearest integer. +*/ +double stdlib_base_round( const double x ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_ROUND_H From 352a6ca0137c5cee9f5cce8c3944c7c3b982d3cb Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:22:01 +0530 Subject: [PATCH 05/13] Add Makefile, addon.c and main.c in src/ --- .../math/base/special/round/src/Makefile | 70 +++++++++++++++++++ .../math/base/special/round/src/addon.c | 23 ++++++ .../math/base/special/round/src/main.c | 35 ++++++++++ 3 files changed, 128 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/round/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/round/src/main.c diff --git a/lib/node_modules/@stdlib/math/base/special/round/src/Makefile b/lib/node_modules/@stdlib/math/base/special/round/src/Makefile new file mode 100644 index 000000000000..f79b87238713 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2022 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/lib/node_modules/@stdlib/math/base/special/round/src/addon.c b/lib/node_modules/@stdlib/math/base/special/round/src/addon.c new file mode 100644 index 000000000000..8e1063d6b7ad --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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/round.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_round ) diff --git a/lib/node_modules/@stdlib/math/base/special/round/src/main.c b/lib/node_modules/@stdlib/math/base/special/round/src/main.c new file mode 100644 index 000000000000..5c9bb2778eff --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/src/main.c @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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/round.h" +#include +#include + +/** +* Rounds a numeric value to the nearest integer. +* +* @param x input value +* @return output value +* +* @example +* double out = stdlib_base_round( 3.14 ); +* // returns 3.0 +*/ +double stdlib_base_round( const double x ) { + return round( x ); +} From 1b353231c0c03e6587d6432d49126cd106fa4ea8 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:22:57 +0530 Subject: [PATCH 06/13] add manifest.json --- .../math/base/special/round/manifest.json | 67 +++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round/manifest.json diff --git a/lib/node_modules/@stdlib/math/base/special/round/manifest.json b/lib/node_modules/@stdlib/math/base/special/round/manifest.json new file mode 100644 index 000000000000..d977998b7fc3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/manifest.json @@ -0,0 +1,67 @@ +{ + "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" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + } + ] +} \ No newline at end of file From a5bab63f9a9660d9830a3dd313a92f94a5e35ce0 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:24:15 +0530 Subject: [PATCH 07/13] add native.js in lib/ --- .../math/base/special/round/lib/native.js | 87 +++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round/lib/native.js diff --git a/lib/node_modules/@stdlib/math/base/special/round/lib/native.js b/lib/node_modules/@stdlib/math/base/special/round/lib/native.js new file mode 100644 index 000000000000..9f3a5eb291cc --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/lib/native.js @@ -0,0 +1,87 @@ + +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Rounds a numeric value to the nearest integer. +* +* @private +* @param {number} x - input value +* @returns {number} function value +* +* @example +* var v = round( -4.2 ); +* // returns -4.0 +* +* @example +* var v = round( -4.5 ); +* // returns -4.0 +* +* @example +* var v = round( -4.6 ); +* // returns -5.0 +* +* @example +* var v = round( 9.99999 ); +* // returns 10.0 +* +* @example +* var v = round( 9.5 ); +* // returns 10.0 +* +* @example +* var v = round( 9.2 ); +* // returns 9.0 +* +* @example +* var v = round( 0.0 ); +* // returns 0.0 +* +* @example +* var v = round( -0.0 ); +* // returns -0.0 +* +* @example +* var v = round( Infinity ); +* // returns Infinity +* +* @example +* var v = round( -Infinity ); +* // returns -Infinity +* +* @example +* var v = round( NaN ); +* // returns NaN +*/ +function round( x ) { + return addon( x ); +} + + +// EXPORTS // + +module.exports = round; From d3a838a0803fb814400b53b5ae9753ee40d73691 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:24:58 +0530 Subject: [PATCH 08/13] fix spacing issue in native.js --- lib/node_modules/@stdlib/math/base/special/round/lib/native.js | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/round/lib/native.js b/lib/node_modules/@stdlib/math/base/special/round/lib/native.js index 9f3a5eb291cc..edb52dbc8011 100644 --- a/lib/node_modules/@stdlib/math/base/special/round/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/round/lib/native.js @@ -1,4 +1,3 @@ - /** * @license Apache-2.0 * From ee5c307a6cc33f6a609b568938252407619feccd Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:27:15 +0530 Subject: [PATCH 09/13] Add c examples --- .../base/special/round/examples/c/Makefile | 146 ++++++++++++++++++ .../base/special/round/examples/c/example.c | 33 ++++ 2 files changed, 179 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/round/examples/c/example.c diff --git a/lib/node_modules/@stdlib/math/base/special/round/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/round/examples/c/Makefile new file mode 100644 index 000000000000..91d364d19fc3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2022 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/round/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/round/examples/c/example.c new file mode 100644 index 000000000000..0d54d9a9e3c6 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/examples/c/example.c @@ -0,0 +1,33 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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/round.h" +#include +#include + +int main() { + double x; + double v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( ( (double)rand() / (double)RAND_MAX ) * 100.0 ) - 50.0; + v = stdlib_base_round( x ); + printf( "Value: %lf. Rounded: %lf.\n", x, v ); + } +} \ No newline at end of file From da6d9d42cfdee9ba6eadc031d33b516cfe7d388a Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:27:34 +0530 Subject: [PATCH 10/13] sync c examples of readme and c --- lib/node_modules/@stdlib/math/base/special/round/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/round/README.md b/lib/node_modules/@stdlib/math/base/special/round/README.md index 8f50650523b7..33ce72aa34f0 100644 --- a/lib/node_modules/@stdlib/math/base/special/round/README.md +++ b/lib/node_modules/@stdlib/math/base/special/round/README.md @@ -181,7 +181,7 @@ int main() { int i; for ( i = 0; i < 100; i++ ) { - x = ( randu() * 100.0 ) - 50.0; + x = ( ( (double)rand() / (double)RAND_MAX ) * 100.0 ) - 50.0; v = stdlib_base_round( x ); printf( "Value: %lf. Rounded: %lf.\n", x, v ); } From b1fb4d8e0367475117bf5b2471d61bba5f953fd6 Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:30:30 +0530 Subject: [PATCH 11/13] add native c and js benchmarks --- .../round/benchmark/benchmark.native.js | 60 +++++++ .../special/round/benchmark/c/native/Makefile | 146 ++++++++++++++++++ .../round/benchmark/c/native/benchmark.c | 136 ++++++++++++++++ 3 files changed, 342 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/round/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/round/benchmark/c/native/benchmark.c diff --git a/lib/node_modules/@stdlib/math/base/special/round/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/round/benchmark/benchmark.native.js new file mode 100644 index 000000000000..da8f04cea544 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/benchmark/benchmark.native.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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 round = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( round 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()*1000.0 ) - 500.0; + y = round( 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/round/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/round/benchmark/c/native/Makefile new file mode 100644 index 000000000000..d6b58c7f5d3e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2022 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/round/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/round/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..742cba5ae4ca --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/benchmark/c/native/benchmark.c @@ -0,0 +1,136 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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 `round`. +*/ +#include "stdlib/math/base/special/round.h" +#include +#include +#include +#include +#include + +#define NAME "round" +#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 = ( 1000.0*rand_double() ) - 500.0; + y = stdlib_base_round( 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 ); +} From c53b540b9fb6c5aa5c1752bd35cc3f2a5aaa55cd Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:34:14 +0530 Subject: [PATCH 12/13] Add native tests --- .../base/special/round/test/test.native.js | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/round/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/round/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/round/test/test.native.js new file mode 100644 index 000000000000..04feb9034888 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/round/test/test.native.js @@ -0,0 +1,81 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2022 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 NINF = require( '@stdlib/constants/float64/ninf' ); +var PINF = require( '@stdlib/constants/float64/pinf' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var round = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( round instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof round, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function rounds a numeric value to the nearest integer', opts, function test( t ) { + t.strictEqual( round( -4.2 ), -4.0, 'equals -4' ); + t.strictEqual( round( -4.8 ), -5.0, 'equals -5' ); + t.strictEqual( round( 4.2 ), 4.0, 'equals 4' ); + t.strictEqual( round( 9.99999 ), 10.0, 'equals 10' ); + t.strictEqual( round( 9.5 ), 10.0, 'equals 10' ); + t.strictEqual( round( 9.4 ), 9.0, 'equals 10' ); + t.strictEqual( round( 0.0 ), 0.0, 'equals 0' ); + t.end(); +}); + +tape( 'the function returns `-0` if provided `-0`', opts, function test( t ) { + var v = round( -0.0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns -0' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided a `NaN`', opts, function test( t ) { + var v = round( NaN ); + t.strictEqual( isnan( v ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'the function returns `+infinity` if provided a `+infinity`', opts, function test( t ) { + var v = round( PINF ); + t.strictEqual( v, PINF, 'returns +infinity' ); + t.end(); +}); + +tape( 'the function returns `-infinity` if provided a `-infinity`', opts, function test( t ) { + var v = round( NINF ); + t.strictEqual( v, NINF, 'returns -infinity' ); + t.end(); +}); From 697cdf98c20dadda29dd3acf2d46a434b384adaf Mon Sep 17 00:00:00 2001 From: Pranavchiku Date: Tue, 20 Dec 2022 12:36:24 +0530 Subject: [PATCH 13/13] add endline in example.c and manifest.json --- .../@stdlib/math/base/special/round/examples/c/example.c | 2 +- lib/node_modules/@stdlib/math/base/special/round/manifest.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/round/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/round/examples/c/example.c index 0d54d9a9e3c6..6b595d6e0f05 100644 --- a/lib/node_modules/@stdlib/math/base/special/round/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/round/examples/c/example.c @@ -30,4 +30,4 @@ int main() { v = stdlib_base_round( x ); printf( "Value: %lf. Rounded: %lf.\n", x, v ); } -} \ No newline at end of file +} diff --git a/lib/node_modules/@stdlib/math/base/special/round/manifest.json b/lib/node_modules/@stdlib/math/base/special/round/manifest.json index d977998b7fc3..6bfc690068b2 100644 --- a/lib/node_modules/@stdlib/math/base/special/round/manifest.json +++ b/lib/node_modules/@stdlib/math/base/special/round/manifest.json @@ -64,4 +64,4 @@ "dependencies": [] } ] -} \ No newline at end of file +}