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
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/base/flatten/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,12 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true );

<section class="related">

* * *

## See Also

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

</section>

<!-- /.related -->
Expand All @@ -162,6 +168,12 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true );

<section class="links">

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

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

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

</section>

<!-- /.links -->
27 changes: 27 additions & 0 deletions lib/node_modules/@stdlib/array/base/ones5d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,17 @@ out = ones5d( [ 1, 1, 1, 3, 1 ] );

<section class="related">

* * *

## See Also

- <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/ones`][@stdlib/array/base/ones]</span><span class="delimiter">: </span><span class="description">create a generic array filled with ones.</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/ones3d`][@stdlib/array/base/ones3d]</span><span class="delimiter">: </span><span class="description">create a three-dimensional nested array filled with ones.</span>
- <span class="package-name">[`@stdlib/array/base/ones4d`][@stdlib/array/base/ones4d]</span><span class="delimiter">: </span><span class="description">create a four-dimensional nested array filled with ones.</span>
- <span class="package-name">[`@stdlib/array/base/onesnd`][@stdlib/array/base/onesnd]</span><span class="delimiter">: </span><span class="description">create an n-dimensional nested array filled with ones.</span>

</section>

<!-- /.related -->
Expand All @@ -103,6 +114,22 @@ out = ones5d( [ 1, 1, 1, 3, 1 ] );

<section class="links">

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

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

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

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

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

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

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

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

</section>

<!-- /.links -->
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/exponent-mask/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,14 @@ Macro for the mask for the exponent of a [single-precision floating-point number

<section class="related">

* * *

## See Also

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

</section>

<!-- /.related -->
Expand All @@ -149,6 +157,16 @@ Macro for the mask for the exponent of a [single-precision floating-point number

[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985

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

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

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

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

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

</section>

<!-- /.links -->
21 changes: 21 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/acscf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,15 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/acsc`][@stdlib/math/base/special/acsc]</span><span class="delimiter">: </span><span class="description">compute the arccosecant of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/acsch`][@stdlib/math/base/special/acsch]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arccosecant of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/asecf`][@stdlib/math/base/special/asecf]</span><span class="delimiter">: </span><span class="description">compute the inverse (arc) secant of a single-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/asinf`][@stdlib/math/base/special/asinf]</span><span class="delimiter">: </span><span class="description">compute the arcsine of a single-precision floating-point number.</span>

</section>

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

[arccosecant]: https://en.wikipedia.org/wiki/Inverse_trigonometric_functions

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

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

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

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

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

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

</section>

<!-- /.links -->
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/acsch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ int main( void ) {
- <span class="package-name">[`@stdlib/math/base/special/acsc`][@stdlib/math/base/special/acsc]</span><span class="delimiter">: </span><span class="description">compute the arccosecant of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/asech`][@stdlib/math/base/special/asech]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arcsecant of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/asinh`][@stdlib/math/base/special/asinh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arcsine of a double-precision floating-point number.</span>
- <span class="package-name">[`@stdlib/math/base/special/csc`][@stdlib/math/base/special/csc]</span><span class="delimiter">: </span><span class="description">compute the cosecant of a number.</span>
- <span class="package-name">[`@stdlib/math/base/special/csch`][@stdlib/math/base/special/csch]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic cosecant of a number.</span>

</section>
Expand All @@ -202,6 +203,8 @@ int main( void ) {

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

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

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

<!-- </related-links> -->
Expand Down
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/math/base/special/rad2degf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,12 @@ int main( void ) {

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/math/base/special/rad2deg`][@stdlib/math/base/special/rad2deg]</span><span class="delimiter">: </span><span class="description">convert an angle from radians to degrees.</span>

</section>

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

<section class="links">

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

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

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

</section>

<!-- /.links -->
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/ahavercos-by`][@stdlib/math/strided/special/ahavercos-by]</span><span class="delimiter">: </span><span class="description">compute the inverse half-value versed cosine 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/ahaversin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ahaversin

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

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

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

</section>

<!-- /.links -->
15 changes: 15 additions & 0 deletions lib/node_modules/@stdlib/slice/base/seq2slice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,13 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );

<section class="related">

* * *

## See Also

- <span class="package-name">[`@stdlib/slice/base/seq2multislice`][@stdlib/slice/base/seq2multislice]</span><span class="delimiter">: </span><span class="description">convert a multidimensional subsequence string to a MultiSlice object.</span>
- <span class="package-name">[`@stdlib/slice/base/slice2seq`][@stdlib/slice/base/slice2seq]</span><span class="delimiter">: </span><span class="description">convert a Slice object to a subsequence string.</span>

</section>

<!-- /.related -->
Expand All @@ -273,6 +280,14 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );

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

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

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

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

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

</section>

<!-- /.links -->
14 changes: 14 additions & 0 deletions lib/node_modules/@stdlib/utils/every-in-by/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,20 @@ bool = everyInBy( o, isPositive );

<section class="related">

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

[@stdlib/utils/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-in-by

[@stdlib/utils/none-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/none-in-by

[@stdlib/utils/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-in-by

[@stdlib/utils/every-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-by

[@stdlib/utils/every-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-own-by

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

</section>

<!-- /.links -->