From de399203f20433cbaae6689e53beb130fe5a4771 Mon Sep 17 00:00:00 2001 From: Karan Anand Date: Thu, 27 Aug 2026 10:14:26 +0530 Subject: [PATCH] docs: add equations to rounding function READMEs Add defining equations to the intro sections of ceil, floor, round, trunc and their power-of-2, power-of-10, base-b, decimal-place, and significant-figures variants. Includes piecewise formulas for ceil2/ceil10/floor2/floor10 to correctly handle negative inputs. Ref: https://github.com/stdlib-js/metr-issue-tracker/issues/1257 --- .../@stdlib/math/base/special/ceil/README.md | 18 ++++++++++++++++++ .../@stdlib/math/base/special/ceil10/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/ceil2/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/ceilb/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/ceilf/README.md | 18 ++++++++++++++++++ .../@stdlib/math/base/special/ceiln/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/ceilsd/README.md | 18 ++++++++++++++++++ .../@stdlib/math/base/special/floor/README.md | 18 ++++++++++++++++++ .../math/base/special/floor10/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/floor2/README.md | 14 ++++++++++++++ .../math/base/special/floor2f/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/floorb/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/floorf/README.md | 18 ++++++++++++++++++ .../@stdlib/math/base/special/floorn/README.md | 14 ++++++++++++++ .../math/base/special/floornf/README.md | 14 ++++++++++++++ .../math/base/special/floorsd/README.md | 18 ++++++++++++++++++ .../base/special/round-nearest-even/README.md | 6 ++++++ .../@stdlib/math/base/special/round/README.md | 14 ++++++++++++++ .../math/base/special/round10/README.md | 6 ++++++ .../math/base/special/round10f/README.md | 6 ++++++ .../@stdlib/math/base/special/round2/README.md | 6 ++++++ .../@stdlib/math/base/special/roundb/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/roundf/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/roundn/README.md | 14 ++++++++++++++ .../math/base/special/roundnf/README.md | 14 ++++++++++++++ .../math/base/special/roundsd/README.md | 18 ++++++++++++++++++ .../@stdlib/math/base/special/trunc/README.md | 18 ++++++++++++++++++ .../math/base/special/trunc10/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/trunc2/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/truncb/README.md | 14 ++++++++++++++ .../@stdlib/math/base/special/truncf/README.md | 18 ++++++++++++++++++ .../@stdlib/math/base/special/truncn/README.md | 14 ++++++++++++++ .../math/base/special/truncsd/README.md | 18 ++++++++++++++++++ 33 files changed, 470 insertions(+) diff --git a/lib/node_modules/@stdlib/math/base/special/ceil/README.md b/lib/node_modules/@stdlib/math/base/special/ceil/README.md index 3efaa939ac4e..7edcfed83cbf 100644 --- a/lib/node_modules/@stdlib/math/base/special/ceil/README.md +++ b/lib/node_modules/@stdlib/math/base/special/ceil/README.md @@ -22,6 +22,22 @@ limitations under the License. > Round a double-precision floating-point number toward positive infinity. +
+ +The [ceiling function][ceiling-function] is defined as + + + +```math +y = \lceil x \rceil = \min\{ n \in \mathbb{Z} : n \geq x \} +``` + + + +
+ + +
## Usage @@ -180,6 +196,8 @@ int main( void ) {