From a45b98af976c94b100d0f46545f561228c14e4f5 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Thu, 27 Aug 2026 11:27:34 +0530 Subject: [PATCH] docs: add introductory text to kernel function READMEs Add descriptive introductory text to the intro sections of kernel-cos, kernel-sin, kernel-tan, kernel-sincos, kernel-log1p, kernel-betainc, kernel-betaincinv and their single-precision variants. Kernel functions receive prose descriptions noting their valid input range rather than standalone equations. Ref: https://github.com/stdlib-js/metr-issue-tracker/issues/1257 --- .../@stdlib/math/base/special/kernel-betainc/README.md | 2 ++ .../@stdlib/math/base/special/kernel-betaincinv/README.md | 2 ++ .../@stdlib/math/base/special/kernel-cos/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-cosf/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-log1p/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-log1pf/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-sin/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-sincos/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-sincosf/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-sinf/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-tan/README.md | 8 ++++++++ .../@stdlib/math/base/special/kernel-tanf/README.md | 8 ++++++++ 12 files changed, 84 insertions(+) diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-betainc/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-betainc/README.md index bda4fc8b66a3..72c8bdc6fc7a 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-betainc/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-betainc/README.md @@ -24,6 +24,8 @@ limitations under the License.
+The function evaluates the regularized [incomplete beta function][incomplete-beta-function] and its first derivative. This is a kernel function used internally by higher-level beta function implementations. +
diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-betaincinv/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-betaincinv/README.md index 0adc87bb4937..e930cb19e737 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-betaincinv/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-betaincinv/README.md @@ -24,6 +24,8 @@ limitations under the License.
+The function computes the inverse of the lower regularized [incomplete beta function][incomplete-beta-function]. This is a kernel function used internally by higher-level inverse beta function implementations. +
diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-cos/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-cos/README.md index cab6617a043d..e10e5c64058d 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-cos/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-cos/README.md @@ -22,6 +22,14 @@ limitations under the License. > Compute the [cosine][cosine] of a double-precision floating-point number on `[-π/4, π/4]`. +
+ +The function computes the [cosine][cosine] of a double-precision floating-point number on the interval `[-π/4, π/4]`. For arguments outside this range, use argument reduction before calling this kernel. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-cosf/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-cosf/README.md index a6e63612404d..108962431404 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-cosf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-cosf/README.md @@ -22,6 +22,14 @@ limitations under the License. > Compute the [cosine][cosine] of a number on `[-π/4, π/4]` in single-precision floating-point format. +
+ +The function computes the [cosine][cosine] of a single-precision floating-point number on the interval `[-π/4, π/4]`. For arguments outside this range, use argument reduction before calling this kernel. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md index 873f3d6a2072..63e951d08a3e 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md @@ -22,6 +22,14 @@ limitations under the License. > Evaluate a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`. +
+ +The function evaluates a polynomial correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`. This is a kernel function used internally by logarithm implementations. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-log1pf/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-log1pf/README.md index 131d48aa4401..d1ab9c50ff9b 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-log1pf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-log1pf/README.md @@ -22,6 +22,14 @@ limitations under the License. > Evaluate a correction term for single-precision base-2 and base-10 logarithms when `1 + f` is in `[√2/2, √2]`. +
+ +The function evaluates a polynomial correction term for single-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`. This is a kernel function used internally by logarithm implementations. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-sin/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-sin/README.md index 1fcbcef25f46..83eb5dafd2e4 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-sin/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-sin/README.md @@ -22,6 +22,14 @@ limitations under the License. > Compute the [sine][sine] of a double-precision floating-point number on `[-π/4, π/4]`. +
+ +The function computes the [sine][sine] of a double-precision floating-point number on the interval `[-π/4, π/4]`. For arguments outside this range, use argument reduction before calling this kernel. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-sincos/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-sincos/README.md index b7544001aad7..d4397c11d7b3 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-sincos/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-sincos/README.md @@ -22,6 +22,14 @@ limitations under the License. > Simultaneously compute the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of an angle measured in radians on the interval `[-π/4, π/4]`. +
+ +The function simultaneously computes the sine and cosine of a double-precision floating-point number on the interval `[-π/4, π/4]`. For arguments outside this range, use argument reduction before calling this kernel. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-sincosf/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-sincosf/README.md index a6dcccd7d1f6..2ffe7ffa12ce 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-sincosf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-sincosf/README.md @@ -22,6 +22,14 @@ limitations under the License. > Simultaneously compute the [sine][@stdlib/math/base/special/sinf] and [cosine][@stdlib/math/base/special/cosf] of an angle measured in radians on `[-π/4, π/4]` in single-precision floating-point format. +
+ +The function simultaneously computes the sine and cosine of a single-precision floating-point number on the interval `[-π/4, π/4]`. For arguments outside this range, use argument reduction before calling this kernel. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-sinf/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-sinf/README.md index 125fd96388a3..891076cd80c8 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-sinf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-sinf/README.md @@ -22,6 +22,14 @@ limitations under the License. > Compute the [sine][sine] of a number on `[-π/4, π/4]` in single-precision floating-point format. +
+ +The function computes the [sine][sine] of a single-precision floating-point number on the interval `[-π/4, π/4]`. For arguments outside this range, use argument reduction before calling this kernel. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-tan/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-tan/README.md index b1eeb84c1c04..dd02f87d8b6c 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-tan/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-tan/README.md @@ -22,6 +22,14 @@ limitations under the License. > Compute the [tangent][tangent] of a double-precision floating-point number on `[-π/4, π/4]`. +
+ +The function computes the [tangent][tangent] of a double-precision floating-point number on the interval `[-π/4, π/4]`. For arguments outside this range, use argument reduction before calling this kernel. + +
+ + +
## Usage diff --git a/lib/node_modules/@stdlib/math/base/special/kernel-tanf/README.md b/lib/node_modules/@stdlib/math/base/special/kernel-tanf/README.md index 6f9150f9f0f3..b02cb0a710e2 100644 --- a/lib/node_modules/@stdlib/math/base/special/kernel-tanf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/kernel-tanf/README.md @@ -22,6 +22,14 @@ limitations under the License. > Compute the [tangent][tangent] of a number on `[-π/4, π/4]` in single-precision floating-point format. +
+ +The function computes the [tangent][tangent] of a single-precision floating-point number on the interval `[-π/4, π/4]`. For arguments outside this range, use argument reduction before calling this kernel. + +
+ + +
## Usage