feat: add `math/base/special/acoshf` #5812

0PrashantYadav0 · 2025-03-05T19:00:12Z

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

added base implementation for math/base/special/acoshf
added benchmark, example and test.
added docs and C-implementation.

Related Issues

Does this pull request have any related issues?

This pull request:

ref [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

0PrashantYadav0 · 2025-03-05T19:00:32Z

Depend on #5803

--- 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: passed - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

Planeshifter · 2025-03-16T20:23:47Z

⚠️ Tracking Issue Closure Warning ⚠️

I noticed your PR description contains closing keywords ("Resolves", "Closes", or "Fixes") referencing a "Tracking Issue".

Why this matters:
Tracking issues should typically remain open until all related sub-issues are completed. GitHub automatically closes issues with such closing keywords when the PR is merged.

Required action:
Use "Progresses:" or "Ref:" instead to reference the tracking issue without automatically closing it.

Thank you for your contribution to the project!

kgryte · 2025-12-04T07:58:44Z

/stdlib merge

kgryte · 2025-12-04T08:02:08Z

/stdlib update-copyright-years

Signed-off-by: Nakul Krishnakumar <[email protected]>

stdlib-bot · 2025-12-04T16:58:52Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/acoshf	$\color{red}224/226$ $\color{green}+0.00%$	$\color{red}13/14$ $\color{green}+0.00%$	$\color{green}2/2$ $\color{green}+0.00%$	$\color{red}224/226$ $\color{green}+0.00%$

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

anandkaranubc · 2025-12-04T18:07:29Z

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

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


This is not needed. JavaScript does not have Math.acoshf

anandkaranubc · 2025-12-04T18:08:39Z

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

+	var y;
+	var i;
+
+	x = uniform( 100, 1.0, 100.0 );


Missing opts argument.

Should be changed to:

x = uniform( 100, 1.0, 100.0, { 'dtype': 'float32' });

Same for benchmark.native.js

anandkaranubc · 2025-12-04T18:10:04Z

lib/node_modules/@stdlib/math/base/special/acoshf/benchmark/c/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 );
+}


We have moved away from using rand_float in our benchmarks. We use this instead:

/** * Generates a random number on the interval [min,max). * * @param min minimum value (inclusive) * @param max maximum value (exclusive) * @return random number */ static float random_uniform( const float min, const float max ) { float v = (float)rand() / ( (float)RAND_MAX + 1.0f ); return min + ( v*(max-min) ); }

anandkaranubc · 2025-12-04T18:10:55Z

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

+	for ( i = 0; i < 100; i++ ) {
+		x[ i ] = ( 100.0f*rand_float() ) + 1.0f;
+	}


These lines will be changed accordingly. Reference: https://github.com/0PrashantYadav0/stdlib/blob/a8785515d4aab7c059e0d1c45e62f656404e5f45/lib/node_modules/%40stdlib/math/base/special/log1pf/benchmark/c/native/benchmark.c#L101-L103

anandkaranubc · 2025-12-04T18:13:34Z

lib/node_modules/@stdlib/math/base/special/acoshf/examples/index.js

+var linspace = require( '@stdlib/array/base/linspace' );
+var acoshf = require( './../lib' );
+
+var x = linspace( 1.0, 5.0, 100 );
+
+var i;
+for ( i = 0; i < x.length; i++ ) {
+	console.log( 'acoshf( %d ) = %d', x[ i ], acoshf( x[ i ] ) );
+}


Can you please use @stdlib/console/log-each-map instead? The above coding structure is outdated now.

Reference: https://github.com/0PrashantYadav0/stdlib/blob/a8785515d4aab7c059e0d1c45e62f656404e5f45/lib/node_modules/%40stdlib/math/base/special/log1pf/examples/index.js#L21-L30

anandkaranubc · 2025-12-04T18:17:16Z

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

+
+// VARIABLES //
+
+var HUGE = 1 << 28; // 2**28


var HUGE = f32( 1 << 28 ); // 2**28

anandkaranubc · 2025-12-04T18:18:13Z

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

