Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/abs2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ limitations under the License.

<section class="intro">

The squared [absolute value][absolute-value] is defined as

<!-- <equation class="equation" label="eq:squared_absolute_value" align="center" raw="y = |x|^2 = x^2" alt="Squared absolute value"> -->

```math
y = |x|^2 = x^2
```

<!-- </equation> -->

</section>

<!-- /.intro -->
Expand Down
10 changes: 10 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/abs2f/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ limitations under the License.

<section class="intro">

The squared [absolute value][absolute-value] is defined as

<!-- <equation class="equation" label="eq:squared_absolute_value" align="center" raw="y = |x|^2 = x^2" alt="Squared absolute value"> -->

```math
y = |x|^2 = x^2
```

<!-- </equation> -->

</section>

<!-- /.intro -->
Expand Down
16 changes: 16 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/cbrt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ limitations under the License.

> Compute the [cube root][cube-root] of a double-precision floating-point number.

<section class="intro">

The [cube root][cube-root] function is defined as

<!-- <equation class="equation" label="eq:cube_root" align="center" raw="y = \sqrt[3]{x}" alt="Cube root function"> -->

```math
y = \sqrt[3]{x}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

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

> Compute the [cube root][cube-root] of a single-precision floating-point number.

<section class="intro">

The [cube root][cube-root] function is defined as

<!-- <equation class="equation" label="eq:cube_root" align="center" raw="y = \sqrt[3]{x}" alt="Cube root function"> -->

```math
y = \sqrt[3]{x}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
10 changes: 10 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/clamp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ limitations under the License.

<section class="intro">

The clamp function restricts a value to a specified range `[min, max]`

<!-- <equation class="equation" label="eq:clamp_function" align="center" raw="y = \operatorname{clamp}(x, a, b) = \begin{cases} a & \textrm{if}\ x < a \\ x & \textrm{if}\ a \leq x \leq b \\ b & \textrm{if}\ x > b \end{cases}" alt="Clamp function"> -->

```math
y = \mathop{\mathrm{clamp}}(x, a, b) = \begin{cases} a & \textrm{if}\ x < a \\ x & \textrm{if}\ a \leq x \leq b \\ b & \textrm{if}\ x > b \end{cases}
```

<!-- </equation> -->

</section>

<!-- /.intro -->
Expand Down
10 changes: 10 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/clampf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ limitations under the License.

<section class="intro">

The clamp function restricts a value to a specified range `[min, max]`

<!-- <equation class="equation" label="eq:clamp_function" align="center" raw="y = \operatorname{clamp}(x, a, b) = \begin{cases} a & \textrm{if}\ x < a \\ x & \textrm{if}\ a \leq x \leq b \\ b & \textrm{if}\ x > b \end{cases}" alt="Clamp function"> -->

```math
y = \mathop{\mathrm{clamp}}(x, a, b) = \begin{cases} a & \textrm{if}\ x < a \\ x & \textrm{if}\ a \leq x \leq b \\ b & \textrm{if}\ x > b \end{cases}
```

<!-- </equation> -->

</section>

<!-- /.intro -->
Expand Down
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/copysign/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Return a [double-precision floating-point number][ieee754] with the magnitude of `x` and the sign of `y`.

<section class="intro">

<!-- <equation class="equation" label="eq:copysign_function" align="center" raw="z = |x| \cdot \operatorname{sign}(y)" alt="Copy sign function"> -->

```math
z = |x| \cdot \mathop{\mathrm{sign}}(y)
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

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

> Return a [single-precision floating-point number][ieee754] with the magnitude of `x` and the sign of `y`.

<section class="intro">

<!-- <equation class="equation" label="eq:copysign_function" align="center" raw="z = |x| \cdot \operatorname{sign}(y)" alt="Copy sign function"> -->

```math
z = |x| \cdot \mathop{\mathrm{sign}}(y)
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

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

> Convert an angle from degrees to radians.

<section class="intro">

<!-- <equation class="equation" label="eq:deg2rad" align="center" raw="r = x \cdot \frac{\pi}{180}" alt="Degrees to radians conversion"> -->

```math
r = x \cdot \frac{\pi}{180}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

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

> Convert an angle from degrees to radians (single-precision).

<section class="intro">

<!-- <equation class="equation" label="eq:deg2rad" align="center" raw="r = x \cdot \frac{\pi}{180}" alt="Degrees to radians conversion"> -->

```math
r = x \cdot \frac{\pi}{180}
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

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

> Return a [double-precision floating-point number][ieee754] with the magnitude of `x` and the sign of `x*y`.

<section class="intro">

<!-- <equation class="equation" label="eq:flipsign_function" align="center" raw="z = x \cdot \operatorname{sign}(y)" alt="Flip sign function"> -->

