Skip to content

Commit 7e8187a

Browse files
stdlib-botstdlib-bot
authored
docs: update related packages sections
PR-URL: #3368 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 9a4c3bd commit 7e8187a

File tree

20 files changed

+276
-24
lines changed

20 files changed

+276
-24
lines changed

‎lib/node_modules/@stdlib/array/base/filled4d-by/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,12 @@ out = filled4dBy( [ 1, 1, 1, 3 ], constantFunction( void 0 ) );
134134

135135
<section class="related">
136136

137+
* * *
138+
139+
## See Also
140+
141+
- <span class="package-name">[`@stdlib/array/base/filled4d`][@stdlib/array/base/filled4d]</span><span class="delimiter">: </span><span class="description">create a filled four-dimensional nested array.</span>
142+
137143
</section>
138144

139145
<!-- /.related -->
@@ -142,6 +148,12 @@ out = filled4dBy( [ 1, 1, 1, 3 ], constantFunction( void 0 ) );
142148

143149
<section class="links">
144150

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

147159
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/flipud3d/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/flipud2d`][@stdlib/array/base/flipud2d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the first dimension of a two-dimensional nested input array.</span>
105+
- <span class="package-name">[`@stdlib/array/base/flipud4d`][@stdlib/array/base/flipud4d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the second-to-last dimension of a four-dimensional nested input array.</span>
106+
- <span class="package-name">[`@stdlib/array/base/flipud5d`][@stdlib/array/base/flipud5d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the second-to-last dimension of a five-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/flipud2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flipud2d
119+
120+
[@stdlib/array/base/flipud4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flipud4d
121+
122+
[@stdlib/array/base/flipud5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flipud5d
123+
124+
<!-- </related-links> -->
125+
108126
</section>
109127

110128
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/flipud5d/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/flipud2d`][@stdlib/array/base/flipud2d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the first dimension of a two-dimensional nested input array.</span>
105+
- <span class="package-name">[`@stdlib/array/base/flipud3d`][@stdlib/array/base/flipud3d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the second-to-last dimension of a three-dimensional nested input array.</span>
106+
- <span class="package-name">[`@stdlib/array/base/flipud4d`][@stdlib/array/base/flipud4d]</span><span class="delimiter">: </span><span class="description">reverse the order of elements along the second-to-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/flipud2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flipud2d
119+
120+
[@stdlib/array/base/flipud3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flipud3d
121+
122+
[@stdlib/array/base/flipud4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flipud4d
123+
124+
<!-- </related-links> -->
125+
108126
</section>
109127

110128
<!-- /.links -->

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

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

9696
<section class="related">
9797

98+
* * *
99+
100+
## See Also
101+
102+
- <span class="package-name">[`@stdlib/array/base/zeros`][@stdlib/array/base/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled generic array.</span>
103+
- <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>
104+
- <span class="package-name">[`@stdlib/array/base/zeros2d`][@stdlib/array/base/zeros2d]</span><span class="delimiter">: </span><span class="description">create a zero-filled two-dimensional nested array.</span>
105+
- <span class="package-name">[`@stdlib/array/base/zeros3d`][@stdlib/array/base/zeros3d]</span><span class="delimiter">: </span><span class="description">create a zero-filled three-dimensional nested array.</span>
106+
- <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>
107+
- <span class="package-name">[`@stdlib/array/base/zerosnd`][@stdlib/array/base/zerosnd]</span><span class="delimiter">: </span><span class="description">create a zero-filled n-dimensional nested array.</span>
108+
98109
</section>
99110

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

104115
<section class="links">
105116

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

108135
<!-- /.links -->

‎lib/node_modules/@stdlib/array/little-endian-float32/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,14 @@ logEach( '%s', out );
417417

418418
<section class="related">
419419

420+
* * *
421+
422+
## See Also
423+
424+
- <span class="package-name">[`@stdlib/array/fixed-endian-float32`][@stdlib/array/fixed-endian-float32]</span><span class="delimiter">: </span><span class="description">Float32Array having a specified byte order.</span>
425+
- <span class="package-name">[`@stdlib/array/float32`][@stdlib/array/float32]</span><span class="delimiter">: </span><span class="description">Float32Array.</span>
426+
- <span class="package-name">[`@stdlib/array/little-endian-float64`][@stdlib/array/little-endian-float64]</span><span class="delimiter">: </span><span class="description">Float64Array in little-endian byte order.</span>
427+
420428
</section>
421429

422430
<!-- /.related -->
@@ -433,6 +441,14 @@ logEach( '%s', out );
433441

434442
[@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32
435443

444+
<!-- <related-links> -->
445+
446+
[@stdlib/array/fixed-endian-float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/fixed-endian-float32
447+
448+
[@stdlib/array/little-endian-float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/little-endian-float64
449+
450+
<!-- </related-links> -->
451+
436452
</section>
437453

438454
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/is-snakecase/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,12 @@ true
166166

167167
<section class="related">
168168

169+
* * *
170+
171+
## See Also
172+
173+
- <span class="package-name">[`@stdlib/assert/is-string`][@stdlib/assert/is-string]</span><span class="delimiter">: </span><span class="description">test if a value is a string.</span>
174+
169175
</section>
170176

171177
<!-- /.related -->
@@ -180,6 +186,8 @@ true
180186

181187
<!-- <related-links> -->
182188

189+
[@stdlib/assert/is-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-string
190+
183191
<!-- </related-links> -->
184192

185193
</section>

‎lib/node_modules/@stdlib/blas/ext/base/sapxsumpw/README.md

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

168168
## See Also
169169

170-
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumpw`][@stdlib/blas/ext/base/dapxsumpw]</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 pairwise summation.</span>
171-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumpw`][@stdlib/blas/ext/base/gapxsumpw]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum using pairwise summation.</span>
172-
- <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>
170+
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumpw`][@stdlib/blas/ext/base/dapxsumpw]</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 pairwise summation.</span>
171+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsumpw`][@stdlib/blas/ext/base/gapxsumpw]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum using pairwise summation.</span>
172+
- <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>
173173
- <span class="package-name">[`@stdlib/blas/ext/base/ssumpw`][@stdlib/blas/ext/base/ssumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using pairwise summation.</span>
174174

175175
</section>

‎lib/node_modules/@stdlib/blas/ext/base/sdsapxsum/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,8 @@ console.log( v );
159159

160160
## See Also
161161

162-
- <span class="package-name">[`@stdlib/blas/ext/base/dsapxsum`][@stdlib/blas/ext/base/dsapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each single-precision floating-point strided array element and computes the sum using extended accumulation and returning an extended precision result.</span>
163-
- <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>
162+
- <span class="package-name">[`@stdlib/blas/ext/base/dsapxsum`][@stdlib/blas/ext/base/dsapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each single-precision floating-point strided array element and compute the sum using extended accumulation and returning an extended precision result.</span>
163+
- <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>
164164
- <span class="package-name">[`@stdlib/blas/ext/base/sdssum`][@stdlib/blas/ext/base/sdssum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using extended accumulation.</span>
165165

166166
</section>

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,14 @@ Macro for the high word mask for excluding the sign bit of a [double-precision f
147147

148148
<section class="related">
149149

150+
* * *
151+
152+
## See Also
153+
154+
- <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>
155+
- <span class="package-name">[`@stdlib/constants/float64/high-word-exponent-mask`][@stdlib/constants/float64/high-word-exponent-mask]</span><span class="delimiter">: </span><span class="description">high word mask for the exponent of a double-precision floating-point number.</span>
156+
- <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>
157+
150158
</section>
151159

152160
<!-- /.related -->
@@ -157,6 +165,16 @@ Macro for the high word mask for excluding the sign bit of a [double-precision f
157165

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

168+
<!-- <related-links> -->
169+
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-exponent-mask]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/high-word-exponent-mask
173+
174+
[@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
175+
176+
<!-- </related-links> -->
177+
160178
</section>
161179

162180
<!-- /.links -->

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

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

156156
<section class="related">
157157

158+
* * *
159+
160+
## See Also
161+
162+
- <span class="package-name">[`@stdlib/math/base/special/acot`][@stdlib/math/base/special/acot]</span><span class="delimiter">: </span><span class="description">compute the inverse cotangent.</span>
163+
- <span class="package-name">[`@stdlib/math/base/special/acoth`][@stdlib/math/base/special/acoth]</span><span class="delimiter">: </span><span class="description">compute the inverse hyperbolic cotangent.</span>
164+
- <span class="package-name">[`@stdlib/math/base/special/atand`][@stdlib/math/base/special/atand]</span><span class="delimiter">: </span><span class="description">compute the arctangent(in degrees) of a double-precision floating-point number.</span>
165+
- <span class="package-name">[`@stdlib/math/base/special/cotd`][@stdlib/math/base/special/cotd]</span><span class="delimiter">: </span><span class="description">compute the cotangent of an angle measured in degrees.</span>
166+
158167
</section>
159168

160169
<!-- /.related -->
@@ -167,6 +176,14 @@ int main( void ) {
167176

168177
<!-- <related-links> -->
169178

179+
[@stdlib/math/base/special/acot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acot
180+
181+
[@stdlib/math/base/special/acoth]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acoth
182+
183+
[@stdlib/math/base/special/atand]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/atand
184+
185+
[@stdlib/math/base/special/cotd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cotd
186+
170187
<!-- </related-links> -->
171188

172189
</section>

0 commit comments

Comments
 (0)