From d6252a1620d192e753440588ea66156bf6198728 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Thu, 27 Aug 2026 10:06:36 +0530 Subject: [PATCH 1/4] docs: add equations to combined and pi-scaled function READMEs Add defining equations to the intro sections of sincos, sincosd, sincospi, sinpi, cospi, atan2, cosm1 and their single-precision variants. Includes range constraints for atan2. Ref: https://github.com/stdlib-js/metr-issue-tracker/issues/1257 --- .../@stdlib/math/base/special/atan2/README.md | 18 +++++++++++++++++ .../math/base/special/atan2d/README.md | 18 +++++++++++++++++ .../math/base/special/atan2f/README.md | 18 +++++++++++++++++ .../@stdlib/math/base/special/cosm1/README.md | 16 +++++++++++++++ .../math/base/special/cosm1f/README.md | 16 +++++++++++++++ .../@stdlib/math/base/special/cospi/README.md | 18 +++++++++++++++++ .../math/base/special/cospif/README.md | 18 +++++++++++++++++ .../math/base/special/sincos/README.md | 20 +++++++++++++++++++ .../math/base/special/sincosd/README.md | 18 +++++++++++++++++ .../math/base/special/sincosdf/README.md | 18 +++++++++++++++++ .../math/base/special/sincosf/README.md | 20 +++++++++++++++++++ .../math/base/special/sincospi/README.md | 20 +++++++++++++++++++ .../math/base/special/sincospif/README.md | 20 +++++++++++++++++++ .../@stdlib/math/base/special/sinpi/README.md | 18 +++++++++++++++++ .../math/base/special/sinpif/README.md | 18 +++++++++++++++++ 15 files changed, 274 insertions(+) diff --git a/lib/node_modules/@stdlib/math/base/special/atan2/README.md b/lib/node_modules/@stdlib/math/base/special/atan2/README.md index ae83ba4074a4..66802940b5cc 100755 --- a/lib/node_modules/@stdlib/math/base/special/atan2/README.md +++ b/lib/node_modules/@stdlib/math/base/special/atan2/README.md @@ -22,6 +22,22 @@ limitations under the License. > Compute the angle in the plane (in radians) between the positive x-axis and the ray from `(0,0)` to the point `(x,y)`. +
+ +The two-argument [arctangent][arctangent] function is defined as + + + +```math +\theta = \mathop{\mathrm{atan2}}(y, x), \quad \theta \in (-\pi, \pi] +``` + + + +
+ + +
## Usage @@ -197,6 +213,8 @@ int main( void ) {