feat: add `math/base/special/log1pf` #5803

0PrashantYadav0 · 2025-03-05T14:49:28Z

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: passed
task: lint_package_json status: passed
task: lint_repl_help status: passed
task: lint_javascript_src status: passed
task: lint_javascript_cli status: na
task: lint_javascript_examples status: passed
task: lint_javascript_tests status: passed
task: lint_javascript_benchmarks status: passed
task: lint_python status: na
task: lint_r status: na
task: lint_c_src status: passed
task: lint_c_examples status: passed
task: lint_c_benchmarks status: passed
task: lint_c_tests_fixtures status: na
task: lint_shell status: na
task: lint_typescript_declarations status: passed
task: lint_typescript_tests status: passed
task: lint_license_headers status: passed ---

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

added base implementation for math/base/special/log1pf
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

--- 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: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---

0PrashantYadav0 · 2025-03-05T14:50:43Z

/stdlib update-copyright-years

0PrashantYadav0 · 2025-03-05T14:51:20Z

@gunjjoshi @kgryte Please review this pr as it is important for other packages.

stdlib-bot · 2025-03-05T14:51:28Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/log1pf	$\color{red}380/393$ $color{green}+96.69%$	$\color{red}31/35$ $color{green}+88.57%$	$\color{green}3/3$ $color{green}+100.00%$	$\color{red}380/393$ $color{green}+96.69%$

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

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

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

Signed-off-by: Gunj Joshi <[email protected]>

--- 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: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - 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 ---

0PrashantYadav0 · 2025-03-06T06:09:18Z

@gunjjoshi I made the changes you asked for. Please review also i use freeBSD for my implementation along with the reference of log1p

gunjjoshi · 2025-03-07T05:15:29Z

@0PrashantYadav0 Thanks for working on this, but after commit 46d0f11, there doesn't seem to be any change in the implementation. You should be strictly following the freeBSD reference, rather than trying to port the double-precision netlib reference.

0PrashantYadav0 · 2025-03-07T12:12:35Z

@gunjjoshi I am not sure what you mean will you please explain this to me.

Neerajpathak07 · 2025-03-07T13:18:27Z

@0PrashantYadav0 Refer this msun implementation for log1pf

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

0PrashantYadav0 · 2025-03-07T17:05:14Z

I tried to implement the freeBSD completely but i am not sure why i am getting wrong values as an output.

0PrashantYadav0 · 2025-03-08T08:06:18Z

@gunjjoshi I made few changes according to your previous comments. Please review them. Thank you.

--- 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: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - 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: passed - 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 ---

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

⚠️ 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!

anandkaranubc · 2025-12-02T18:56:17Z

/stdlib merge

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

anandkaranubc · 2025-12-02T23:22:02Z

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

+		hu &= FLOAT32_SIGNIFICAND_MASK;
+
+		// Earlier sqrt(2) checks should be slightly looser than this one, so we never reach this point with k == 0 after deciding to use the correction term...
+		if ( hu < 0x3504f4 ) { // u < sqrt(2)


Is that ok to leave the hex value as is, without creating a separate variable? I am not sure what that would be called.

anandkaranubc · 2025-12-02T23:22:31Z

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

+		if ( k === 0 ) {
+			return f32( f - R );
+		}
+		// eslint-disable-next-line max-len


I hope this line is ok.

The "eslint" disable line.

anandkaranubc · 2025-12-02T23:22:45Z

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

+		return f32( f - f32( hfsq - f32( s * f32( hfsq + R ) ) ) );
+	}
+	// eslint-disable-next-line max-len
+	return f32( f32( k*LN2_HI ) - f32( f32( hfsq - f32( f32( s * f32( hfsq+R ) ) + f32( f32( k*LN2_LO ) + c ) ) ) - f ) );


Same for this one.

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

anandkaranubc · 2025-12-03T00:51:42Z

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

+		// cppcheck-suppress knownConditionTrueFalse
+		if ( ( hx > 0 ) || ( hx <= SQRT2HALFM1 ) ) { // sqrt(2)/2- <= 1+x < sqrt(2)+
+			k = 0;
+			f = x;
+			hu = 1;
+		}
+	}


Adding the // cppcheck-suppress knownConditionTrueFalse comment because I think cppcheck raises a false positive in here.

I believe it's thinking of it as "If a number is positive or a if it's negative" but this check is more of whether the number lies outside of a given range.

reference: https://github.com/freebsd/freebsd-src/blob/adb4901ac9ae6c2ceb4194d139ed3176f6ed5e55/lib/msun/src/s_log1pf.c#L58-L59

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

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

chore: update copyright years

5a24730

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

0PrashantYadav0 mentioned this pull request Mar 5, 2025

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

Draft

1 task

gunjjoshi reviewed Mar 5, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/log1pf/lib/main.js Outdated Show resolved Hide resolved

lib/node_modules/@stdlib/math/base/special/log1pf/lib/main.js Outdated Show resolved Hide resolved

lib/node_modules/@stdlib/math/base/special/log1pf/lib/main.js Show resolved Hide resolved

gunjjoshi and others added 2 commits March 6, 2025 00:40

Update lib/node_modules/@stdlib/math/base/special/log1pf/lib/main.js

669c44c

Signed-off-by: Gunj Joshi <[email protected]>

0PrashantYadav0 requested a review from gunjjoshi March 6, 2025 08:26

Neerajpathak07 reviewed Mar 7, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/log1pf/src/main.c Outdated Show resolved Hide resolved

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

kgryte requested a review from anandkaranubc November 14, 2025 18:51

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

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

998a5ad

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

anandkaranubc reviewed Dec 2, 2025

View reviewed changes

anandkaranubc reviewed Dec 3, 2025

View reviewed changes

Uh oh!

feat: add math/base/special/log1pf #5803

Are you sure you want to change the base?

feat: add math/base/special/log1pf #5803

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!

0PrashantYadav0 commented Mar 5, 2025

Uh oh!

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

Uh oh!

Coverage Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

0PrashantYadav0 commented Mar 6, 2025

Uh oh!

gunjjoshi commented Mar 7, 2025

Uh oh!

0PrashantYadav0 commented Mar 7, 2025

Uh oh!

Neerajpathak07 commented Mar 7, 2025

Uh oh!

Uh oh!

0PrashantYadav0 commented Mar 7, 2025

Uh oh!

0PrashantYadav0 commented Mar 8, 2025

Uh oh!

Planeshifter commented Mar 16, 2025

Uh oh!

anandkaranubc commented Dec 2, 2025

Uh oh!

anandkaranubc Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

anandkaranubc Dec 3, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

feat: add `math/base/special/log1pf` #5803

feat: add `math/base/special/log1pf` #5803

0PrashantYadav0 commented Mar 5, 2025 •

edited

Loading

stdlib-bot commented Mar 5, 2025 •

edited

Loading