From 39e633a9fedbc7870de699e16588c6b857896109 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Thu, 27 Aug 2026 11:09:13 +0530 Subject: [PATCH] docs: add equations to min/max function READMEs 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: https://github.com/stdlib-js/metr-issue-tracker/issues/1257 --- lib/node_modules/@stdlib/math/base/special/max/README.md | 8 ++++++++ .../@stdlib/math/base/special/maxabs/README.md | 8 ++++++++ .../@stdlib/math/base/special/maxabsf/README.md | 8 ++++++++ .../@stdlib/math/base/special/maxabsn/README.md | 8 ++++++++ lib/node_modules/@stdlib/math/base/special/maxf/README.md | 8 ++++++++ lib/node_modules/@stdlib/math/base/special/maxn/README.md | 8 ++++++++ lib/node_modules/@stdlib/math/base/special/min/README.md | 8 ++++++++ .../@stdlib/math/base/special/minabs/README.md | 8 ++++++++ .../@stdlib/math/base/special/minabsf/README.md | 8 ++++++++ .../@stdlib/math/base/special/minabsn/README.md | 8 ++++++++ lib/node_modules/@stdlib/math/base/special/minf/README.md | 8 ++++++++ .../@stdlib/math/base/special/minmax/README.md | 8 ++++++++ .../@stdlib/math/base/special/minmaxabs/README.md | 8 ++++++++ .../@stdlib/math/base/special/minmaxabsf/README.md | 8 ++++++++ .../@stdlib/math/base/special/minmaxabsn/README.md | 8 ++++++++ .../@stdlib/math/base/special/minmaxf/README.md | 8 ++++++++ .../@stdlib/math/base/special/minmaxn/README.md | 8 ++++++++ lib/node_modules/@stdlib/math/base/special/minn/README.md | 8 ++++++++ .../@stdlib/math/base/special/nanmax/README.md | 8 ++++++++ .../@stdlib/math/base/special/nanmaxf/README.md | 8 ++++++++ .../@stdlib/math/base/special/nanmin/README.md | 8 ++++++++ .../@stdlib/math/base/special/nanminf/README.md | 8 ++++++++ 22 files changed, 176 insertions(+) diff --git a/lib/node_modules/@stdlib/math/base/special/max/README.md b/lib/node_modules/@stdlib/math/base/special/max/README.md index 3ee60e667e45..ba2541106b20 100644 --- a/lib/node_modules/@stdlib/math/base/special/max/README.md +++ b/lib/node_modules/@stdlib/math/base/special/max/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +z = \max(x, y) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/maxabs/README.md b/lib/node_modules/@stdlib/math/base/special/maxabs/README.md index 8343b3f42b51..800e26962f8c 100644 --- a/lib/node_modules/@stdlib/math/base/special/maxabs/README.md +++ b/lib/node_modules/@stdlib/math/base/special/maxabs/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +z = \max(|x|, |y|) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/maxabsf/README.md b/lib/node_modules/@stdlib/math/base/special/maxabsf/README.md index faab6b5ec355..88b21acc8594 100644 --- a/lib/node_modules/@stdlib/math/base/special/maxabsf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/maxabsf/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +z = \max(|x|, |y|) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/maxabsn/README.md b/lib/node_modules/@stdlib/math/base/special/maxabsn/README.md index 5d48e2126d22..7c77f471d1a6 100644 --- a/lib/node_modules/@stdlib/math/base/special/maxabsn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/maxabsn/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +y = \max(|x_1|, |x_2|, \ldots, |x_n|) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/maxf/README.md b/lib/node_modules/@stdlib/math/base/special/maxf/README.md index 391e3490b2b4..66f66c533425 100644 --- a/lib/node_modules/@stdlib/math/base/special/maxf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/maxf/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +z = \max(x, y) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/maxn/README.md b/lib/node_modules/@stdlib/math/base/special/maxn/README.md index 6a88f1cf1e4d..109f355426a5 100644 --- a/lib/node_modules/@stdlib/math/base/special/maxn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/maxn/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +y = \max(x_1, x_2, \ldots, x_n) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/min/README.md b/lib/node_modules/@stdlib/math/base/special/min/README.md index 37477e1ac775..9e660ffca10b 100644 --- a/lib/node_modules/@stdlib/math/base/special/min/README.md +++ b/lib/node_modules/@stdlib/math/base/special/min/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +z = \min(x, y) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minabs/README.md b/lib/node_modules/@stdlib/math/base/special/minabs/README.md index da1cc1e52a9f..bd11c60195bd 100644 --- a/lib/node_modules/@stdlib/math/base/special/minabs/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minabs/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +z = \min(|x|, |y|) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minabsf/README.md b/lib/node_modules/@stdlib/math/base/special/minabsf/README.md index 6f9c83443a8c..5d6994eff7a6 100644 --- a/lib/node_modules/@stdlib/math/base/special/minabsf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minabsf/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +z = \min(|x|, |y|) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minabsn/README.md b/lib/node_modules/@stdlib/math/base/special/minabsn/README.md index 2bc318de94e7..965bec9c3f9e 100644 --- a/lib/node_modules/@stdlib/math/base/special/minabsn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minabsn/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +y = \min(|x_1|, |x_2|, \ldots, |x_n|) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minf/README.md b/lib/node_modules/@stdlib/math/base/special/minf/README.md index d5cfebad36f9..da07c5288d12 100644 --- a/lib/node_modules/@stdlib/math/base/special/minf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minf/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +z = \min(x, y) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minmax/README.md b/lib/node_modules/@stdlib/math/base/special/minmax/README.md index 223dc9075a72..60c89ffdf9c7 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmax/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minmax/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +(m, M) = (\min(x, y),\; \max(x, y)) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minmaxabs/README.md b/lib/node_modules/@stdlib/math/base/special/minmaxabs/README.md index 9e2549e01684..7be9df840b30 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmaxabs/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minmaxabs/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +(m, M) = (\min(|x|, |y|),\; \max(|x|, |y|)) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minmaxabsf/README.md b/lib/node_modules/@stdlib/math/base/special/minmaxabsf/README.md index 6df5dcb1d712..6114f3ae3f76 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmaxabsf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minmaxabsf/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +(m, M) = (\min(|x|, |y|),\; \max(|x|, |y|)) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minmaxabsn/README.md b/lib/node_modules/@stdlib/math/base/special/minmaxabsn/README.md index fc24bce6d903..98f8394858bc 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmaxabsn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minmaxabsn/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +(m, M) = (\min(|x_1|, \ldots, |x_n|),\; \max(|x_1|, \ldots, |x_n|)) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minmaxf/README.md b/lib/node_modules/@stdlib/math/base/special/minmaxf/README.md index 95ceaa4cc4c6..d25023158c01 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmaxf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minmaxf/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +(m, M) = (\min(x, y),\; \max(x, y)) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minmaxn/README.md b/lib/node_modules/@stdlib/math/base/special/minmaxn/README.md index c8c5884e18c4..5eb43b3432e8 100644 --- a/lib/node_modules/@stdlib/math/base/special/minmaxn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minmaxn/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +(m, M) = (\min(x_1, \ldots, x_n),\; \max(x_1, \ldots, x_n)) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/minn/README.md b/lib/node_modules/@stdlib/math/base/special/minn/README.md index 459d61d55fe3..fd7f755ca686 100644 --- a/lib/node_modules/@stdlib/math/base/special/minn/README.md +++ b/lib/node_modules/@stdlib/math/base/special/minn/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +y = \min(x_1, x_2, \ldots, x_n) +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/nanmax/README.md b/lib/node_modules/@stdlib/math/base/special/nanmax/README.md index 41c1a950f029..a8242f5f5b36 100644 --- a/lib/node_modules/@stdlib/math/base/special/nanmax/README.md +++ b/lib/node_modules/@stdlib/math/base/special/nanmax/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +\mathop{\mathrm{nanmax}}(x, y) = \begin{cases} y & \textrm{if}\ x = \text{NaN} \\ x & \textrm{if}\ y = \text{NaN} \\ \max(x, y) & \textrm{otherwise} \end{cases} +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/nanmaxf/README.md b/lib/node_modules/@stdlib/math/base/special/nanmaxf/README.md index 397361808858..a5c2af782e16 100644 --- a/lib/node_modules/@stdlib/math/base/special/nanmaxf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/nanmaxf/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +\mathop{\mathrm{nanmax}}(x, y) = \begin{cases} y & \textrm{if}\ x = \text{NaN} \\ x & \textrm{if}\ y = \text{NaN} \\ \max(x, y) & \textrm{otherwise} \end{cases} +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/nanmin/README.md b/lib/node_modules/@stdlib/math/base/special/nanmin/README.md index 622860ba2411..1e4177188ece 100644 --- a/lib/node_modules/@stdlib/math/base/special/nanmin/README.md +++ b/lib/node_modules/@stdlib/math/base/special/nanmin/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +\mathop{\mathrm{nanmin}}(x, y) = \begin{cases} y & \textrm{if}\ x = \text{NaN} \\ x & \textrm{if}\ y = \text{NaN} \\ \min(x, y) & \textrm{otherwise} \end{cases} +``` + + +
diff --git a/lib/node_modules/@stdlib/math/base/special/nanminf/README.md b/lib/node_modules/@stdlib/math/base/special/nanminf/README.md index a1a3b8153200..3328f5d6646a 100644 --- a/lib/node_modules/@stdlib/math/base/special/nanminf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/nanminf/README.md @@ -26,6 +26,14 @@ limitations under the License.
+ + +```math +\mathop{\mathrm{nanmin}}(x, y) = \begin{cases} y & \textrm{if}\ x = \text{NaN} \\ x & \textrm{if}\ y = \text{NaN} \\ \min(x, y) & \textrm{otherwise} \end{cases} +``` + + +