```math
z = x \cdot \mathop{\mathrm{sign}}(y)
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

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

> Return a [single-precision floating-point number][ieee754] with the magnitude of `x` and the sign of `x*y`.

<section class="intro">

<!-- <equation class="equation" label="eq:flipsign_function" align="center" raw="z = x \cdot \operatorname{sign}(y)" alt="Flip sign function"> -->

```math
z = x \cdot \mathop{\mathrm{sign}}(y)
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

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

> Split a [double-precision floating-point number][ieee754] into a normalized fraction and an integer power of two.

<section class="intro">

The function splits a floating-point number into a normalized fraction and an integer power of two

<!-- <equation class="equation" label="eq:frexp_function" align="center" raw="x = f \cdot 2^{\,e}" alt="Fraction and exponent decomposition"> -->

```math
x = f \cdot 2^{\,e}
```

<!-- </equation> -->

where `f` is the normalized fraction (with `0.5 <= |f| < 1`) and `e` is an integer exponent.

</section>

<!-- /.intro -->

<section class="usage">

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

> Split a [single-precision floating-point number][ieee754] into a normalized fraction and an integer power of two.

<section class="intro">

The function splits a floating-point number into a normalized fraction and an integer power of two

<!-- <equation class="equation" label="eq:frexp_function" align="center" raw="x = f \cdot 2^{\,e}" alt="Fraction and exponent decomposition"> -->

```math
x = f \cdot 2^{\,e}
```

<!-- </equation> -->

where `f` is the normalized fraction (with `0.5 <= |f| < 1`) and `e` is an integer exponent.

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand Down
10 changes: 10 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/hypot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ limitations under the License.

<section class="intro">

The [hypotenuse][hypotenuse] function computes the length of the hypotenuse of a right triangle

<!-- <equation class="equation" label="eq:hypotenuse" align="center" raw="h = \sqrt{x^2 + y^2}" alt="Hypotenuse function"> -->

```math
h = \sqrt{x^2 + y^2}
```

<!-- </equation> -->

</section>

<!-- /.intro -->
Expand Down
10 changes: 10 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/hypotf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ limitations under the License.

<section class="intro">

The [hypotenuse][hypotenuse] function computes the length of the hypotenuse of a right triangle

<!-- <equation class="equation" label="eq:hypotenuse" align="center" raw="h = \sqrt{x^2 + y^2}" alt="Hypotenuse function"> -->

```math
h = \sqrt{x^2 + y^2}
```

<!-- </equation> -->

</section>

<!-- /.intro -->
Expand Down
18 changes: 16 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/ldexp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Multiply a [double-precision floating-point number][ieee754] by an integer power of two.

<section class="intro">

<!-- <equation class="equation" label="eq:ldexp_function" align="center" raw="y = x \cdot 2^n" alt="Load exponent function"> -->

```math
y = x \cdot 2^n
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand All @@ -35,10 +49,10 @@ var ldexp = require( '@stdlib/math/base/special/ldexp' );
Multiplies a [double-precision floating-point number][ieee754] by an `integer` power of two (i.e., `x = frac * 2^exp`).

```javascript
var x = ldexp( 0.5, 3 ); // => 0.5 * 2^3 = 0.5 * 8
var x = ldexp( 0.5, 3 );
// returns 4.0

x = ldexp( 4.0, -2 ); // => 4 * 2^(-2) = 4 * (1/4)
x = ldexp( 4.0, -2 );
// returns 1.0
```

Expand Down
18 changes: 16 additions & 2 deletions lib/node_modules/@stdlib/math/base/special/ldexpf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ limitations under the License.

> Multiply a [single-precision floating-point number][ieee754] by an integer power of two.

<section class="intro">

<!-- <equation class="equation" label="eq:ldexp_function" align="center" raw="y = x \cdot 2^n" alt="Load exponent function"> -->

```math
y = x \cdot 2^n
```

<!-- </equation> -->

</section>

<!-- /.intro -->

<section class="usage">

## Usage
Expand All @@ -35,10 +49,10 @@ var ldexpf = require( '@stdlib/math/base/special/ldexpf' );
Multiplies a [single-precision floating-point number][ieee754] by an integer power of two (i.e., `x = frac * 2^exp`).

```javascript
var x = ldexpf( 0.5, 3 ); // => 0.5 * 2^3 = 0.5 * 8
var x = ldexpf( 0.5, 3 );
// returns 4.0

x = ldexpf( 4.0, -2 ); // => 4 * 2^(-2) = 4 * (1/4)
x = ldexpf( 4.0, -2 );
// returns 1.0
```

Expand Down
Loading