+	var t;
+	var s;
+	x = f32( x );
+	if ( isnanf( x ) || x < 1.0 ) {


if ( isnanf( x ) || x < f32( 1.0 ) ) {

This applies to all the numbers below too. Like 0.0, 1.0, 2.0, etc.

Or you can declare them as separate variables. Like https://github.com/0PrashantYadav0/stdlib/blob/a8785515d4aab7c059e0d1c45e62f656404e5f45/lib/node_modules/%40stdlib/math/base/special/log1pf/lib/main.js#L85-L89

anandkaranubc · 2025-12-04T18:19:49Z

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

+	var s;
+	x = f32( x );


var s; x = f32( x );

Leaving a space between the variable declarations and rest of the code makes it a bit cleaner :)

anandkaranubc · 2025-12-04T18:21:31Z

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

+```javascript
+var linspace = require( '@stdlib/array/base/linspace' );
+var acoshf = require( '@stdlib/math/base/special/acoshf' );
+
+var x = linspace( 1.0, 5.0, 100 );
+
+var i;
+for ( i = 0; i < x.length; i++ ) {
+    console.log( acoshf( x[ i ] ) );
+}
+```


This will be updated accordingly.

anandkaranubc · 2025-12-04T18:22:19Z

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

+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/math/base/special/acos`][@stdlib/math/base/special/acos]</span><span class="delimiter">: </span><span class="description">compute the arccosine of a double-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/asinh`][@stdlib/math/base/special/asinh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arcsine of a double-precision floating-point number.</span>
+-   <span class="package-name">[`@stdlib/math/base/special/atanh`][@stdlib/math/base/special/atanh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arctangent of a double-precision floating-point number.</span>
+


You can remove these as these get automatically populated, through our automation scripts.

anandkaranubc · 2025-12-04T18:22:33Z

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

+[@stdlib/math/base/special/acos]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acos
+
+[@stdlib/math/base/special/asinh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinh
+
+[@stdlib/math/base/special/atanh]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atanh


Same for these.

Signed-off-by: Nakul Krishnakumar <[email protected]>

Updated the benchmark for acoshf to use float32 dtype and removed the built-in benchmark. Signed-off-by: Nakul Krishnakumar <[email protected]>

Signed-off-by: Nakul Krishnakumar <[email protected]>

anandkaranubc · 2025-12-05T05:24:06Z

/stdlib lint-autofix

Signed-off-by: Karan Anand <[email protected]>

Signed-off-by: Nakul Krishnakumar <[email protected]>

feat: add math/special/acoshf

c4b1fc0

0PrashantYadav0 marked this pull request as draft March 5, 2025 19:00

stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels Mar 5, 2025

Planeshifter added the Potential Duplicate There might be another pull request resolving the same issue. label Mar 15, 2025

stdlib-bot removed the Potential Duplicate There might be another pull request resolving the same issue. label Apr 19, 2025

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Dec 4, 2025

Merge remote-tracking branch 'upstream/develop' into math-acoshf

e3216fc

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Dec 4, 2025

kgryte marked this pull request as ready for review December 4, 2025 08:01

chore: update copyright years

b331344

stdlib-bot added Needs Review A pull request which needs code review. bot: In Progress Pull request is currently awaiting automation. and removed bot: In Progress Pull request is currently awaiting automation. labels Dec 4, 2025

nakul-krishnakumar added 5 commits December 4, 2025 19:58

chore: clean up cppcheck-suppress comment

b8ef86b

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: remove scripts from directory list

9b2442b

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: add f32 conversions for computation statements

7e102fc

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: add f64 to f32 conversions

5208ebc

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: update according to code review

b2aedfe

Signed-off-by: Nakul Krishnakumar <[email protected]>

anandkaranubc reviewed Dec 4, 2025

View reviewed changes

nakul-krishnakumar added 9 commits December 5, 2025 10:10

chore: update benchmark according to code review

6286d27

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: update according to code review

1af2e2e

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: update according to code review

a1ecf61

Updated the benchmark for acoshf to use float32 dtype and removed the built-in benchmark. Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: update according to code review

7644039

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: update code to meet new conventions

19a39d8

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: update code to meet new conventions

65ea4ac

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: update according to code review

5271521

Signed-off-by: Nakul Krishnakumar <[email protected]>

chore: update according to code review

6e6d6ff

Signed-off-by: Nakul Krishnakumar <[email protected]>

style: remove trailing whitespace

05406a4

Signed-off-by: Nakul Krishnakumar <[email protected]>

stdlib-bot added the bot: In Progress Pull request is currently awaiting automation. label Dec 5, 2025

fix: resolve lint errors

28e62b0

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Dec 5, 2025

anandkaranubc and others added 8 commits December 4, 2025 21:28

chore: add line break to fix lint error

64a5825

Signed-off-by: Karan Anand <[email protected]>

test: use ulpdiff for test comparisons

fbd1193

Signed-off-by: Nakul Krishnakumar <[email protected]>

test: use ulpdiff for test comparisons

47e7c8b

Signed-off-by: Nakul Krishnakumar <[email protected]>

test: use ulpdiff for test comparisons

8f708ea

Signed-off-by: Nakul Krishnakumar <[email protected]>

docs: update README according to code review

5ff8b47

Signed-off-by: Nakul Krishnakumar <[email protected]>

style: fix lint errors

492cc92

Signed-off-by: Nakul Krishnakumar <[email protected]>

style: fix lint errors

f3d173d

Signed-off-by: Nakul Krishnakumar <[email protected]>

docs: update according to code review

a7a7078

Signed-off-by: Nakul Krishnakumar <[email protected]>

nakul-krishnakumar requested a review from anandkaranubc December 5, 2025 17:32

Uh oh!

feat: add math/base/special/acoshf #5812

Are you sure you want to change the base?

feat: add math/base/special/acoshf #5812

Conversation

0PrashantYadav0 commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Questions

Other

Checklist

Uh oh!

0PrashantYadav0 commented Mar 5, 2025

Uh oh!

Planeshifter commented Mar 16, 2025

Uh oh!

kgryte commented Dec 4, 2025

Uh oh!

kgryte commented Dec 4, 2025

Uh oh!

stdlib-bot commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anandkaranubc commented Dec 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

feat: add `math/base/special/acoshf` #5812

feat: add `math/base/special/acoshf` #5812

0PrashantYadav0 commented Mar 5, 2025 •

edited

Loading

stdlib-bot commented Dec 4, 2025 •

edited

Loading