Skip to content

Commit f626b3d

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: stdlib-js#2255 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 867726b commit f626b3d

File tree

9 files changed

+134
-0
lines changed

9 files changed

+134
-0
lines changed

‎lib/node_modules/@stdlib/array/base/flatten/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,12 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true );
154154

155155
<section class="related">
156156

157+
* * *
158+
159+
## See Also
160+
161+
- <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>
162+
157163
</section>
158164

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

163169
<section class="links">
164170

171+
<!-- <related-links> -->
172+
173+
[@stdlib/array/base/flatten-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten-by
174+
175+
<!-- </related-links> -->
176+
165177
</section>
166178

167179
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/ones5d/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,17 @@ out = ones5d( [ 1, 1, 1, 3, 1 ] );
9595

9696
<section class="related">
9797

98+
* * *
99+
100+
## See Also
101+
102+
- <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>
103+
- <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>
104+
- <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>
105+
- <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>
106+
- <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>
107+
- <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>
108+
98109
</section>
99110

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

104115
<section class="links">
105116

117+
<!-- <related-links> -->
118+
119+
[@stdlib/array/base/zeros5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros5d
120+
121+
[@stdlib/array/base/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones
122+
123+
[@stdlib/array/base/ones2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones2d
124+
125+
[@stdlib/array/base/ones3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones3d
126+
127+
[@stdlib/array/base/ones4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones4d
128+
129+
[@stdlib/array/base/onesnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/onesnd
130+
131+
<!-- </related-links> -->
132+
106133
</section>
107134

108135
<!-- /.links -->

‎lib/node_modules/@stdlib/constants/float32/exponent-mask/README.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,14 @@ Macro for the mask for the exponent of a [single-precision floating-point number
139139

140140
<section class="related">
141141

142+
* * *
143+
144+
## See Also
145+
146+
- <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>
147+
- <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>
148+
- <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>
149+
142150
</section>
143151

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

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

160+
<!-- <related-links> -->
161+
162+
[@stdlib/constants/float32/sign-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sign-mask
163+
164+
[@stdlib/constants/float32/significand-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/significand-mask
165+
166+
[@stdlib/constants/float32/abs-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/abs-mask
167+
168+
<!-- </related-links> -->
169+
152170
</section>
153171

154172
<!-- /.links -->

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,15 @@ int main( void ) {
167167

168168
<section class="related">
169169

170+
* * *
171+
172+
## See Also
173+
174+
- <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>
175+
- <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>
176+
- <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>
177+
- <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>
178+
170179
</section>
171180

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

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

189+
<!-- <related-links> -->
190+
191+
[@stdlib/math/base/special/acsc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acsc
192+
193+
[@stdlib/math/base/special/acsch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acsch
194+
195+
[@stdlib/math/base/special/asecf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asecf
196+
197+
[@stdlib/math/base/special/asinf]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asinf
198+
199+
<!-- </related-links> -->
200+
180201
</section>
181202

182203
<!-- /.links -->

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ int main( void ) {
180180
- <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>
181181
- <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>
182182
- <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>
183+
- <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>
183184
- <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>
184185

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

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

206+
[@stdlib/math/base/special/csc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/csc
207+
205208
[@stdlib/math/base/special/csch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/csch
206209

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

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,12 @@ int main( void ) {
187187

188188
<section class="related">
189189

190+
* * *
191+
192+
## See Also
193+
194+
- <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>
195+
190196
</section>
191197

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

196202
<section class="links">
197203

204+
<!-- <related-links> -->
205+
206+
[@stdlib/math/base/special/rad2deg]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/rad2deg
207+
208+
<!-- </related-links> -->
209+
198210
</section>
199211

200212
<!-- /.links -->

‎lib/node_modules/@stdlib/math/strided/special/ahaversin-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/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>
237+
232238
</section>
233239

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

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

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

248260
<!-- /.links -->

‎lib/node_modules/@stdlib/slice/base/seq2slice/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,13 @@ console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
263263

264264
<section class="related">
265265

266+
* * *
267+
268+
## See Also
269+
270+
- <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>
271+
- <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>
272+
266273
</section>
267274

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

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

283+
<!-- <related-links> -->
284+
285+
[@stdlib/slice/base/seq2multislice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/seq2multislice
286+
287+
[@stdlib/slice/base/slice2seq]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/slice2seq
288+
289+
<!-- </related-links> -->
290+
276291
</section>
277292

278293
<!-- /.links -->

‎lib/node_modules/@stdlib/utils/every-in-by/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,20 @@ bool = everyInBy( o, isPositive );
122122

123123
<section class="related">
124124

125+
<!-- <related-links> -->
126+
127+
[@stdlib/utils/any-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/any-in-by
128+
129+
[@stdlib/utils/none-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/none-in-by
130+
131+
[@stdlib/utils/some-in-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/some-in-by
132+
133+
[@stdlib/utils/every-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-by
134+
135+
[@stdlib/utils/every-own-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/every-own-by
136+
137+
<!-- </related-links> -->
138+
125139
</section>
126140

127141
<!-- /.links -->

0 commit comments

Comments
 (0)