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 10, 2024
1 parent 1c56b73 commit 918089c
Show file tree
Hide file tree
Showing 12 changed files with 161 additions and 5 deletions.
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/base/flatten2d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,12 @@ out = flatten2d( x, [ 4, 4 ], true );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/base/flatten2d-by`][@stdlib/array/base/flatten2d-by]</span><span class="delimiter">: </span><span class="description">flatten a two-dimensional nested array according to a callback function.</span>

</section>

<!-- /.related -->
Expand All @@ -147,6 +153,12 @@ out = flatten2d( x, [ 4, 4 ], true );

<section class="links">

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

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

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/base/flatten3d-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,12 @@ out = flatten3dBy( x, [ 4, 2, 2 ], true, fcn );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/base/flatten3d`][@stdlib/array/base/flatten3d]</span><span class="delimiter">: </span><span class="description">flatten a three-dimensional nested array.</span>

</section>

<!-- /.related -->
Expand All @@ -193,6 +199,12 @@ out = flatten3dBy( x, [ 4, 2, 2 ], true, fcn );

<section class="links">

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

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/array/base/fliplr3d/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/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>
- <span class="package-name">[`@stdlib/array/base/fliplr5d`][@stdlib/array/base/fliplr5d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the last dimension of a five-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/fliplr4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr4d

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

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

</section>

<!-- /.links -->
27 changes: 27 additions & 0 deletions lib/node_modules/@stdlib/array/base/zeros2d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,17 @@ console.log( arr );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/base/zeros`][@stdlib/array/base/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled generic array.</span>
- <span class="package-name">[`@stdlib/array/base/ones2d`][@stdlib/array/base/ones2d]</span><span class="delimiter">: </span><span class="description">create a two-dimensional nested array filled with ones.</span>
- <span class="package-name">[`@stdlib/array/base/zeros3d`][@stdlib/array/base/zeros3d]</span><span class="delimiter">: </span><span class="description">create a zero-filled three-dimensional nested array.</span>
- <span class="package-name">[`@stdlib/array/base/zeros4d`][@stdlib/array/base/zeros4d]</span><span class="delimiter">: </span><span class="description">create a zero-filled four-dimensional nested array.</span>
- <span class="package-name">[`@stdlib/array/base/zeros5d`][@stdlib/array/base/zeros5d]</span><span class="delimiter">: </span><span class="description">create a zero-filled five-dimensional nested array.</span>
- <span class="package-name">[`@stdlib/array/base/zerosnd`][@stdlib/array/base/zerosnd]</span><span class="delimiter">: </span><span class="description">create a zero-filled n-dimensional nested array.</span>

</section>

<!-- /.related -->
Expand All @@ -111,6 +122,22 @@ console.log( arr );

<section class="links">

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

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

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

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

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

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

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/array/place/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,14 @@ console.log( out );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/array/mskput`][@stdlib/array/mskput]</span><span class="delimiter">: </span><span class="description">replace elements of an array with provided values according to a provided mask array.</span>
- <span class="package-name">[`@stdlib/array/put`][@stdlib/array/put]</span><span class="delimiter">: </span><span class="description">replace specified elements of an array with provided values.</span>
- <span class="package-name">[`@stdlib/array/take`][@stdlib/array/take]</span><span class="delimiter">: </span><span class="description">take elements from an array.</span>

</section>

<!-- /.related -->
Expand All @@ -160,6 +168,16 @@ console.log( out );

