[anandkaranubc]

Progresses stdlib-js/metr-issue-tracker#1257

Description

What is the purpose of this pull request?

This pull request:

• add equations to rounding function READMEs

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

• docs: add equations to README intro sections for math/base/special packages metr-issue-tracker#1257

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.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

• Yes
• No

If you answered "yes" above, how did you use AI assistance?

• Code generation (e.g., when writing an implementation or fixing a bug)
• Test/benchmark generation
• Documentation (including examples)
• Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

Used Claude Code code-generation tools to help assist with the feature.

---

@stdlib-js/reviewers

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/ceil	$\\color{green}157/157$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}157/157$ $\\color{green}+100.00\\%$
math/base/special/ceil10	$\\color{green}193/193$ $\\color{green}+100.00\\%$	$\\color{green}17/17$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}193/193$ $\\color{green}+100.00\\%$
math/base/special/ceil2	$\\color{green}193/193$ $\\color{green}+100.00\\%$	$\\color{green}19/19$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}193/193$ $\\color{green}+100.00\\%$
math/base/special/ceilb	$\\color{green}203/203$ $\\color{green}+100.00\\%$	$\\color{green}24/24$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}203/203$ $\\color{green}+100.00\\%$
math/base/special/ceilf	$\\color{green}157/157$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}157/157$ $\\color{green}+100.00\\%$
math/base/special/ceiln	$\\color{green}272/272$ $\\color{green}+100.00\\%$	$\\color{green}24/24$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}272/272$ $\\color{green}+100.00\\%$
math/base/special/ceilsd	$\\color{green}219/219$ $\\color{green}+100.00\\%$	$\\color{green}27/27$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}219/219$ $\\color{green}+100.00\\%$
math/base/special/floor	$\\color{green}157/157$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}157/157$ $\\color{green}+100.00\\%$
math/base/special/floor10	$\\color{green}193/193$ $\\color{green}+100.00\\%$	$\\color{green}19/19$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}193/193$ $\\color{green}+100.00\\%$
math/base/special/floor2	$\\color{green}193/193$ $\\color{green}+100.00\\%$	$\\color{green}19/19$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}193/193$ $\\color{green}+100.00\\%$
math/base/special/floor2f	$\\color{green}202/202$ $\\color{green}+100.00\\%$	$\\color{green}19/19$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}202/202$ $\\color{green}+100.00\\%$
math/base/special/floorb	$\\color{green}203/203$ $\\color{green}+100.00\\%$	$\\color{green}24/24$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}203/203$ $\\color{green}+100.00\\%$
math/base/special/floorf	$\\color{green}157/157$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}157/157$ $\\color{green}+100.00\\%$
math/base/special/floorn	$\\color{green}272/272$ $\\color{green}+100.00\\%$	$\\color{green}24/24$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}272/272$ $\\color{green}+100.00\\%$
math/base/special/floornf	$\\color{red}274/276$ $\\color{green}+99.28\\%$	$\\color{red}22/23$ $\\color{green}+95.65\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{red}274/276$ $\\color{green}+99.28\\%$
math/base/special/floorsd	$\\color{green}218/218$ $\\color{green}+100.00\\%$	$\\color{green}27/27$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}218/218$ $\\color{green}+100.00\\%$
math/base/special/round	$\\color{green}236/236$ $\\color{green}+100.00\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}236/236$ $\\color{green}+100.00\\%$
math/base/special/round-nearest-even	$\\color{green}280/280$ $\\color{green}+100.00\\%$	$\\color{green}15/15$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}280/280$ $\\color{green}+100.00\\%$
math/base/special/round10	$\\color{green}216/216$ $\\color{green}+100.00\\%$	$\\color{green}18/18$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}216/216$ $\\color{green}+100.00\\%$
math/base/special/round10f	$\\color{green}192/192$ $\\color{green}+100.00\\%$	$\\color{green}15/15$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}192/192$ $\\color{green}+100.00\\%$
math/base/special/round2	$\\color{green}218/218$ $\\color{green}+100.00\\%$	$\\color{green}19/19$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}218/218$ $\\color{green}+100.00\\%$
math/base/special/roundb	$\\color{green}203/203$ $\\color{green}+100.00\\%$	$\\color{green}24/24$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}203/203$ $\\color{green}+100.00\\%$
math/base/special/roundf	$\\color{green}258/258$ $\\color{green}+100.00\\%$	$\\color{green}17/17$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}258/258$ $\\color{green}+100.00\\%$
math/base/special/roundn	$\\color{green}279/279$ $\\color{green}+100.00\\%$	$\\color{green}23/23$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}279/279$ $\\color{green}+100.00\\%$
math/base/special/roundnf	$\\color{red}271/273$ $\\color{green}+99.27\\%$	$\\color{red}22/23$ $\\color{green}+95.65\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{red}271/273$ $\\color{green}+99.27\\%$
math/base/special/roundsd	$\\color{green}229/229$ $\\color{green}+100.00\\%$	$\\color{green}32/32$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}229/229$ $\\color{green}+100.00\\%$
math/base/special/trunc	$\\color{green}201/201$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}201/201$ $\\color{green}+100.00\\%$
math/base/special/trunc10	$\\color{green}171/171$ $\\color{green}+100.00\\%$	$\\color{green}12/12$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}171/171$ $\\color{green}+100.00\\%$
math/base/special/trunc2	$\\color{green}171/171$ $\\color{green}+100.00\\%$	$\\color{green}12/12$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}171/171$ $\\color{green}+100.00\\%$
math/base/special/truncb	$\\color{green}203/203$ $\\color{green}+100.00\\%$	$\\color{green}24/24$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}203/203$ $\\color{green}+100.00\\%$
math/base/special/truncf	$\\color{green}201/201$ $\\color{green}+100.00\\%$	$\\color{green}7/7$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}201/201$ $\\color{green}+100.00\\%$
math/base/special/truncn	$\\color{green}268/268$ $\\color{green}+100.00\\%$	$\\color{green}23/23$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}268/268$ $\\color{green}+100.00\\%$
math/base/special/truncsd	$\\color{green}219/219$ $\\color{green}+100.00\\%$	$\\color{green}27/27$ $\\color{green}+100.00\\%$	$\\color{green}2/2$ $\\color{green}+100.00\\%$	$\\color{green}219/219$ $\\color{green}+100.00\\%$

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

[kgryte]

I am trusting that these equations are all correct. 😅