Skip to content

Commit 78a556e

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: stdlib-js#1145 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 5d698ee commit 78a556e

File tree

17 files changed

+128
-12
lines changed

17 files changed

+128
-12
lines changed

‎lib/node_modules/@stdlib/math/base/ops/add/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ int main( void ) {
195195

196196
## See Also
197197

198+
- <span class="package-name">[`@stdlib/math/base/ops/div`][@stdlib/math/base/ops/div]</span><span class="delimiter">: </span><span class="description">divide two double-precision floating-point numbers.</span>
198199
- <span class="package-name">[`@stdlib/math/base/ops/mul`][@stdlib/math/base/ops/mul]</span><span class="delimiter">: </span><span class="description">multiply two double-precision floating-point numbers.</span>
199200
- <span class="package-name">[`@stdlib/math/base/ops/sub`][@stdlib/math/base/ops/sub]</span><span class="delimiter">: </span><span class="description">subtract two double-precision floating-point numbers.</span>
200201

@@ -208,6 +209,8 @@ int main( void ) {
208209

209210
<!-- <related-links> -->
210211

212+
[@stdlib/math/base/ops/div]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/div
213+
211214
[@stdlib/math/base/ops/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/ops/mul
212215

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

‎lib/node_modules/@stdlib/math/base/special/xlog1py/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ for ( i = 0; i < 100; i++ ) {
101101
## See Also
102102

103103
- <span class="package-name">[`@stdlib/math/base/special/log1p`][@stdlib/math/base/special/log1p]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of 1+x.</span>
104-
- <span class="package-name">[`@stdlib/math/base/special/xlogy`][@stdlib/math/base/special/xlogy]</span><span class="delimiter">: </span><span class="description">compute `x * ln(y)` so that the result is `0` if `x = 0`.</span>
104+
- <span class="package-name">[`@stdlib/math/base/special/xlogy`][@stdlib/math/base/special/xlogy]</span><span class="delimiter">: </span><span class="description">compute `x \* ln(y)` so that the result is `0` if `x = 0`.</span>
105105

106106
</section>
107107

‎lib/node_modules/@stdlib/math/iter/special/log1mexp/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ while ( true ) {
136136

137137
## See Also
138138

139-
- <span class="package-name">[`@stdlib/math/base/special/log1mexp`][@stdlib/math/base/special/log1mexp]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of 1-exp(-|x|).</span>
139+
- <span class="package-name">[`@stdlib/math/base/special/log1mexp`][@stdlib/math/base/special/log1mexp]</span><span class="delimiter">: </span><span class="description">evaluate the natural logarithm of 1-exp(-\|x\|).</span>
140140
- <span class="package-name">[`@stdlib/math/iter/special/log`][@stdlib/math/iter/special/log]</span><span class="delimiter">: </span><span class="description">create an iterator which computes the base `b` logarithm.</span>
141141
- <span class="package-name">[`@stdlib/math/iter/special/log1p`][@stdlib/math/iter/special/log1p]</span><span class="delimiter">: </span><span class="description">create an iterator which evaluates the natural logarithm of 1+x for each iterated value.</span>
142142
- <span class="package-name">[`@stdlib/math/iter/special/log1pexp`][@stdlib/math/iter/special/log1pexp]</span><span class="delimiter">: </span><span class="description">create an iterator which evaluates the natural logarithm of 1+exp(x) for each iterated value.</span>

‎lib/node_modules/@stdlib/ndarray/iter/to-array-each/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ while ( true ) {
158158

159159
<!-- <related-links> -->
160160

161+
162+
161163
<!-- </related-links> -->
162164

163165
</section>

‎lib/node_modules/@stdlib/number/float32/base/signbit/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,12 @@ for ( i = 0; i < 100; i++ ) {
8686

8787
<section class="related">
8888

89+
* * *
90+
91+
## See Also
92+
93+
- <span class="package-name">[`@stdlib/number/float64/base/signbit`][@stdlib/number/float64/base/signbit]</span><span class="delimiter">: </span><span class="description">return a boolean indicating if the sign bit for a double-precision floating-point number is on (true) or off (false).</span>
94+
8995
</section>
9096

9197
<!-- /.related -->
@@ -96,6 +102,12 @@ for ( i = 0; i < 100; i++ ) {
96102

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

105+
<!-- <related-links> -->
106+
107+
[@stdlib/number/float64/base/signbit]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float64/base/signbit
108+
109+
<!-- </related-links> -->
110+
99111
</section>
100112

101113
<!-- /.links -->

‎lib/node_modules/@stdlib/number/float64/base/normalize/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,12 @@ int main( void ) {
228228
229229
<section class="related">
230230
231+
* * *
232+
233+
## See Also
234+
235+
- <span class="package-name">[`@stdlib/number/float32/base/normalize`][@stdlib/number/float32/base/normalize]</span><span class="delimiter">: </span><span class="description">return a normal number `y` and exponent `exp` satisfying `x = y \* 2^exp`.</span>
236+
231237
</section>
232238
233239
<!-- /.related -->
@@ -236,6 +242,12 @@ int main( void ) {
236242
237243
<section class="links">
238244
245+
<!-- <related-links> -->
246+
247+
[@stdlib/number/float32/base/normalize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/float32/base/normalize
248+
249+
<!-- </related-links> -->
250+
239251
</section>
240252
241253
<!-- /.links -->

‎lib/node_modules/@stdlib/os/platform/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ $ platform
112112

113113
## See Also
114114

115-
- <span class="package-name">[`@stdlib/os/arch`][@stdlib/os/arch]</span><span class="delimiter">: </span><span class="description">operating system CPU architecture.</span>
115+
- <span class="package-name">[`@stdlib/os/arch`][@stdlib/os/arch]</span><span class="delimiter">: </span><span class="description">operating system CPU architecture for which the JavaScript runtime binary was compiled.</span>
116116

117117
</section>
118118

‎lib/node_modules/@stdlib/random/array/gamma/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,13 @@ logEach( '%f', x4 );
331331

332332
<section class="related">
333333

334+
* * *
335+
336+
## See Also
337+
338+
- <span class="package-name">[`@stdlib/random/base/gamma`][@stdlib/random/base/gamma]</span><span class="delimiter">: </span><span class="description">gamma distributed pseudorandom numbers.</span>
339+
- <span class="package-name">[`@stdlib/random/strided/gamma`][@stdlib/random/strided/gamma]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from a gamma distribution.</span>
340+
334341
</section>
335342

336343
<!-- /.related -->
@@ -347,6 +354,12 @@ logEach( '%f', x4 );
347354

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

357+
<!-- <related-links> -->
358+
359+
[@stdlib/random/strided/gamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/gamma
360+
361+
<!-- </related-links> -->
362+
350363
</section>
351364

352365
<!-- /.links -->

‎lib/node_modules/@stdlib/random/array/invgamma/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,13 @@ logEach( '%f', x4 );
331331

332332
<section class="related">
333333

334+
* * *
335+
336+
## See Also
337+
338+
- <span class="package-name">[`@stdlib/random/base/invgamma`][@stdlib/random/base/invgamma]</span><span class="delimiter">: </span><span class="description">inverse gamma distributed pseudorandom numbers.</span>
339+
- <span class="package-name">[`@stdlib/random/strided/invgamma`][@stdlib/random/strided/invgamma]</span><span class="delimiter">: </span><span class="description">fill a strided array with pseudorandom numbers drawn from an inverse gamma distribution.</span>
340+
334341
</section>
335342

336343
<!-- /.related -->
@@ -347,6 +354,12 @@ logEach( '%f', x4 );
347354

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

357+
<!-- <related-links> -->
358+
359+
[@stdlib/random/strided/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/invgamma
360+
361+
<!-- </related-links> -->
362+
350363
</section>
351364

352365
<!-- /.links -->

‎lib/node_modules/@stdlib/random/array/randu/README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,14 @@ logEach( '%f', x4 );
247247

248248
<section class="related">
249249

250+
* * *
251+
252+
## See Also
253+
254+
- <span class="package-name">[`@stdlib/random/array/uniform`][@stdlib/random/array/uniform]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a continuous uniform distribution.</span>
255+
- <span class="package-name">[`@stdlib/random/base/randu`][@stdlib/random/base/randu]</span><span class="delimiter">: </span><span class="description">uniformly distributed pseudorandom numbers between 0 and 1.</span>
256+
- <span class="package-name">[`@stdlib/random/strided/randu`][@stdlib/random/strided/randu]</span><span class="delimiter">: </span><span class="description">fill a strided array with uniformly distributed pseudorandom numbers between 0 and 1.</span>
257+
250258
</section>
251259

252260
<!-- /.related -->
@@ -267,6 +275,14 @@ logEach( '%f', x4 );
267275

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

278+
<!-- <related-links> -->
279+
280+
[@stdlib/random/array/uniform]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform
281+
282+
[@stdlib/random/strided/randu]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/randu
283+
284+
<!-- </related-links> -->
285+
270286
</section>
271287

272288
<!-- /.links -->

0 commit comments

Comments
 (0)