Skip to content

docs: add equations - #14691

Merged
kgryte merged 1 commit into
stdlib-js:developfrom
anandkaranubc:docs/add-equations-min-max
Aug 27, 2026
Merged

kgryte merged 1 commit into
stdlib-js:developfrom
anandkaranubc:docs/add-equations-min-max

Conversation

@anandkaranubc

Copy link
Copy Markdown
Contributor

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

Description

What is the purpose of this pull request?

This pull request:

  • add equations to min/max function READMEs

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

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.

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

@anandkaranubc
anandkaranubc requested a review from a team August 27, 2026 05:40
@stdlib-bot stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. labels Aug 27, 2026
@anandkaranubc
anandkaranubc force-pushed the docs/add-equations-min-max branch from 5a205b0 to adab5f4 Compare August 27, 2026 05:42
Add defining equations to the intro sections of max, min, maxabs,
minabs, maxn, minn, maxabsn, minabsn, minmax, minmaxabs, minmaxn,
nanmax, nanmin and their single-precision variants. The nanmax/nanmin
equations use piecewise definitions showing NaN-handling semantics.

Ref: stdlib-js/metr-issue-tracker#1257
@stdlib-bot

stdlib-bot commented Aug 27, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
math/base/special/max $\\color{green}176/176$
$\\color{green}+100.00\\%$
$\\color{green}16/16$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}176/176$
$\\color{green}+100.00\\%$
math/base/special/maxabs $\\color{green}160/160$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}160/160$
$\\color{green}+100.00\\%$
math/base/special/maxabsf $\\color{green}161/161$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}161/161$
$\\color{green}+100.00\\%$
math/base/special/maxabsn $\\color{green}125/125$
$\\color{green}+100.00\\%$
$\\color{green}9/9$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}125/125$
$\\color{green}+100.00\\%$
math/base/special/maxf $\\color{green}176/176$
$\\color{green}+100.00\\%$
$\\color{green}16/16$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}176/176$
$\\color{green}+100.00\\%$
math/base/special/maxn $\\color{green}151/151$
$\\color{green}+100.00\\%$
$\\color{green}25/25$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}151/151$
$\\color{green}+100.00\\%$
math/base/special/min $\\color{green}176/176$
$\\color{green}+100.00\\%$
$\\color{green}16/16$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}176/176$
$\\color{green}+100.00\\%$
math/base/special/minabs $\\color{green}160/160$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}160/160$
$\\color{green}+100.00\\%$
math/base/special/minabsf $\\color{green}161/161$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}161/161$
$\\color{green}+100.00\\%$
math/base/special/minabsn $\\color{green}125/125$
$\\color{green}+100.00\\%$
$\\color{green}8/8$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}125/125$
$\\color{green}+100.00\\%$
math/base/special/minf $\\color{green}176/176$
$\\color{green}+100.00\\%$
$\\color{green}16/16$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}176/176$
$\\color{green}+100.00\\%$
math/base/special/minmax $\\color{green}253/253$
$\\color{green}+100.00\\%$
$\\color{green}17/17$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}253/253$
$\\color{green}+100.00\\%$
math/base/special/minmaxabs $\\color{green}258/258$
$\\color{green}+100.00\\%$
$\\color{green}12/12$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}258/258$
$\\color{green}+100.00\\%$
math/base/special/minmaxabsf $\\color{green}258/258$
$\\color{green}+100.00\\%$
$\\color{green}12/12$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}258/258$
$\\color{green}+100.00\\%$
math/base/special/minmaxabsn $\\color{green}255/255$
$\\color{green}+100.00\\%$
$\\color{green}24/24$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}255/255$
$\\color{green}+100.00\\%$
math/base/special/minmaxf $\\color{green}253/253$
$\\color{green}+100.00\\%$
$\\color{green}17/17$
$\\color{green}+100.00\\%$
$\\color{green}3/3$
$\\color{green}+100.00\\%$
$\\color{green}253/253$
$\\color{green}+100.00\\%$
math/base/special/minmaxn $\\color{green}267/267$
$\\color{green}+100.00\\%$
$\\color{green}35/35$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}267/267$
$\\color{green}+100.00\\%$
math/base/special/minn $\\color{green}151/151$
$\\color{green}+100.00\\%$
$\\color{green}25/25$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}151/151$
$\\color{green}+100.00\\%$
math/base/special/nanmax $\\color{green}159/159$
$\\color{green}+100.00\\%$
$\\color{green}11/11$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}159/159$
$\\color{green}+100.00\\%$
math/base/special/nanmaxf $\\color{green}159/159$
$\\color{green}+100.00\\%$
$\\color{green}11/11$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}159/159$
$\\color{green}+100.00\\%$
math/base/special/nanmin $\\color{green}159/159$
$\\color{green}+100.00\\%$
$\\color{green}11/11$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}159/159$
$\\color{green}+100.00\\%$
math/base/special/nanminf $\\color{green}159/159$
$\\color{green}+100.00\\%$
$\\color{green}11/11$
$\\color{green}+100.00\\%$
$\\color{green}2/2$
$\\color{green}+100.00\\%$
$\\color{green}159/159$
$\\color{green}+100.00\\%$

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

@anandkaranubc
anandkaranubc force-pushed the docs/add-equations-min-max branch from adab5f4 to 39e633a Compare August 27, 2026 05:45
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. METR Pull request associated with the METR project. and removed Needs Review A pull request which needs code review. labels Aug 27, 2026
@kgryte
kgryte merged commit 7513923 into stdlib-js:develop Aug 27, 2026
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation. Math Issue or pull request specific to math functionality. METR Pull request associated with the METR project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants