Skip to content

docs: add equations #14689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Aug 27, 2026
Merged

docs: add equations #14689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/ceil/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ limitations under the License.

> Round a double-precision floating-point number toward positive infinity.

<section class="intro">

The [ceiling function][ceiling-function] is defined as

<!-- <equation class="equation" label="eq:ceiling_function" align="center" raw="y = \lceil x \rceil = \min\{ n \in \mathbb{Z} : n \geq x \}" alt="Ceiling function"> -->

```math
y = \lceil x \rceil = \min\{ n \in \mathbb{Z} : n \geq x \}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down Expand Up @@ -180,6 +196,8 @@ int main( void ) {

<section class="links">

[ceiling-function]: https://en.wikipedia.org/wiki/Floor_and_ceiling_functions

<!-- <related-links> -->

[@stdlib/math/base/special/ceiln]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ceiln
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/ceil10/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a numeric value to the nearest power of 10 toward positive infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:ceil10_function" align="center" raw="y = \begin{cases} 10^{\lceil \log_{10} x \rceil} & \textrm{if}\ x > 0 \\ -10^{\lfloor \log_{10} |x| \rfloor} & \textrm{if}\ x < 0 \end{cases}" alt="Round up to nearest power of ten"> -->

```math
y = \begin{cases} 10^{\lceil \log_{10} x \rceil} & \textrm{if}\ x > 0 \\ -10^{\lfloor \log_{10} |x| \rfloor} & \textrm{if}\ x < 0 \end{cases}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/ceil2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a numeric value to the nearest power of two toward positive infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:ceil2_function" align="center" raw="y = \begin{cases} 2^{\lceil \log_2 x \rceil} & \textrm{if}\ x > 0 \\ -2^{\lfloor \log_2 |x| \rfloor} & \textrm{if}\ x < 0 \end{cases}" alt="Round up to nearest power of two"> -->

```math
y = \begin{cases} 2^{\lceil \log_2 x \rceil} & \textrm{if}\ x > 0 \\ -2^{\lfloor \log_2 |x| \rfloor} & \textrm{if}\ x < 0 \end{cases}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/ceilb/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a numeric value to the nearest multiple of b^n toward positive infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:ceilb_function" align="center" raw="y = \left\lceil \frac{x}{b^n} \right\rceil \cdot b^n" alt="Round up to nearest multiple of b^n"> -->

```math
y = \left\lceil \frac{x}{b^n} \right\rceil \cdot b^n
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/ceilf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ limitations under the License.

> Round a single-precision floating-point number toward positive infinity.

<section class="intro">

The [ceiling function][ceiling-function] is defined as

<!-- <equation class="equation" label="eq:ceiling_function" align="center" raw="y = \lceil x \rceil = \min\{ n \in \mathbb{Z} : n \geq x \}" alt="Ceiling function"> -->

```math
y = \lceil x \rceil = \min\{ n \in \mathbb{Z} : n \geq x \}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down Expand Up @@ -178,6 +194,8 @@ int main( void ) {

<section class="links">

[ceiling-function]: https://en.wikipedia.org/wiki/Floor_and_ceiling_functions

<!-- <related-links> -->

[@stdlib/math/base/special/floorf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/floorf
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/ceiln/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a numeric value to the nearest multiple of 10^n toward positive infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:ceiln_function" align="center" raw="y = \left\lceil \frac{x}{10^n} \right\rceil \cdot 10^n" alt="Round up to n decimal places"> -->

```math
y = \left\lceil \frac{x}{10^n} \right\rceil \cdot 10^n
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/ceilsd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ limitations under the License.

> Round a numeric value to the nearest number toward positive infinity with N significant figures.

<section class="intro">

The function rounds a numeric value to the specified number of [significant figures][significant-figures] toward positive infinity

<!-- <equation class="equation" label="eq:ceilsd_function" align="center" raw="y = \left\lceil x \cdot b^{n - \lfloor \log_b |x| \rfloor - 1} \right\rceil \cdot b^{\lfloor \log_b |x| \rfloor - n + 1}" alt="Round up to n significant figures"> -->

```math
y = \left\lceil x \cdot b^{n - \lfloor \log_b |x| \rfloor - 1} \right\rceil \cdot b^{\lfloor \log_b |x| \rfloor - n + 1}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down Expand Up @@ -192,6 +208,8 @@ int main( void ) {

<section class="links">

[significant-figures]: https://en.wikipedia.org/wiki/Significant_figures

<!-- <related-links> -->

[@stdlib/math/base/special/ceil]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ceil
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/floor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ limitations under the License.

> Round a double-precision floating-point number toward negative infinity.

<section class="intro">

The [floor function][floor-function] is defined as

<!-- <equation class="equation" label="eq:floor_function" align="center" raw="y = \lfloor x \rfloor = \max\{ n \in \mathbb{Z} : n \leq x \}" alt="Floor function"> -->

```math
y = \lfloor x \rfloor = \max\{ n \in \mathbb{Z} : n \leq x \}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down Expand Up @@ -179,6 +195,8 @@ int main( void ) {

<section class="links">

[floor-function]: https://en.wikipedia.org/wiki/Floor_and_ceiling_functions

<!-- <related-links> -->

[@stdlib/math/base/special/ceil]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ceil
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/floor10/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a numeric value to the nearest power of 10 toward negative infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:floor10_function" align="center" raw="y = \begin{cases} 10^{\lfloor \log_{10} x \rfloor} & \textrm{if}\ x > 0 \\ -10^{\lceil \log_{10} |x| \rceil} & \textrm{if}\ x < 0 \end{cases}" alt="Round down to nearest power of ten"> -->

```math
y = \begin{cases} 10^{\lfloor \log_{10} x \rfloor} & \textrm{if}\ x > 0 \\ -10^{\lceil \log_{10} |x| \rceil} & \textrm{if}\ x < 0 \end{cases}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/floor2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a numeric value to the nearest power of two toward negative infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:floor2_function" align="center" raw="y = \begin{cases} 2^{\lfloor \log_2 x \rfloor} & \textrm{if}\ x > 0 \\ -2^{\lceil \log_2 |x| \rceil} & \textrm{if}\ x < 0 \end{cases}" alt="Round down to nearest power of two"> -->

```math
y = \begin{cases} 2^{\lfloor \log_2 x \rfloor} & \textrm{if}\ x > 0 \\ -2^{\lceil \log_2 |x| \rceil} & \textrm{if}\ x < 0 \end{cases}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/floor2f/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a single-precision floating-point number to the nearest power of two toward negative infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:floor2_function" align="center" raw="y = \begin{cases} 2^{\lfloor \log_2 x \rfloor} & \textrm{if}\ x > 0 \\ -2^{\lceil \log_2 |x| \rceil} & \textrm{if}\ x < 0 \end{cases}" alt="Round down to nearest power of two"> -->

```math
y = \begin{cases} 2^{\lfloor \log_2 x \rfloor} & \textrm{if}\ x > 0 \\ -2^{\lceil \log_2 |x| \rceil} & \textrm{if}\ x < 0 \end{cases}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/floorb/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a numeric value to the nearest multiple of b^n toward negative infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:floorb_function" align="center" raw="y = \left\lfloor \frac{x}{b^n} \right\rfloor \cdot b^n" alt="Round down to nearest multiple of b^n"> -->

```math
y = \left\lfloor \frac{x}{b^n} \right\rfloor \cdot b^n
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/floorf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ limitations under the License.

> Round a single-precision floating-point numeric value toward negative infinity.

<section class="intro">

The [floor function][floor-function] is defined as

<!-- <equation class="equation" label="eq:floor_function" align="center" raw="y = \lfloor x \rfloor = \max\{ n \in \mathbb{Z} : n \leq x \}" alt="Floor function"> -->

```math
y = \lfloor x \rfloor = \max\{ n \in \mathbb{Z} : n \leq x \}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down Expand Up @@ -179,6 +195,8 @@ int main( void ) {

<section class="links">

[floor-function]: https://en.wikipedia.org/wiki/Floor_and_ceiling_functions

<!-- <related-links> -->

[@stdlib/math/base/special/ceilf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ceilf
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/floorn/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a double-precision floating-point number to the nearest multiple of 10^n toward negative infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:floorn_function" align="center" raw="y = \left\lfloor \frac{x}{10^n} \right\rfloor \cdot 10^n" alt="Round down to n decimal places"> -->

```math
y = \left\lfloor \frac{x}{10^n} \right\rfloor \cdot 10^n
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/floornf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Round a single-precision floating-point number to the nearest multiple of 10^n toward negative infinity.

<section class="intro">

<!-- <equation class="equation" label="eq:floorn_function" align="center" raw="y = \left\lfloor \frac{x}{10^n} \right\rfloor \cdot 10^n" alt="Round down to n decimal places"> -->

```math
y = \left\lfloor \frac{x}{10^n} \right\rfloor \cdot 10^n
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
Loading