feat: add `math/base/special/atanhf` #9514

hrshya · 2026-01-03T09:13:30Z

Resolves none .

Description

What is the purpose of this pull request?

This pull request:

Adds the complete implementation for math/base/special/atanhf .

Related Issues

Does this pull request have any related issues?

This pull request:

progresses [RFC]: Add C implementations to base special math functions (tracking issue) #649 .

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

stdlib-bot · 2026-01-03T09:48:56Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/atanhf	$\color{green}255/255$ $\color{green}+0.00%$	$\color{green}24/24$ $\color{green}+4.55%$	$\color{green}2/2$ $\color{green}+0.00%$	$\color{green}255/255$ $\color{green}+0.00%$

The above coverage report was generated for the changes in this PR.

Signed-off-by: Harsh <[email protected]>

hrshya · 2026-01-03T10:04:09Z

/stdlib lint-autofix

stdlib-bot · 2026-01-03T10:06:12Z

/stdlib lint-autofix

@hrshya, the slash command failed to complete. Please check the workflow logs for details.

View workflow run

Signed-off-by: Harsh <[email protected]>

Planeshifter · 2026-01-07T05:14:36Z

lib/node_modules/@stdlib/math/base/special/atanhf/benchmark/c/native/benchmark.c

+*/
+static double benchmark( void ) {
+	double elapsed;
+	double x;


Variables x and y declared as double instead of float here.

Planeshifter · 2026-01-07T05:16:53Z

lib/node_modules/@stdlib/math/base/special/atanhf/benchmark/benchmark.js

+// VARIABLES //
+
+var opts = {
+	'skip': ( typeof Math.atanhf !== 'function' ) // eslint-disable-line stdlib/no-builtin-math


Math.atanhf does not exist. Can only compare to Math.atanh.

Planeshifter · 2026-01-07T05:18:44Z

lib/node_modules/@stdlib/math/base/special/atanhf/src/main.c

+#include "stdlib/constants/float32/ninf.h"
+#include <stdint.h>
+
+static const float NEAR_ZERO = 1.0 / (1 << 28); // 2**-28


Suggested change

static const float NEAR_ZERO = 1.0 / (1 << 28); // 2**-28

static const float NEAR_ZERO = 1.0f / (1 << 28); // 2**-28

Planeshifter · 2026-01-07T05:19:46Z

lib/node_modules/@stdlib/math/base/special/atanhf/README.md

+    int i;
+    for ( i = 0; i < 10; i++ ) {
+        v = stdlib_base_atanhf( x[ i ] );
+        printf( "atanhf(%lf) = %lf\n", x[ i ], v );


Should use %f instead of %lf.

…eat/atanhf

lib/node_modules/@stdlib/math/base/special/atanhf/lib/main.js

Planeshifter · 2026-01-08T00:25:52Z

lib/node_modules/@stdlib/math/base/special/atanhf/test/test.native.js

+			t.strictEqual( y, e, 'x: '+x[i]+'. E: '+e );
+		} else {
+			delta = abs( y - e );
+			tol = 1.3 * EPS * abs( e );


Is there are reason why the "small negative" test case uses 1.3 * EPS here but 1.0 * EPS in test.js line 123?

Planeshifter · 2026-01-08T00:26:23Z

lib/node_modules/@stdlib/math/base/special/atanhf/docs/repl.txt

+    NaN
+
+    See Also
+    --------


Missing blank line after the See Also separator.

lib/node_modules/@stdlib/math/base/special/atanhf/lib/main.js

--- 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: passed - 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: na - 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 ---

lib/node_modules/@stdlib/math/base/special/atanhf/src/main.c

--- 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: passed - 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 ---

--- 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: na - 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 ---

anandkaranubc · 2026-01-08T05:30:37Z

lib/node_modules/@stdlib/math/base/special/atanhf/benchmark/c/native/benchmark.c

+/**
+* 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 );
+}


Can you update this to use random_uniform instead? You can refer to tanf for this

anandkaranubc · 2026-01-08T05:31:17Z

lib/node_modules/@stdlib/math/base/special/atanhf/benchmark/c/native/benchmark.c

+		x = ( 2.0f * rand_float() ) - 1.0f;
+		y = stdlib_base_atanhf( x );


This should be done outside the loop. tanf is a good example to refer to.

anandkaranubc · 2026-01-08T05:32:43Z

lib/node_modules/@stdlib/math/base/special/atanhf/benchmark/c/benchmark.c

+*
+* @return random number
+*/
+static float rand_float( void ) {


Same comment applies here and below, for random number generation.

anandkaranubc · 2026-01-08T05:34:08Z

lib/node_modules/@stdlib/math/base/special/atanhf/test/test.js

+		if ( y === e ) {
+			t.strictEqual( y, e, 'x: '+x[i]+'. E: '+e );
+		} else {
+			delta = abs( y - e );
+			tol = 1.3 * EPS * abs( e );
+			t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+e+'. Δ: '+delta+'. tol: '+tol+'.' );
+		}


Can you refactor this to use assert/is-almost-same-value instead?

Same comment applies below and for test.native.js

--- 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: passed - 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: na - 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 ---

--- 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: passed - 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 ---

anandkaranubc · 2026-01-08T05:34:45Z

lib/node_modules/@stdlib/math/base/special/atanhf/test/test.js

+		if ( y === e ) {
+			t.strictEqual( y, e, 'x: '+x[i]+'. E: '+e );
+		} else {
+			delta = abs( y - e );
+			tol = 1.3 * EPS * abs( e );
+			t.ok( delta <= tol, 'within tolerance. x: '+x[i]+'. y: '+y+'. E: '+e+'. Δ: '+delta+'. tol: '+tol+'.' );
+		}


Same comment applies below and for test.native.js

feat: add math/base/special/atanhf

43a669c

stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. labels Jan 3, 2026

hrshya added 2 commits January 3, 2026 14:49

fix: resolves lint issues

b9b61f6

fix: resolves lint issues

f506cff

Update test.native.js

7d8d51d

Signed-off-by: Harsh <[email protected]>

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Jan 3, 2026

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Jan 3, 2026

hrshya and others added 4 commits January 3, 2026 15:42

resolves lint issues

2be0a49

Update benchmark.js

6f1c33f

Signed-off-by: Harsh <[email protected]>

Update benchmark.native.js

2391a79

Signed-off-by: Harsh <[email protected]>

Update runner.jl

8f6c46d

Signed-off-by: Harsh <[email protected]>

hrshya requested review from anandkaranubc and kgryte January 3, 2026 12:31

Planeshifter reviewed Jan 7, 2026

View reviewed changes

Planeshifter added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Jan 7, 2026

hrshya added 2 commits January 7, 2026 15:02

Merge branch 'feat/atanhf' of https://github.com/hrshya/stdlib into f…

a8a9d94

…eat/atanhf

fix: address PR review feedback

0d70803

hrshya requested a review from Planeshifter January 7, 2026 10:02

stdlib-bot added the Needs Review A pull request which needs code review. label Jan 7, 2026