From 0ae49fba6e79599a4b8b1be464a7570a3c7f6d83 Mon Sep 17 00:00:00 2001 From: Gunj Joshi Date: Mon, 12 Aug 2024 06:01:34 +0530 Subject: [PATCH] feat!: fix function name and update docs BREAKING CHANGE: update C API name This commit changes the name of the C API from `stdlib_base_j1` to `stdlib_base_besselj1`. This ensures that the C function name more closely matches the global namespace name and helps protect against future naming collisions. To migrate, users should update their call signatures accordingly. PR-URL: https://github.com/stdlib-js/stdlib/pull/2777 Ref: https://github.com/stdlib-js/stdlib/commit/18bd1b5ace1a7dbd9d26bb66c1a1f0aa91573416#r145258015 Ref: https://github.com/stdlib-js/stdlib/commit/18bd1b5ace1a7dbd9d26bb66c1a1f0aa91573416#r145258035 Reviewed-by: Athan Reines --- .../@stdlib/math/base/special/besselj1/README.md | 16 ++++++++-------- .../besselj1/benchmark/c/native/benchmark.c | 4 ++-- .../base/special/besselj1/examples/c/example.c | 6 +++--- .../math/base/special/{j1.h => besselj1.h} | 8 ++++---- .../math/base/special/besselj1/lib/main.js | 2 +- .../math/base/special/besselj1/src/addon.c | 4 ++-- .../math/base/special/besselj1/src/main.c | 8 ++++---- 7 files changed, 24 insertions(+), 24 deletions(-) rename lib/node_modules/@stdlib/math/base/special/besselj1/include/stdlib/math/base/special/{j1.h => besselj1.h} (83%) diff --git a/lib/node_modules/@stdlib/math/base/special/besselj1/README.md b/lib/node_modules/@stdlib/math/base/special/besselj1/README.md index ec1dbf5daf8..0fd7401bdbe 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj1/README.md +++ b/lib/node_modules/@stdlib/math/base/special/besselj1/README.md @@ -122,18 +122,18 @@ for ( i = 0; i < 100; i++ ) { ### Usage ```c -#include "stdlib/math/base/special/j1.h" +#include "stdlib/math/base/special/besselj1.h" ``` -#### stdlib_base_j1( x ) +#### stdlib_base_besselj1( x ) Computes the [Bessel function of the first kind][bessel-first-kind] of order one at `x`. ```c -double out = stdlib_base_j1( 0.0 ); +double out = stdlib_base_besselj1( 0.0 ); // returns 0.0 -out = stdlib_base_j1( 1.0 ); +out = stdlib_base_besselj1( 1.0 ); // returns ~0.440 ``` @@ -142,7 +142,7 @@ The function accepts the following arguments: - **x**: `[in] double` input value. ```c -double stdlib_base_j1( const double x ); +double stdlib_base_besselj1( const double x ); ``` @@ -164,7 +164,7 @@ double stdlib_base_j1( const double x ); ### Examples ```c -#include "stdlib/math/base/special/j1.h" +#include "stdlib/math/base/special/besselj1.h" #include int main( void ) { @@ -173,8 +173,8 @@ int main( void ) { int i; for ( i = 0; i < 7; i++ ) { - v = stdlib_base_j1( x[ i ] ); - printf( "j1(%lf) = %lf\n", x[ i ], v ); + v = stdlib_base_besselj1( x[ i ] ); + printf( "besselj1(%lf) = %lf\n", x[ i ], v ); } } ``` diff --git a/lib/node_modules/@stdlib/math/base/special/besselj1/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/besselj1/benchmark/c/native/benchmark.c index 71ab511ec96..32dbd0f894e 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj1/benchmark/c/native/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/besselj1/benchmark/c/native/benchmark.c @@ -16,7 +16,7 @@ * limitations under the License. */ -#include "stdlib/math/base/special/j1.h" +#include "stdlib/math/base/special/besselj1.h" #include #include #include @@ -99,7 +99,7 @@ static double benchmark( void ) { t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { x = ( 100000.0 * rand_double() ) - 0.0; - y = stdlib_base_j1( x ); + y = stdlib_base_besselj1( x ); if ( y != y ) { printf( "should not return NaN\n" ); break; diff --git a/lib/node_modules/@stdlib/math/base/special/besselj1/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/besselj1/examples/c/example.c index a395a8bf22f..63368d03274 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj1/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/besselj1/examples/c/example.c @@ -16,7 +16,7 @@ * limitations under the License. */ -#include "stdlib/math/base/special/j1.h" +#include "stdlib/math/base/special/besselj1.h" #include int main( void ) { @@ -25,7 +25,7 @@ int main( void ) { int i; for ( i = 0; i < 7; i++ ) { - v = stdlib_base_j1( x[ i ] ); - printf( "j1(%lf) = %lf\n", x[ i ], v ); + v = stdlib_base_besselj1( x[ i ] ); + printf( "besselj1(%lf) = %lf\n", x[ i ], v ); } } diff --git a/lib/node_modules/@stdlib/math/base/special/besselj1/include/stdlib/math/base/special/j1.h b/lib/node_modules/@stdlib/math/base/special/besselj1/include/stdlib/math/base/special/besselj1.h similarity index 83% rename from lib/node_modules/@stdlib/math/base/special/besselj1/include/stdlib/math/base/special/j1.h rename to lib/node_modules/@stdlib/math/base/special/besselj1/include/stdlib/math/base/special/besselj1.h index 2cf7e053c7e..5f7c5cf27e3 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj1/include/stdlib/math/base/special/j1.h +++ b/lib/node_modules/@stdlib/math/base/special/besselj1/include/stdlib/math/base/special/besselj1.h @@ -16,8 +16,8 @@ * limitations under the License. */ -#ifndef STDLIB_MATH_BASE_SPECIAL_J1_H -#define STDLIB_MATH_BASE_SPECIAL_J1_H +#ifndef STDLIB_MATH_BASE_SPECIAL_BESSELJ1_H +#define STDLIB_MATH_BASE_SPECIAL_BESSELJ1_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. @@ -29,10 +29,10 @@ extern "C" { /** * Computes the Bessel function of the first kind of order one. */ -double stdlib_base_j1( const double x ); +double stdlib_base_besselj1( const double x ); #ifdef __cplusplus } #endif -#endif // !STDLIB_MATH_BASE_SPECIAL_J1_H +#endif // !STDLIB_MATH_BASE_SPECIAL_BESSELJ1_H diff --git a/lib/node_modules/@stdlib/math/base/special/besselj1/lib/main.js b/lib/node_modules/@stdlib/math/base/special/besselj1/lib/main.js index e9cdbc2ce1d..be2d960b602 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj1/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/besselj1/lib/main.js @@ -18,7 +18,7 @@ * * ## Notice * -* The original C++ code and copyright notice are from the [Boost library]{@link https://github.com/boostorg/math/blob/develop/include/boost/math/special_functions/detail/bessel_j1.hpp}. The implementation has been modified for JavaScript. +* The original C++ code and copyright notice are from the [Boost library]{@link https://www.boost.org/doc/libs/1_85_0/boost/math/special_functions/detail/bessel_j1.hpp}. The implementation has been modified for JavaScript. * * ```text * Copyright Xiaogang Zhang, 2006. diff --git a/lib/node_modules/@stdlib/math/base/special/besselj1/src/addon.c b/lib/node_modules/@stdlib/math/base/special/besselj1/src/addon.c index 7e1cba9bcc3..450f63034bd 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj1/src/addon.c +++ b/lib/node_modules/@stdlib/math/base/special/besselj1/src/addon.c @@ -16,8 +16,8 @@ * limitations under the License. */ -#include "stdlib/math/base/special/j1.h" +#include "stdlib/math/base/special/besselj1.h" #include "stdlib/math/base/napi/unary.h" // cppcheck-suppress shadowFunction -STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_j1 ) +STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_besselj1 ) diff --git a/lib/node_modules/@stdlib/math/base/special/besselj1/src/main.c b/lib/node_modules/@stdlib/math/base/special/besselj1/src/main.c index d0838902173..d58893677a2 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj1/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/besselj1/src/main.c @@ -18,7 +18,7 @@ * * ## Notice * -* The original C++ code and copyright notice are from the [Boost library]{@link https://github.com/boostorg/math/blob/develop/include/boost/math/special_functions/detail/bessel_j1.hpp}. The implementation has been modified for use in stdlib. +* The original C++ code and copyright notice are from the [Boost library]{@link https://www.boost.org/doc/libs/1_85_0/boost/math/special_functions/detail/bessel_j1.hpp}. The implementation has been modified for use in stdlib. * * ```text * Copyright Xiaogang Zhang, 2006. @@ -29,7 +29,7 @@ * ``` */ -#include "stdlib/math/base/special/j1.h" +#include "stdlib/math/base/special/besselj1.h" #include "stdlib/math/base/special/sqrt.h" #include "stdlib/math/base/special/abs.h" #include "stdlib/math/base/special/sincos.h" @@ -222,10 +222,10 @@ static double rational_psqs( const double x ) { * @return evaluated Bessel function * * @example -* double out = stdlib_base_j1( 1.0 ); +* double out = stdlib_base_besselj1( 1.0 ); * // returns ~0.440 */ -double stdlib_base_j1( const double x ) { +double stdlib_base_besselj1( const double x ) { double value; double rc; double rs;