[@stdlib/array/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/same-kind-casts

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

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

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

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

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

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/assert/has-btoa-support/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,12 @@ $ has-btoa-support

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/assert/has-atob-support`][@stdlib/assert/has-atob-support]</span><span class="delimiter">: </span><span class="description">detect native atob support.</span>

</section>

<!-- /.related -->
Expand All @@ -118,6 +124,12 @@ $ has-btoa-support

[mdn-btoa]: https://developer.mozilla.org/en-US/docs/Web/API/Window/btoa

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

[@stdlib/assert/has-atob-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-atob-support

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

</section>

<!-- /.links -->
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/blas/base/dasum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ int main( void ) {
## See Also
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
- <span class="package-name">[`@stdlib/blas/base/gasum`][@stdlib/blas/base/gasum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (L1 norm).</span>
- <span class="package-name">[`@stdlib/blas/base/sasum`][@stdlib/blas/base/sasum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (L1 norm).</span>
- <span class="package-name">[`@stdlib/blas/ext/base/dsum`][@stdlib/blas/ext/base/dsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements.</span>
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/blas/ext/base/dapxsumkbn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,10 +283,10 @@ int main( void ) {
## See Also
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]</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.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/dsumkbn`][@stdlib/blas/ext/base/dsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum using an improved Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]</span><span class="delimiter">: </span><span class="description">adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumkbn`][@stdlib/blas/ext/base/gapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumkbn`][@stdlib/blas/ext/base/sapxsumkbn]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.</span>
</section>
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/iter/do-while-each/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,14 @@ while ( true ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/iter/do-until-each`][@stdlib/iter/do-until-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.</span>
- <span class="package-name">[`@stdlib/iter/until-each`][@stdlib/iter/until-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.</span>
- <span class="package-name">[`@stdlib/iter/while-each`][@stdlib/iter/while-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value.</span>

</section>

<!-- /.related -->
Expand All @@ -234,6 +242,16 @@ while ( true ) {

<section class="links">

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

[@stdlib/iter/do-until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/do-until-each

[@stdlib/iter/until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/until-each

[@stdlib/iter/while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/while-each

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

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,14 @@ console.log( '%s => [%s]', s.toString(), out.join( ',' ) );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/slice/base/length`][@stdlib/slice/base/length]</span><span class="delimiter">: </span><span class="description">compute the number of elements in a normalized slice.</span>
- <span class="package-name">[`@stdlib/slice/base/reduced-dimensions`][@stdlib/slice/base/reduced-dimensions]</span><span class="delimiter">: </span><span class="description">return a list of reduced dimensions in an un-normalized multi-slice.</span>
- <span class="package-name">[`@stdlib/slice/base/shape`][@stdlib/slice/base/shape]</span><span class="delimiter">: </span><span class="description">compute the shape of a normalized multi-slice.</span>

</section>

<!-- /.related -->
Expand All @@ -133,6 +141,16 @@ console.log( '%s => [%s]', s.toString(), out.join( ',' ) );

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

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

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

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

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

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

</section>

<!-- /.links -->
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/stats/levene-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ var table = out.print();

## See Also

- <span class="package-name">[`@stdlib/stats/vartest`][@stdlib/stats/vartest]</span><span class="delimiter">: </span><span class="description">two-sample F-test for equal variances</span>
- <span class="package-name">[`@stdlib/stats/vartest`][@stdlib/stats/vartest]</span><span class="delimiter">: </span><span class="description">two-sample F-test for equal variances.</span>
- <span class="package-name">[`@stdlib/stats/bartlett-test`][@stdlib/stats/bartlett-test]</span><span class="delimiter">: </span><span class="description">Bartlett’s test for equal variances.</span>

</section>
Expand Down
21 changes: 21 additions & 0 deletions lib/node_modules/@stdlib/string/base/dotcase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,15 @@ out = dotcase( str );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/string/base/camelcase`][@stdlib/string/base/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
- <span class="package-name">[`@stdlib/string/base/lowercase`][@stdlib/string/base/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
- <span class="package-name">[`@stdlib/string/base/snakecase`][@stdlib/string/base/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</span>
- <span class="package-name">[`@stdlib/string/base/uppercase`][@stdlib/string/base/uppercase]</span><span class="delimiter">: </span><span class="description">convert a string to uppercase.</span>

</section>

<!-- /.related -->
Expand All @@ -97,6 +106,18 @@ out = dotcase( str );

<section class="links">

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

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

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

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

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

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

</section>

<!-- /.links -->

0 comments on commit 918089c

Please sign in to comment.