Skip to content

Commit

Permalink
docs: update related packages sections
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Dec 20, 2024
1 parent 3c0ff2c commit 21b463e
Show file tree
Hide file tree
Showing 10 changed files with 86 additions and 6 deletions.
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/array/base/fliplr5d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,14 @@ console.log( y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/base/fliplr2d`][@stdlib/array/base/fliplr2d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a two-dimensional nested input array.</span>
- <span class="package-name">[`@stdlib/array/base/fliplr3d`][@stdlib/array/base/fliplr3d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a three-dimensional nested input array.</span>
- <span class="package-name">[`@stdlib/array/base/fliplr4d`][@stdlib/array/base/fliplr4d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a four-dimensional nested input array.</span>

</section>

<!-- /.related -->
Expand All @@ -105,6 +113,16 @@ console.log( y );

<section class="links">

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

[@stdlib/array/base/fliplr2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr2d

[@stdlib/array/base/fliplr3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr3d

[@stdlib/array/base/fliplr4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr4d

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

</section>

<!-- /.links -->
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/ext/base/gapx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ console.log( x );

## See Also

- <span class="package-name">[`@stdlib/blas/ext/base/dapx`][@stdlib/blas/ext/base/dapx]</span><span class="delimiter">: </span><span class="description">add a constant to each element in a double-precision floating-point strided array.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/dapx`][@stdlib/blas/ext/base/dapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision floating-point strided array.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/sapx`][@stdlib/blas/ext/base/sapx]</span><span class="delimiter">: </span><span class="description">add a constant to each element in a single-precision floating-point strided array.</span>

</section>
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,9 @@ console.log( v );

## See Also

- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumkbn2`][@stdlib/blas/ext/base/dapxsumkbn2]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn2`][@stdlib/blas/ext/base/gapxsumkbn2]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsum`][@stdlib/blas/ext/base/sapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each single-precision floating-point strided array element and computes the sum.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumkbn2`][@stdlib/blas/ext/base/dapxsumkbn2]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn2`][@stdlib/blas/ext/base/gapxsumkbn2]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsum`][@stdlib/blas/ext/base/sapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/ssumkbn2`][@stdlib/blas/ext/base/ssumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm.</span>

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,6 @@ Macro for the square root of the mathematical constant [π][@stdlib/constants/fl

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

[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi

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

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ Macro for the high word mask for the exponent of a [double-precision floating-po
## See Also

- <span class="package-name">[`@stdlib/constants/float64/high-word-significand-mask`][@stdlib/constants/float64/high-word-significand-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the significand of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/constants/float64/high-word-sign-mask`][@stdlib/constants/float64/high-word-sign-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the sign bit of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/constants/float64/high-word-abs-mask`][@stdlib/constants/float64/high-word-abs-mask]</span><span class="delimiter">: </span><span class="description">high word mask for excluding the sign bit of a double-precision floating-point number.</span>

</section>

Expand All @@ -165,6 +167,10 @@ Macro for the high word mask for the exponent of a [double-precision floating-po

[@stdlib/constants/float64/high-word-significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-significand-mask

[@stdlib/constants/float64/high-word-sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-sign-mask

[@stdlib/constants/float64/high-word-abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-abs-mask

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

</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,14 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/assert/is-negative-finite`][@stdlib/math/base/assert/is-negative-finite]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is a negative finite number.</span>
- <span class="package-name">[`@stdlib/math/base/assert/is-nonnegative-finite`][@stdlib/math/base/assert/is-nonnegative-finite]</span><span class="delimiter">: </span><span class="description">test if a numeric value is a nonnegative finite number.</span>
- <span class="package-name">[`@stdlib/math/base/assert/is-nonpositive-finite`][@stdlib/math/base/assert/is-nonpositive-finite]</span><span class="delimiter">: </span><span class="description">test if a numeric value is a nonpositive finite number.</span>

</section>

<!-- /.related -->
Expand All @@ -186,6 +194,12 @@ int main( void ) {

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

[@stdlib/math/base/assert/is-negative-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-negative-finite

[@stdlib/math/base/assert/is-nonnegative-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-nonnegative-finite

[@stdlib/math/base/assert/is-nonpositive-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-nonpositive-finite

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

</section>
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/minn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ for ( i = 0; i < 100; i++ ) {

- <span class="package-name">[`@stdlib/math/base/special/maxn`][@stdlib/math/base/special/maxn]</span><span class="delimiter">: </span><span class="description">return the maximum value.</span>
- <span class="package-name">[`@stdlib/math/base/special/min`][@stdlib/math/base/special/min]</span><span class="delimiter">: </span><span class="description">return the minimum value.</span>
- <span class="package-name">[`@stdlib/math/base/special/minabsn`][@stdlib/math/base/special/minabsn]</span><span class="delimiter">: </span><span class="description">return the minimum absolute value.</span>

</section>

Expand All @@ -150,6 +151,8 @@ for ( i = 0; i < 100; i++ ) {

[@stdlib/math/base/special/min]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/min

[@stdlib/math/base/special/minabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabsn

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

</section>
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/math/strided/special/atan-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,12 @@ console.log( y );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/strided/special/atanh-by`][@stdlib/math/strided/special/atanh-by]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arctangent of each element retrieved from an input strided array via a callback function.</span>

</section>

<!-- /.related -->
Expand All @@ -243,6 +249,12 @@ console.log( y );

[@stdlib/math/base/special/atan]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atan

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

[@stdlib/math/strided/special/atanh-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/atanh-by

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

</section>

<!-- /.links -->
17 changes: 17 additions & 0 deletions lib/node_modules/@stdlib/ndarray/reject/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,15 @@ console.log( ndarray2array( y ) );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/ndarray/filter`][@stdlib/ndarray/filter]</span><span class="delimiter">: </span><span class="description">return a shallow copy of an ndarray containing only those elements which pass a test implemented by a predicate function.</span>
- <span class="package-name">[`@stdlib/ndarray/filter-map`][@stdlib/ndarray/filter-map]</span><span class="delimiter">: </span><span class="description">filter and map elements in an input ndarray to elements in a new output ndarray according to a callback function.</span>
- <span class="package-name">[`@stdlib/ndarray/map`][@stdlib/ndarray/map]</span><span class="delimiter">: </span><span class="description">apply a callback to elements in an input ndarray and assign results to elements in a new output ndarray.</span>
- <span class="package-name">[`@stdlib/ndarray/slice`][@stdlib/ndarray/slice]</span><span class="delimiter">: </span><span class="description">return a read-only view of an input ndarray.</span>

</section>

<!-- /.related -->
Expand All @@ -218,6 +227,14 @@ console.log( ndarray2array( y ) );

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

[@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter

[@stdlib/ndarray/filter-map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter-map

[@stdlib/ndarray/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/map

[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice

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

</section>
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/slice/base/str2multislice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,12 @@ s = str2multislice( 'MultiSlice(foo,bar)' );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/slice/base/str2slice`][@stdlib/slice/base/str2slice]</span><span class="delimiter">: </span><span class="description">parse a string-serialized Slice object.</span>

</section>

<!-- /.related -->
Expand All @@ -141,6 +147,12 @@ s = str2multislice( 'MultiSlice(foo,bar)' );

[@stdlib/slice/multi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/multi

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

[@stdlib/slice/base/str2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/str2slice

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

</section>

<!-- /.links -->

0 comments on commit 21b463e

Please sign in to comment.