From 6d951c2915e7296624692a9e7132253750a83b45 Mon Sep 17 00:00:00 2001 From: GUNJ JOSHI Date: Sun, 11 Aug 2024 16:19:05 +0530 Subject: [PATCH] docs: update function name for C implementation from j0 to besselj0 --- .../@stdlib/math/base/special/besselj0/README.md | 14 +++++++------- .../besselj0/benchmark/c/native/benchmark.c | 4 ++-- .../base/special/besselj0/examples/c/example.c | 4 ++-- .../stdlib/math/base/special/{j0.h => besselj0.h} | 8 ++++---- .../@stdlib/math/base/special/besselj0/src/addon.c | 4 ++-- .../@stdlib/math/base/special/besselj0/src/main.c | 6 +++--- 6 files changed, 20 insertions(+), 20 deletions(-) rename lib/node_modules/@stdlib/math/base/special/besselj0/include/stdlib/math/base/special/{j0.h => besselj0.h} (83%) diff --git a/lib/node_modules/@stdlib/math/base/special/besselj0/README.md b/lib/node_modules/@stdlib/math/base/special/besselj0/README.md index 0ce521175f3..0355c576eb0 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj0/README.md +++ b/lib/node_modules/@stdlib/math/base/special/besselj0/README.md @@ -122,18 +122,18 @@ for ( i = 0; i < 100; i++ ) { ### Usage ```c -#include "stdlib/math/base/special/j0.h" +#include "stdlib/math/base/special/besselj0.h" ``` -#### stdlib_base_j0( x ) +#### stdlib_base_besselj0( x ) Computes the [Bessel function of the first kind][bessel-first-kind] of order zero at `x`. ```c -double out = stdlib_base_j0( 0.0 ); +double out = stdlib_base_besselj0( 0.0 ); // returns 1.0 -out = stdlib_base_j0( 1.0 ); +out = stdlib_base_besselj0( 1.0 ); // returns ~0.765 ``` @@ -142,7 +142,7 @@ The function accepts the following arguments: - **x**: `[in] double` input value. ```c -double stdlib_base_j0( const double x ); +double stdlib_base_besselj0( const double x ); ``` @@ -164,7 +164,7 @@ double stdlib_base_j0( const double x ); ### Examples ```c -#include "stdlib/math/base/special/j0.h" +#include "stdlib/math/base/special/besselj0.h" #include int main( void ) { @@ -173,7 +173,7 @@ int main( void ) { double y; int i; for ( i = 0; i < 5; i++ ) { - y = stdlib_base_j0( x[ i ] ); + y = stdlib_base_besselj0( x[ i ] ); printf( "besselj0(%lf) = %lf\n", x[ i ], y ); } } diff --git a/lib/node_modules/@stdlib/math/base/special/besselj0/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/besselj0/benchmark/c/native/benchmark.c index 5d72cc10fa2..fb6e255fb83 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj0/benchmark/c/native/benchmark.c +++ b/lib/node_modules/@stdlib/math/base/special/besselj0/benchmark/c/native/benchmark.c @@ -16,7 +16,7 @@ * limitations under the License. */ -#include "stdlib/math/base/special/j0.h" +#include "stdlib/math/base/special/besselj0.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_j0( x ); + y = stdlib_base_besselj0( x ); if ( y != y ) { printf( "should not return NaN\n" ); break; diff --git a/lib/node_modules/@stdlib/math/base/special/besselj0/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/besselj0/examples/c/example.c index 1a6b51ede91..988b822009e 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj0/examples/c/example.c +++ b/lib/node_modules/@stdlib/math/base/special/besselj0/examples/c/example.c @@ -16,7 +16,7 @@ * limitations under the License. */ -#include "stdlib/math/base/special/j0.h" +#include "stdlib/math/base/special/besselj0.h" #include int main( void ) { @@ -25,7 +25,7 @@ int main( void ) { double y; int i; for ( i = 0; i < 5; i++ ) { - y = stdlib_base_j0( x[ i ] ); + y = stdlib_base_besselj0( x[ i ] ); printf( "besselj0(%lf) = %lf\n", x[ i ], y ); } } diff --git a/lib/node_modules/@stdlib/math/base/special/besselj0/include/stdlib/math/base/special/j0.h b/lib/node_modules/@stdlib/math/base/special/besselj0/include/stdlib/math/base/special/besselj0.h similarity index 83% rename from lib/node_modules/@stdlib/math/base/special/besselj0/include/stdlib/math/base/special/j0.h rename to lib/node_modules/@stdlib/math/base/special/besselj0/include/stdlib/math/base/special/besselj0.h index cb3d10c2ae4..5ef7121b6f8 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj0/include/stdlib/math/base/special/j0.h +++ b/lib/node_modules/@stdlib/math/base/special/besselj0/include/stdlib/math/base/special/besselj0.h @@ -16,8 +16,8 @@ * limitations under the License. */ -#ifndef STDLIB_MATH_BASE_SPECIAL_J0_H -#define STDLIB_MATH_BASE_SPECIAL_J0_H +#ifndef STDLIB_MATH_BASE_SPECIAL_BESSELJ0_H +#define STDLIB_MATH_BASE_SPECIAL_BESSELJ0_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 zero. */ -double stdlib_base_j0( const double x ); +double stdlib_base_besselj0( const double x ); #ifdef __cplusplus } #endif -#endif // !STDLIB_MATH_BASE_SPECIAL_J0_H +#endif // !STDLIB_MATH_BASE_SPECIAL_BESSELJ0_H diff --git a/lib/node_modules/@stdlib/math/base/special/besselj0/src/addon.c b/lib/node_modules/@stdlib/math/base/special/besselj0/src/addon.c index f0a212c2b44..d3dbba1c207 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj0/src/addon.c +++ b/lib/node_modules/@stdlib/math/base/special/besselj0/src/addon.c @@ -16,7 +16,7 @@ * limitations under the License. */ -#include "stdlib/math/base/special/j0.h" +#include "stdlib/math/base/special/besselj0.h" #include "stdlib/math/base/napi/unary.h" -STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_j0 ) +STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_besselj0 ) diff --git a/lib/node_modules/@stdlib/math/base/special/besselj0/src/main.c b/lib/node_modules/@stdlib/math/base/special/besselj0/src/main.c index cccd9ad1c70..cda3e152cb7 100644 --- a/lib/node_modules/@stdlib/math/base/special/besselj0/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/besselj0/src/main.c @@ -29,7 +29,7 @@ * ``` */ -#include "stdlib/math/base/special/j0.h" +#include "stdlib/math/base/special/besselj0.h" #include "stdlib/math/base/special/sqrt.h" #include "stdlib/math/base/special/sincos.h" #include "stdlib/constants/float64/pinf.h" @@ -217,10 +217,10 @@ static double rational_psqs( const double x ) { * @return evaluated Bessel function * * @example -* double y = stdlib_base_j0( 0.0 ); +* double y = stdlib_base_besselj0( 0.0 ); * // returns 1.0 */ -double stdlib_base_j0( const double x ) { +double stdlib_base_besselj0( const double x ) { double rc; double rs; double y2;