From 9958b9b67e115807012f78dbe9f388de4dc5ef05 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 5 Dec 2025 20:11:25 +0530 Subject: [PATCH 1/4] feat: add C implementation for @stdlib/math/base/special/asechf --- .../math/base/special/asechf/README.md | 203 ++++++++++++++++++ .../special/asechf/benchmark/benchmark.js | 51 +++++ .../asechf/benchmark/benchmark.native.js | 60 ++++++ .../asechf/benchmark/c/native/Makefile | 146 +++++++++++++ .../asechf/benchmark/c/native/benchmark.c | 133 ++++++++++++ .../math/base/special/asechf/binding.gyp | 170 +++++++++++++++ .../math/base/special/asechf/docs/repl.txt | 30 +++ .../base/special/asechf/docs/types/index.d.ts | 44 ++++ .../base/special/asechf/docs/types/test.ts | 44 ++++ .../base/special/asechf/examples/c/example.c | 31 +++ .../base/special/asechf/examples/index.js | 29 +++ .../math/base/special/asechf/include.gypi | 53 +++++ .../include/stdlib/math/base/special/asechf.h | 38 ++++ .../math/base/special/asechf/lib/index.js | 46 ++++ .../math/base/special/asechf/lib/main.js | 60 ++++++ .../math/base/special/asechf/lib/native.js | 54 +++++ .../math/base/special/asechf/manifest.json | 72 +++++++ .../math/base/special/asechf/package.json | 149 +++++++++++++ .../math/base/special/asechf/src/addon.c | 22 ++ .../math/base/special/asechf/src/main.c | 34 +++ .../math/base/special/asechf/test/test.js | 76 +++++++ .../base/special/asechf/test/test.native.js | 85 ++++++++ 22 files changed, 1630 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/README.md create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/examples/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/include/stdlib/math/base/special/asechf.h create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/lib/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/lib/main.js create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/package.json create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/test/test.js create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/README.md b/lib/node_modules/@stdlib/math/base/special/asechf/README.md new file mode 100644 index 000000000000..a961c4c85d51 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/README.md @@ -0,0 +1,203 @@ + + +# asechf + +> Compute the [hyperbolic arcsecant][hyperbolic-arcsecant] of a single-precision floating-point number. + +
+ +## Usage + +```javascript +var asechf = require( '@stdlib/math/base/special/asechf' ); +``` + +#### asechf( x ) + +Computes the [hyperbolic arcsecant][hyperbolic-arcsecant] of a single-precision floating-point number. + +```javascript +var v = asechf( 1.0 ); +// returns 0.0 + +v = asechf( 0.5 ); +// returns ~1.317 + +v = asechf( 0.0 ); +// returns Infinity +``` + +The domain of `x` is restricted to the interval `[0, 1]`. For `x` outside of this interval, the function returns `NaN`. + +```javascript +var v = asechf( -1.0 ); +// returns NaN + +v = asechf( 2.0 ); +// returns NaN +``` + +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var asechf = require( '@stdlib/math/base/special/asechf' ); + +var x = uniform( 100, 0.1, 1.0, { + 'dtype': 'float32' +}); + +logEachMap( 'asechf(%0.4f) = %0.4f', x, asechf ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/asechf.h" +``` + +#### stdlib_base_asechf( x ) + +Computes the [hyperbolic arcsecant][hyperbolic-arcsecant] of a single-precision floating-point number. + +```c +float out = stdlib_base_asechf( 0.5f ); +// returns ~1.317f +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. + +```c +float stdlib_base_asechf( const float x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/asechf.h" +#include + +int main( void ) { + const float x[] = { 0.1f, 0.2f, 0.3f, 0.4f, 0.5f, 0.6f, 0.7f, 0.8f, 0.9f, 1.0f }; + + float v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_asechf( x[ i ] ); + printf( "asechf(%f) = %f\n", x[ i ], v ); + } +} +``` + +
+ + + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/benchmark.js new file mode 100644 index 000000000000..e8e33d833a9d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/benchmark.js @@ -0,0 +1,51 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 bench = require( '@stdlib/bench' ); +var randu = require( '@stdlib/random/base/randu' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pkg = require( './../package.json' ).name; +var asechf = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + x = randu(); + y = asechf( x ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..4a9d898657d1 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/benchmark.native.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var asechf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( asechf 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(); + y = asechf( x ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/c/native/Makefile new file mode 100644 index 000000000000..416c37215fde --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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) $(LIBRARIES) -lm + +#/ +# 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/asechf/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..89f53b0e58ea --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/benchmark/c/native/benchmark.c @@ -0,0 +1,133 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/asechf.h" +#include +#include +#include +#include +#include + +#define NAME "asechf" +#define ITERATIONS 1000000 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static 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 +*/ +static 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 +*/ +static double tic( void ) { + 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 +*/ +static float rand_float( void ) { + int r = rand(); + return (float)r / ( (float)RAND_MAX + 1.0f ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double t; + float x; + float y; + int i; + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + x = rand_float(); + y = stdlib_base_asechf( 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/asechf/binding.gyp b/lib/node_modules/@stdlib/math/base/special/asechf/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/asechf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/asechf/docs/repl.txt new file mode 100644 index 000000000000..252916822d3c --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/docs/repl.txt @@ -0,0 +1,30 @@ + +{{alias}}( x ) + Computes the hyperbolic arcsecant of a single-precision floating-point + number. + + The domain of `x` is restricted to `[0, 1]`. For `x` outside of this + interval, the function returns `NaN`. + + Parameters + ---------- + x: number + Input value. + + Returns + ------- + y: number + Hyperbolic arcsecant. + + Examples + -------- + > var y = {{alias}}( 1.0 ) + 0.0 + > y = {{alias}}( 0.5 ) + ~1.317 + > y = {{alias}}( NaN ) + NaN + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/asechf/docs/types/index.d.ts new file mode 100644 index 000000000000..ba8a6e6f3082 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/docs/types/index.d.ts @@ -0,0 +1,44 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +// TypeScript Version: 4.1 + +/** +* Computes the hyperbolic arcsecant of a single-precision floating-point number. +* +* @param x - input value +* @returns hyperbolic arcsecant +* +* @example +* var v = asechf( 1.0 ); +* // returns 0.0 +* +* @example +* var v = asechf( 0.5 ); +* // returns ~1.317 +* +* @example +* var v = asechf( NaN ); +* // returns NaN +*/ +declare function asechf( x: number ): number; + + +// EXPORTS // + +export = asechf; diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/asechf/docs/types/test.ts new file mode 100644 index 000000000000..ec4f2ae156aa --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/docs/types/test.ts @@ -0,0 +1,44 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +import asechf = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + asechf( 0.5 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a value other than a number... +{ + asechf( true ); // $ExpectError + asechf( false ); // $ExpectError + asechf( null ); // $ExpectError + asechf( undefined ); // $ExpectError + asechf( '5' ); // $ExpectError + asechf( [] ); // $ExpectError + asechf( {} ); // $ExpectError + asechf( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + asechf(); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/asechf/examples/c/example.c new file mode 100644 index 000000000000..0d8b625345bd --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/examples/c/example.c @@ -0,0 +1,31 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/asechf.h" +#include + +int main( void ) { + const float x[] = { 0.1f, 0.2f, 0.3f, 0.4f, 0.5f, 0.6f, 0.7f, 0.8f, 0.9f, 1.0f }; + + float v; + int i; + for ( i = 0; i < 10; i++ ) { + v = stdlib_base_asechf( x[ i ] ); + printf( "asechf(%f) = %f\n", x[ i ], v ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/asechf/examples/index.js new file mode 100644 index 000000000000..8cd0d79f35c8 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/examples/index.js @@ -0,0 +1,29 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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'; + +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var asechf = require( './../lib' ); + +var x = uniform( 100, 0.1, 1.0, { + 'dtype': 'float32' +}); + +logEachMap( 'asechf(%0.4f) = %0.4f', x, asechf ); diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/include.gypi b/lib/node_modules/@stdlib/math/base/special/asechf/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 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': [ + '=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "asechf", + "inverse", + "hyperbolic", + "arc", + "arcsecant", + "secant", + "acosh", + "cosh", + "hyperbolic secant", + "area", + "area hyperbolic secant" + ], + "__stdlib__": { + "scaffold": { + "$schema": "math/base@v1.0", + "base_alias": "asech", + "alias": "asechf", + "pkg_desc": "compute the hyperbolic arcsecant of a single-precision floating-point number", + "desc": "computes the hyperbolic arcsecant of a single-precision floating-point number", + "short_desc": "hyperbolic arcsecant", + "parameters": [ + { + "name": "x", + "desc": "input value", + "type": { + "javascript": "number", + "jsdoc": "number", + "c": "float", + "dtype": "float32" + }, + "domain": [ + { + "min": 0, + "max": 1 + } + ], + "rand": { + "prng": "random/base/uniform", + "parameters": [ + 0.1, + 1 + ] + }, + "example_values": [ + 0.5, + 0.75, + 0.1, + 0.9, + 0.25, + 0.33, + 0.66, + 0.8, + 0.42, + 0.12, + 0.99, + 0.05, + 0.55, + 0.7, + 0.22, + 0.88, + 0.15, + 0.6, + 0.35, + 0.95 + ] + } + ], + "output_policy": "real_floating_point_and_generic", + "returns": { + "desc": "hyperbolic arcsecant", + "type": { + "javascript": "number", + "jsdoc": "number", + "c": "float", + "dtype": "float32" + } + }, + "keywords": [ + "asechf", + "inverse", + "hyperbolic", + "secant", + "arcsecant", + "acosh" + ], + "extra_keywords": [ + "math.acosh" + ] + } + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/src/addon.c b/lib/node_modules/@stdlib/math/base/special/asechf/src/addon.c new file mode 100644 index 000000000000..58c83d498803 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/src/addon.c @@ -0,0 +1,22 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/asechf.h" +#include "stdlib/math/base/napi/unary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_F_F( stdlib_base_asechf ) diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/src/main.c b/lib/node_modules/@stdlib/math/base/special/asechf/src/main.c new file mode 100644 index 000000000000..40637f9cac78 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/src/main.c @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/asechf.h" +#include "stdlib/math/base/special/acosh.h" + +/** +* Computes the hyperbolic arcsecant of a single-precision floating-point number. +* +* @param x input value +* @return output value +* +* @example +* float out = stdlib_base_asechf( 1.0f ); +* // returns 0.0f +*/ +float stdlib_base_asechf( const float x ) { + return (float)stdlib_base_acosh( (double)( 1.0f / x ) ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/test/test.js b/lib/node_modules/@stdlib/math/base/special/asechf/test/test.js new file mode 100644 index 000000000000..c09baab4a293 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/test/test.js @@ -0,0 +1,76 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var asechf = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof asechf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function computes the hyperbolic arcsecant of 1', function test( t ) { + var v = asechf( 1.0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function computes the hyperbolic arcsecant of 0.5', function test( t ) { + var v = asechf( 0.5 ); + var expected = float64ToFloat32( 1.3169578969248166 ); + var delta = absf( v - expected ); + var tol = 10.0 * EPS; + t.ok( delta <= tol, 'within tolerance. v: ' + v + '. expected: ' + expected + '. Δ: ' + delta + '. tol: ' + tol + '.' ); + t.end(); +}); + +tape( 'the function returns `Infinity` for `x = 0`', function test( t ) { + var v = asechf( 0.0 ); + t.strictEqual( v, Infinity, 'returns Infinity' ); + t.end(); +}); + +tape( 'the function returns `NaN` for negative values', function test( t ) { + var v = asechf( -1.0 ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'the function returns `NaN` for values greater than 1', function test( t ) { + var v = asechf( 2.0 ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN`', function test( t ) { + var v = asechf( NaN ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/asechf/test/test.native.js new file mode 100644 index 000000000000..19a6ae0f02fc --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/test/test.native.js @@ -0,0 +1,85 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var EPS = require( '@stdlib/constants/float32/eps' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var asechf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( asechf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof asechf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function computes the hyperbolic arcsecant of 1', opts, function test( t ) { + var v = asechf( 1.0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function computes the hyperbolic arcsecant of 0.5', opts, function test( t ) { + var v = asechf( 0.5 ); + var expected = float64ToFloat32( 1.3169578969248166 ); + var delta = absf( v - expected ); + var tol = 10.0 * EPS; + t.ok( delta <= tol, 'within tolerance. v: ' + v + '. expected: ' + expected + '. Δ: ' + delta + '. tol: ' + tol + '.' ); + t.end(); +}); + +tape( 'the function returns `Infinity` for `x = 0`', opts, function test( t ) { + var v = asechf( 0.0 ); + t.strictEqual( v, Infinity, 'returns Infinity' ); + t.end(); +}); + +tape( 'the function returns `NaN` for negative values', opts, function test( t ) { + var v = asechf( -1.0 ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'the function returns `NaN` for values greater than 1', opts, function test( t ) { + var v = asechf( 2.0 ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'the function returns `NaN` if provided `NaN`', opts, function test( t ) { + var v = asechf( NaN ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); From 1793bfde836b541ae386b7b3f5dc0b446cef2ac5 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 5 Dec 2025 20:45:01 +0530 Subject: [PATCH 2/4] fix: add missing Makefile for C examples --- .../base/special/asechf/examples/c/Makefile | 146 ++++++++++++++++++ 1 file changed, 146 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/asechf/examples/c/Makefile diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/asechf/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/asechf/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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 From d464fa18cbf6dab179aed3897685b5d70f575e0c Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 5 Dec 2025 20:55:46 +0530 Subject: [PATCH 3/4] fix: reorder variable declarations by length in test file --- .../@stdlib/math/base/special/asechf/test/test.js | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/test/test.js b/lib/node_modules/@stdlib/math/base/special/asechf/test/test.js index c09baab4a293..7a3011b88275 100644 --- a/lib/node_modules/@stdlib/math/base/special/asechf/test/test.js +++ b/lib/node_modules/@stdlib/math/base/special/asechf/test/test.js @@ -43,10 +43,14 @@ tape( 'the function computes the hyperbolic arcsecant of 1', function test( t ) }); tape( 'the function computes the hyperbolic arcsecant of 0.5', function test( t ) { - var v = asechf( 0.5 ); var expected = float64ToFloat32( 1.3169578969248166 ); - var delta = absf( v - expected ); - var tol = 10.0 * EPS; + var delta; + var tol; + var v; + + v = asechf( 0.5 ); + delta = absf( v - expected ); + tol = 10.0 * EPS; t.ok( delta <= tol, 'within tolerance. v: ' + v + '. expected: ' + expected + '. Δ: ' + delta + '. tol: ' + tol + '.' ); t.end(); }); From 46bf7bb16f64d0c5cf3ffa7789704b5bfd205022 Mon Sep 17 00:00:00 2001 From: Aman Singh Date: Fri, 5 Dec 2025 21:02:56 +0530 Subject: [PATCH 4/4] fix: reorder variable declarations in native test file --- .../math/base/special/asechf/test/test.native.js | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/asechf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/asechf/test/test.native.js index 19a6ae0f02fc..9d5879db9440 100644 --- a/lib/node_modules/@stdlib/math/base/special/asechf/test/test.native.js +++ b/lib/node_modules/@stdlib/math/base/special/asechf/test/test.native.js @@ -52,10 +52,14 @@ tape( 'the function computes the hyperbolic arcsecant of 1', opts, function test }); tape( 'the function computes the hyperbolic arcsecant of 0.5', opts, function test( t ) { - var v = asechf( 0.5 ); var expected = float64ToFloat32( 1.3169578969248166 ); - var delta = absf( v - expected ); - var tol = 10.0 * EPS; + var delta; + var tol; + var v; + + v = asechf( 0.5 ); + delta = absf( v - expected ); + tol = 10.0 * EPS; t.ok( delta <= tol, 'within tolerance. v: ' + v + '. expected: ' + expected + '. Δ: ' + delta + '. tol: ' + tol + '.' ); t.end(); });