Skip to content

Commit c322b66

Browse files
docs: update related packages sections
PR-URL: #4070 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 724d581 commit c322b66

File tree

9 files changed

+86
-4
lines changed

9 files changed

+86
-4
lines changed

lib/node_modules/@stdlib/array/base/fliplr5d/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,14 @@ console.log( y );
9797

9898
<section class="related">
9999

100+
* * *
101+
102+
## See Also
103+
104+
- <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>
105+
- <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>
106+
- <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>
107+
100108
</section>
101109

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

106114
<section class="links">
107115

116+
<!-- <related-links> -->
117+
118+
[@stdlib/array/base/fliplr2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr2d
119+
120+
[@stdlib/array/base/fliplr3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr3d
121+
122+
[@stdlib/array/base/fliplr4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/fliplr4d
123+
124+
<!-- </related-links> -->
125+
108126
</section>
109127

110128
<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/base/gapx/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ console.log( x );
163163

164164
## See Also
165165

166-
- <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>
166+
- <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>
167167
- <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>
168168

169169
</section>

lib/node_modules/@stdlib/blas/ext/base/sapxsumkbn2/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,9 @@ console.log( v );
166166

167167
## See Also
168168

169-
- <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>
170-
- <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>
171-
- <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>
169+
- <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>
170+
- <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>
171+
- <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>
172172
- <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>
173173

174174
</section>

lib/node_modules/@stdlib/constants/float64/high-word-exponent-mask/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@ Macro for the high word mask for the exponent of a [double-precision floating-po
150150
## See Also
151151

152152
- <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>
153+
- <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>
154+
- <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>
153155

154156
</section>
155157

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

166168
[@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
167169

170+
[@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
171+
172+
[@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
173+
168174
<!-- </related-links> -->
169175

170176
</section>

lib/node_modules/@stdlib/math/base/assert/is-positive-finite/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,14 @@ int main( void ) {
176176

177177
<section class="related">
178178

179+
* * *
180+
181+
## See Also
182+
183+
- <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>
184+
- <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>
185+
- <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>
186+
179187
</section>
180188

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

187195
<!-- <related-links> -->
188196

197+
[@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
198+
199+
[@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
200+
201+
[@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
202+
189203
<!-- </related-links> -->
190204

191205
</section>

lib/node_modules/@stdlib/math/base/special/minn/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ for ( i = 0; i < 100; i++ ) {
135135

136136
- <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>
137137
- <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>
138+
- <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>
138139

139140
</section>
140141

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

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

154+
[@stdlib/math/base/special/minabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabsn
155+
153156
<!-- </related-links> -->
154157

155158
</section>

lib/node_modules/@stdlib/math/strided/special/atan-by/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,12 @@ console.log( y );
229229

230230
<section class="related">
231231

232+
* * *
233+
234+
## See Also
235+
236+
- <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>
237+
232238
</section>
233239

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

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

252+
<!-- <related-links> -->
253+
254+
[@stdlib/math/strided/special/atanh-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/atanh-by
255+
256+
<!-- </related-links> -->
257+
246258
</section>
247259

248260
<!-- /.links -->

lib/node_modules/@stdlib/ndarray/reject/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,15 @@ console.log( ndarray2array( y ) );
204204

205205
<section class="related">
206206

207+
* * *
208+
209+
## See Also
210+
211+
- <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>
212+
- <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>
213+
- <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>
214+
- <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>
215+
207216
</section>
208217

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

219228
<!-- <related-links> -->
220229

230+
[@stdlib/ndarray/filter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter
231+
232+
[@stdlib/ndarray/filter-map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/filter-map
233+
234+
[@stdlib/ndarray/map]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/map
235+
236+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
237+
221238
<!-- </related-links> -->
222239

223240
</section>

lib/node_modules/@stdlib/slice/base/str2multislice/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,12 @@ s = str2multislice( 'MultiSlice(foo,bar)' );
131131

132132
<section class="related">
133133

134+
* * *
135+
136+
## See Also
137+
138+
- <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>
139+
134140
</section>
135141

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

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

150+
<!-- <related-links> -->
151+
152+
[@stdlib/slice/base/str2slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/str2slice
153+
154+
<!-- </related-links> -->
155+
144156
</section>
145157

146158
<!-- /.links -->

0 commit comments

Comments
 (0)