From 3941ec4fcb1a58d96fe4c67082904d91cce9fabf Mon Sep 17 00:00:00 2001 From: officiallyanee Date: Wed, 25 Mar 2026 10:43:40 +0530 Subject: [PATCH] docs(math/base/special): fix C examples --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/math/base/special/fibonacci-indexf/src/main.c | 2 +- .../@stdlib/math/base/special/gamma-lanczos-sum/src/main.c | 2 +- lib/node_modules/@stdlib/math/base/special/hyp2f1/src/main.c | 2 +- .../@stdlib/math/base/special/kronecker-deltaf/src/main.c | 4 ++-- lib/node_modules/@stdlib/math/base/special/log1pmx/src/main.c | 2 +- lib/node_modules/@stdlib/math/base/special/sech/src/main.c | 2 +- lib/node_modules/@stdlib/math/base/special/sqrtpi/src/main.c | 2 +- lib/node_modules/@stdlib/math/base/special/trunc10/src/main.c | 2 +- lib/node_modules/@stdlib/math/base/special/vercosf/src/main.c | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/fibonacci-indexf/src/main.c b/lib/node_modules/@stdlib/math/base/special/fibonacci-indexf/src/main.c index 5779e279b075..76d3dd74d38c 100644 --- a/lib/node_modules/@stdlib/math/base/special/fibonacci-indexf/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/fibonacci-indexf/src/main.c @@ -38,7 +38,7 @@ static const float SQRT_5 = 2.23606797749979f; * @return Fibonacci number index * * @example -* float out = stdlib_base_fibonacci_index( 2.0f ); +* float out = stdlib_base_fibonacci_indexf( 2.0f ); * // returns 3.0f */ float stdlib_base_fibonacci_indexf( const float F ) { diff --git a/lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum/src/main.c b/lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum/src/main.c index 04a2fd2b3ee5..1b6cfdc29b9b 100644 --- a/lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/gamma-lanczos-sum/src/main.c @@ -66,7 +66,7 @@ static double rational_pq( const double x ) { * @return Lanczos sum approximation * * @example -* double v = stdlib_base_gammaLanczosSum( 4.0 ); +* double v = stdlib_base_gamma_lanczos_sum( 4.0 ); * // returns ~950.366 */ double stdlib_base_gamma_lanczos_sum( const double x ) { diff --git a/lib/node_modules/@stdlib/math/base/special/hyp2f1/src/main.c b/lib/node_modules/@stdlib/math/base/special/hyp2f1/src/main.c index 4847ed48573a..d46cf833b0b2 100644 --- a/lib/node_modules/@stdlib/math/base/special/hyp2f1/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/hyp2f1/src/main.c @@ -408,7 +408,7 @@ static double hyt2f1( const double a, const double b, const double c, const doub * @return function value * * @example -* double v = stdlib_base_gamma( 1.0, 1.0, 1.0, 0.0 ); +* double v = stdlib_base_hyp2f1( 1.0, 1.0, 1.0, 0.0 ); * // returns 1.0 */ double stdlib_base_hyp2f1( const double a, const double b, const double c, const double x ) { diff --git a/lib/node_modules/@stdlib/math/base/special/kronecker-deltaf/src/main.c b/lib/node_modules/@stdlib/math/base/special/kronecker-deltaf/src/main.c index ede800132951..8df5302179c9 100644 --- a/lib/node_modules/@stdlib/math/base/special/kronecker-deltaf/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/kronecker-deltaf/src/main.c @@ -27,11 +27,11 @@ * @return function value * * @example -* float v = stdlib_base_kronecker_delta( 3.0f, 3.0f ); +* float v = stdlib_base_kronecker_deltaf( 3.0f, 3.0f ); * // returns 1.0f * * @example -* float v = stdlib_base_kronecker_delta( 3.0f, 3.14f ); +* float v = stdlib_base_kronecker_deltaf( 3.0f, 3.14f ); * // returns 0.0f */ float stdlib_base_kronecker_deltaf( const float i, const float j ) { diff --git a/lib/node_modules/@stdlib/math/base/special/log1pmx/src/main.c b/lib/node_modules/@stdlib/math/base/special/log1pmx/src/main.c index 0d590a971ef6..19402e19967d 100644 --- a/lib/node_modules/@stdlib/math/base/special/log1pmx/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/log1pmx/src/main.c @@ -43,7 +43,7 @@ * * @example * double out = stdlib_base_log1pmx( 0.0 ); -* // returns ~0.693 +* // returns 0.0 */ double stdlib_base_log1pmx( const double x ) { double ax; diff --git a/lib/node_modules/@stdlib/math/base/special/sech/src/main.c b/lib/node_modules/@stdlib/math/base/special/sech/src/main.c index 7f707aafc9bb..ed92b88f7ed1 100644 --- a/lib/node_modules/@stdlib/math/base/special/sech/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/sech/src/main.c @@ -26,7 +26,7 @@ * @return hyperbolic secant * * @example -* var v = stdlib_base_sech( 2.0 ); +* double v = stdlib_base_sech( 2.0 ); * // returns ~0.2658 */ double stdlib_base_sech( const double x ) { diff --git a/lib/node_modules/@stdlib/math/base/special/sqrtpi/src/main.c b/lib/node_modules/@stdlib/math/base/special/sqrtpi/src/main.c index a981f450a34a..c6d3d6d0a074 100644 --- a/lib/node_modules/@stdlib/math/base/special/sqrtpi/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/sqrtpi/src/main.c @@ -28,7 +28,7 @@ * * @example * double out = stdlib_base_sqrtpi( 4.0 ); -* // returns 3.5449 +* // returns ~3.5449 */ double stdlib_base_sqrtpi( const double x ) { return stdlib_base_sqrt( x * STDLIB_CONSTANT_FLOAT64_PI ); diff --git a/lib/node_modules/@stdlib/math/base/special/trunc10/src/main.c b/lib/node_modules/@stdlib/math/base/special/trunc10/src/main.c index f6581b3c381a..c2f692f7db8c 100644 --- a/lib/node_modules/@stdlib/math/base/special/trunc10/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/trunc10/src/main.c @@ -30,7 +30,7 @@ * @return rounded value * * @example -* double y = stdlib_base_trunc2( 13.0 ); +* double y = stdlib_base_trunc10( 13.0 ); * // returns 10.0 */ double stdlib_base_trunc10( const double x ) { diff --git a/lib/node_modules/@stdlib/math/base/special/vercosf/src/main.c b/lib/node_modules/@stdlib/math/base/special/vercosf/src/main.c index b907409bb6a9..c0af62cb1035 100644 --- a/lib/node_modules/@stdlib/math/base/special/vercosf/src/main.c +++ b/lib/node_modules/@stdlib/math/base/special/vercosf/src/main.c @@ -27,7 +27,7 @@ * * @example * float y = stdlib_base_vercosf( 3.141592653589793f / 2.0f ); -* // returns 1.0f +* // returns ~1.0f */ float stdlib_base_vercosf( const float x ) { return 1.0f + stdlib_base_cosf( x );