From 87bf56b0ce8e05de3bb9a01652a3efb1067a1a7d Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Fri, 3 Jan 2025 02:44:32 +0000 Subject: [PATCH 1/2] docs: update related packages sections --- .../@stdlib/array/base/ones/README.md | 27 +++++++++++++++++++ .../@stdlib/array/base/zeros3d/README.md | 27 +++++++++++++++++++ .../constants/float32/sqrt-half-pi/README.md | 4 +-- .../slice/base/seq2multislice/README.md | 13 +++++++++ .../base/reinterpret-complex/README.md | 15 +++++++++++ 5 files changed, 84 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/array/base/ones/README.md b/lib/node_modules/@stdlib/array/base/ones/README.md index 1fd7cb3eea27..be21bf154635 100644 --- a/lib/node_modules/@stdlib/array/base/ones/README.md +++ b/lib/node_modules/@stdlib/array/base/ones/README.md @@ -103,6 +103,17 @@ console.log( arr );
+* * * + +## See Also + +- [`@stdlib/array/base/zeros`][@stdlib/array/base/zeros]: create a zero-filled generic array. +- [`@stdlib/array/base/ones2d`][@stdlib/array/base/ones2d]: create a two-dimensional nested array filled with ones. +- [`@stdlib/array/base/ones3d`][@stdlib/array/base/ones3d]: create a three-dimensional nested array filled with ones. +- [`@stdlib/array/base/ones4d`][@stdlib/array/base/ones4d]: create a four-dimensional nested array filled with ones. +- [`@stdlib/array/base/ones5d`][@stdlib/array/base/ones5d]: create a five-dimensional nested array filled with ones. +- [`@stdlib/array/base/onesnd`][@stdlib/array/base/onesnd]: create an n-dimensional nested array filled with ones. +
@@ -111,6 +122,22 @@ console.log( arr );
+ + +[@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/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/ones5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones5d + +[@stdlib/array/base/onesnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/onesnd + + +
diff --git a/lib/node_modules/@stdlib/array/base/zeros3d/README.md b/lib/node_modules/@stdlib/array/base/zeros3d/README.md index c82e7c1ac869..b7b30ddee9fd 100644 --- a/lib/node_modules/@stdlib/array/base/zeros3d/README.md +++ b/lib/node_modules/@stdlib/array/base/zeros3d/README.md @@ -95,6 +95,17 @@ out = zeros3d( [ 1, 3, 1 ] );
+* * * + +## See Also + +- [`@stdlib/array/base/zeros`][@stdlib/array/base/zeros]: create a zero-filled generic array. +- [`@stdlib/array/base/ones3d`][@stdlib/array/base/ones3d]: create a three-dimensional nested array filled with ones. +- [`@stdlib/array/base/zeros2d`][@stdlib/array/base/zeros2d]: create a zero-filled two-dimensional nested array. +- [`@stdlib/array/base/zeros4d`][@stdlib/array/base/zeros4d]: create a zero-filled four-dimensional nested array. +- [`@stdlib/array/base/zeros5d`][@stdlib/array/base/zeros5d]: create a zero-filled five-dimensional nested array. +- [`@stdlib/array/base/zerosnd`][@stdlib/array/base/zerosnd]: create a zero-filled n-dimensional nested array. +
@@ -103,6 +114,22 @@ out = zeros3d( [ 1, 3, 1 ] );
+ + +[@stdlib/array/base/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros + +[@stdlib/array/base/ones3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones3d + +[@stdlib/array/base/zeros2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros2d + +[@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 + + +
diff --git a/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md b/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md index 194bd769c40e..1b6121921b43 100644 --- a/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md +++ b/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md @@ -124,7 +124,7 @@ Macro for the square root of the mathematical constant [π][@stdlib/constants/fl ## See Also -- [`@stdlib/constants/float32/pi`][@stdlib/constants/float32/pi]: π. +- [`@stdlib/constants/float64/sqrt-half-pi`][@stdlib/constants/float64/sqrt-half-pi]: square root of 0.5π. @@ -136,7 +136,7 @@ Macro for the square root of the mathematical constant [π][@stdlib/constants/fl -[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi +[@stdlib/constants/float64/sqrt-half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/sqrt-half-pi diff --git a/lib/node_modules/@stdlib/slice/base/seq2multislice/README.md b/lib/node_modules/@stdlib/slice/base/seq2multislice/README.md index 484deaea2cb1..dd2ec965934b 100644 --- a/lib/node_modules/@stdlib/slice/base/seq2multislice/README.md +++ b/lib/node_modules/@stdlib/slice/base/seq2multislice/README.md @@ -174,6 +174,13 @@ s = seq2multislice( 'foo,bar', [ 10, 10 ], false );
+* * * + +## See Also + +- [`@stdlib/slice/base/seq2slice`][@stdlib/slice/base/seq2slice]: convert a subsequence string to a Slice object. +- [`@stdlib/slice/base/sargs2multislice`][@stdlib/slice/base/sargs2multislice]: create a MultiSlice object from a comma-separated list of string-serialized MultiSlice constructor arguments. +
@@ -186,6 +193,12 @@ s = seq2multislice( 'foo,bar', [ 10, 10 ], false ); [@stdlib/slice/base/seq2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/seq2slice + + +[@stdlib/slice/base/sargs2multislice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/sargs2multislice + + + diff --git a/lib/node_modules/@stdlib/strided/base/reinterpret-complex/README.md b/lib/node_modules/@stdlib/strided/base/reinterpret-complex/README.md index 985f78ff384b..c3342e35c689 100644 --- a/lib/node_modules/@stdlib/strided/base/reinterpret-complex/README.md +++ b/lib/node_modules/@stdlib/strided/base/reinterpret-complex/README.md @@ -144,6 +144,13 @@ var im = imag( z );
+* * * + +## See Also + +- [`@stdlib/strided/base/reinterpret-complex128`][@stdlib/strided/base/reinterpret-complex128]: reinterpret a Complex128Array as a Float64Array. +- [`@stdlib/strided/base/reinterpret-complex64`][@stdlib/strided/base/reinterpret-complex64]: reinterpret a Complex64Array as a Float32Array. +
@@ -152,6 +159,14 @@ var im = imag( z );
+ + +[@stdlib/strided/base/reinterpret-complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex128 + +[@stdlib/strided/base/reinterpret-complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/strided/base/reinterpret-complex64 + + +
From 5219d4fc21148e8162f819bcbc717bb37c5b66f6 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Thu, 2 Jan 2025 21:51:56 -0500 Subject: [PATCH 2/2] docs: add missing link to float32 pi constant in README --- .../@stdlib/constants/float32/sqrt-half-pi/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md b/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md index 1b6121921b43..3944e0477b58 100644 --- a/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md +++ b/lib/node_modules/@stdlib/constants/float32/sqrt-half-pi/README.md @@ -134,6 +134,8 @@ Macro for the square root of the mathematical constant [π][@stdlib/constants/fl
+[@stdlib/constants/float32/pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/pi + [@stdlib/constants/float64/sqrt-half-pi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/sqrt-half-pi