Skip to content

Commit bf5643f

Browse files
authored
docs: update related packages sections
PR-URL: #3404 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent fe1328a commit bf5643f

File tree

13 files changed

+157
-5
lines changed

13 files changed

+157
-5
lines changed

lib/node_modules/@stdlib/array/base/cartesian-power/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,14 @@ var out = cartesianPower( x, 3 );
8989

9090
<section class="related">
9191

92+
* * *
93+
94+
## See Also
95+
96+
- <span class="package-name">[`@stdlib/array/cartesian-power`][@stdlib/array/cartesian-power]</span><span class="delimiter">: </span><span class="description">return the Cartesian power.</span>
97+
- <span class="package-name">[`@stdlib/array/base/cartesian-product`][@stdlib/array/base/cartesian-product]</span><span class="delimiter">: </span><span class="description">return the Cartesian product.</span>
98+
- <span class="package-name">[`@stdlib/array/base/cartesian-square`][@stdlib/array/base/cartesian-square]</span><span class="delimiter">: </span><span class="description">return the Cartesian square.</span>
99+
92100
</section>
93101

94102
<!-- /.related -->
@@ -99,6 +107,16 @@ var out = cartesianPower( x, 3 );
99107

100108
[cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
101109

110+
<!-- <related-links> -->
111+
112+
[@stdlib/array/cartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/cartesian-power
113+
114+
[@stdlib/array/base/cartesian-product]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-product
115+
116+
[@stdlib/array/base/cartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cartesian-square
117+
118+
<!-- </related-links> -->
119+
102120
</section>
103121

104122
<!-- /.links -->

lib/node_modules/@stdlib/blas/base/daxpy/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -308,8 +308,8 @@ int main( void ) {
308308
## See Also
309309
310310
- <span class="package-name">[`@stdlib/blas/base/dasum`][@stdlib/blas/base/dasum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (L1 norm).</span>
311-
- <span class="package-name">[`@stdlib/blas/base/gaxpy`][@stdlib/blas/base/gaxpy]</span><span class="delimiter">: </span><span class="description">multiply x by a constant and add the result to y.</span>
312-
- <span class="package-name">[`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector x by a constant and add the result to y.</span>
311+
- <span class="package-name">[`@stdlib/blas/base/gaxpy`][@stdlib/blas/base/gaxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
312+
- <span class="package-name">[`@stdlib/blas/base/saxpy`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant and add the result to `y`.</span>
313313
314314
</section>
315315

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,9 @@ console.log( x );
157157

158158
## See Also
159159

160-
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum.</span>
161-
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">adds a constant to each strided array element and computes the sum.</span>
162-
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumpw`][@stdlib/blas/ext/base/sapxsumpw]</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 pairwise summation.</span>
160+
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsum`][@stdlib/blas/ext/base/dapxsum]</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.</span>
161+
- <span class="package-name">[`@stdlib/blas/ext/base/gapxsum`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a constant to each strided array element and compute the sum.</span>
162+
- <span class="package-name">[`@stdlib/blas/ext/base/sapxsumpw`][@stdlib/blas/ext/base/sapxsumpw]</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 pairwise summation.</span>
163163
- <span class="package-name">[`@stdlib/blas/ext/base/ssum`][@stdlib/blas/ext/base/ssum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements.</span>
164164

165165
</section>

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

+3
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ int main( void ) {
172172
- <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>
173173
- <span class="package-name">[`@stdlib/math/base/special/asec`][@stdlib/math/base/special/asec]</span><span class="delimiter">: </span><span class="description">compute the inverse (arc) secant of a number.</span>
174174
- <span class="package-name">[`@stdlib/math/base/special/asin`][@stdlib/math/base/special/asin]</span><span class="delimiter">: </span><span class="description">compute the arcsine of a double-precision floating-point number.</span>
175+
- <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>
175176

176177
</section>
177178

@@ -193,6 +194,8 @@ int main( void ) {
193194

194195
[@stdlib/math/base/special/asin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asin
195196

197+
[@stdlib/math/base/special/csc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/csc
198+
196199
<!-- </related-links> -->
197200

198201
</section>

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

+17
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,15 @@ int main( void ) {
173173

174174
<section class="related">
175175

176+
* * *
177+
178+
## See Also
179+
180+
- <span class="package-name">[`@stdlib/math/base/special/asec`][@stdlib/math/base/special/asec]</span><span class="delimiter">: </span><span class="description">compute the inverse (arc) secant of a number.</span>
181+
- <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>
182+
- <span class="package-name">[`@stdlib/math/base/special/acosd`][@stdlib/math/base/special/acosd]</span><span class="delimiter">: </span><span class="description">compute the arccosine (in degrees) of a double-precision floating-point number.</span>
183+
- <span class="package-name">[`@stdlib/math/base/special/secd`][@stdlib/math/base/special/secd]</span><span class="delimiter">: </span><span class="description">compute the secant of an angle measured in degrees.</span>
184+
176185
</section>
177186

178187
<!-- /.related -->
@@ -185,6 +194,14 @@ int main( void ) {
185194

186195
<!-- <related-links> -->
187196

197+
[@stdlib/math/base/special/asec]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asec
198+
199+
[@stdlib/math/base/special/asech]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/asech
200+
201+
[@stdlib/math/base/special/acosd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acosd
202+
203+
[@stdlib/math/base/special/secd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/secd
204+
188205
<!-- </related-links> -->
189206

190207
</section>

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

+14
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,14 @@ int main( void ) {
170170

171171
<section class="related">
172172

173+
* * *
174+
175+
## See Also
176+
177+
- <span class="package-name">[`@stdlib/math/base/special/cscd`][@stdlib/math/base/special/cscd]</span><span class="delimiter">: </span><span class="description">compute the cosecant of a degree.</span>
178+
- <span class="package-name">[`@stdlib/math/base/special/secd`][@stdlib/math/base/special/secd]</span><span class="delimiter">: </span><span class="description">compute the secant of an angle measured in degrees.</span>
179+
- <span class="package-name">[`@stdlib/math/base/special/tand`][@stdlib/math/base/special/tand]</span><span class="delimiter">: </span><span class="description">compute the tangent of an angle measured in degrees.</span>
180+
173181
</section>
174182

175183
<!-- /.related -->
@@ -182,6 +190,12 @@ int main( void ) {
182190

183191
<!-- <related-links> -->
184192

193+
[@stdlib/math/base/special/cscd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cscd
194+
195+
[@stdlib/math/base/special/secd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/secd
196+
197+
[@stdlib/math/base/special/tand]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/tand
198+
185199
<!-- </related-links> -->
186200

187201
</section>

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

+11
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,13 @@ int main( void ) {
172172

173173
<section class="related">
174174

175+
* * *
176+
177+
## See Also
178+
179+
- <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>
180+
- <span class="package-name">[`@stdlib/math/base/special/secd`][@stdlib/math/base/special/secd]</span><span class="delimiter">: </span><span class="description">compute the secant of an angle measured in degrees.</span>
181+
175182
</section>
176183

177184
<!-- /.related -->
@@ -184,6 +191,10 @@ int main( void ) {
184191

185192
<!-- <related-links> -->
186193

194+
[@stdlib/math/base/special/cotd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/cotd
195+
196+
[@stdlib/math/base/special/secd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/secd
197+
187198
<!-- </related-links> -->
188199

189200
</section>

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

+14
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,14 @@ for ( i = 0; i < 100; i++ ) {
129129

130130
<section class="related">
131131

132+
* * *
133+
134+
## See Also
135+
136+
- <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>
137+
- <span class="package-name">[`@stdlib/math/base/special/maxabs`][@stdlib/math/base/special/maxabs]</span><span class="delimiter">: </span><span class="description">return the maximum absolute 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>
139+
132140
</section>
133141

134142
<!-- /.related -->
@@ -139,6 +147,12 @@ for ( i = 0; i < 100; i++ ) {
139147

140148
<!-- <related-links> -->
141149

150+
[@stdlib/math/base/special/maxn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxn
151+
152+
[@stdlib/math/base/special/maxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxabs
153+
154+
[@stdlib/math/base/special/minabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabsn
155+
142156
<!-- </related-links> -->
143157

144158
</section>

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

+3
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ for ( i = 0; i < 100; i++ ) {
134134
## See Also
135135

136136
- <span class="package-name">[`@stdlib/math/base/special/max`][@stdlib/math/base/special/max]</span><span class="delimiter">: </span><span class="description">return the maximum value.</span>
137+
- <span class="package-name">[`@stdlib/math/base/special/maxabsn`][@stdlib/math/base/special/maxabsn]</span><span class="delimiter">: </span><span class="description">return the maximum absolute value.</span>
137138
- <span class="package-name">[`@stdlib/math/base/special/minn`][@stdlib/math/base/special/minn]</span><span class="delimiter">: </span><span class="description">return the minimum value.</span>
138139

139140
</section>
@@ -148,6 +149,8 @@ for ( i = 0; i < 100; i++ ) {
148149

149150
[@stdlib/math/base/special/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/max
150151

152+
[@stdlib/math/base/special/maxabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxabsn
153+
151154
[@stdlib/math/base/special/minn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minn
152155

153156
<!-- </related-links> -->

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

+14
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,14 @@ for ( i = 0; i < 100; i++ ) {
129129

130130
<section class="related">
131131

132+
* * *
133+
134+
## See Also
135+
136+
- <span class="package-name">[`@stdlib/math/base/special/maxabsn`][@stdlib/math/base/special/maxabsn]</span><span class="delimiter">: </span><span class="description">return the maximum absolute value.</span>
137+
- <span class="package-name">[`@stdlib/math/base/special/minn`][@stdlib/math/base/special/minn]</span><span class="delimiter">: </span><span class="description">return the minimum value.</span>
138+
- <span class="package-name">[`@stdlib/math/base/special/minabs`][@stdlib/math/base/special/minabs]</span><span class="delimiter">: </span><span class="description">return the minimum absolute value.</span>
139+
132140
</section>
133141

134142
<!-- /.related -->
@@ -139,6 +147,12 @@ for ( i = 0; i < 100; i++ ) {
139147

140148
<!-- <related-links> -->
141149

150+
[@stdlib/math/base/special/maxabsn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/maxabsn
151+
152+
[@stdlib/math/base/special/minn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minn
153+
154+
[@stdlib/math/base/special/minabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/minabs
155+
142156
<!-- </related-links> -->
143157

144158
</section>

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

+18
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,14 @@ console.log( y );
229229

230230
<section class="related">
231231

232+
* * *
233+
234+
## See Also
235+
236+
- <span class="package-name">[`@stdlib/math/strided/special/besselj0-by`][@stdlib/math/strided/special/besselj0-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the first kind of order zero for each element retrieved from an input strided array via a callback function.</span>
237+
- <span class="package-name">[`@stdlib/math/strided/special/bessely0-by`][@stdlib/math/strided/special/bessely0-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the second kind of order zero for each element retrieved from an input strided array via a callback function.</span>
238+
- <span class="package-name">[`@stdlib/math/strided/special/bessely1-by`][@stdlib/math/strided/special/bessely1-by]</span><span class="delimiter">: </span><span class="description">compute the Bessel function of the second kind of order one for each element retrieved from an input strided array via a callback function.</span>
239+
232240
</section>
233241

234242
<!-- /.related -->
@@ -243,6 +251,16 @@ console.log( y );
243251

244252
[@stdlib/math/base/special/besselj1]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/besselj1
245253

254+
<!-- <related-links> -->
255+
256+
[@stdlib/math/strided/special/besselj0-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/besselj0-by
257+
258+
[@stdlib/math/strided/special/bessely0-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely0-by
259+
260+
[@stdlib/math/strided/special/bessely1-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/strided/special/bessely1-by
261+
262+
<!-- </related-links> -->
263+
246264
</section>
247265

248266
<!-- /.links -->

lib/node_modules/@stdlib/ndarray/iter/stacks/README.md

+22
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,16 @@ while ( true ) {
195195

196196
<section class="related">
197197

198+
* * *
199+
200+
## See Also
201+
202+
- <span class="package-name">[`@stdlib/ndarray/iter/columns`][@stdlib/ndarray/iter/columns]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each column in a matrix (or stack of matrices).</span>
203+
- <span class="package-name">[`@stdlib/ndarray/iter/matrices`][@stdlib/ndarray/iter/matrices]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each matrix in a stack of matrices.</span>
204+
- <span class="package-name">[`@stdlib/ndarray/iter/rows`][@stdlib/ndarray/iter/rows]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each row in a matrix (or stack of matrices).</span>
205+
- <span class="package-name">[`@stdlib/ndarray/iter/subarrays`][@stdlib/ndarray/iter/subarrays]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each subarray in a stack of subarrays.</span>
206+
- <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>
207+
198208
</section>
199209

200210
<!-- /.related -->
@@ -209,6 +219,18 @@ while ( true ) {
209219

210220
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
211221

222+
<!-- <related-links> -->
223+
224+
[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/columns
225+
226+
[@stdlib/ndarray/iter/matrices]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/matrices
227+
228+
[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/rows
229+
230+
[@stdlib/ndarray/iter/subarrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/subarrays
231+
232+
<!-- </related-links> -->
233+
212234
</section>
213235

214236
<!-- /.links -->

lib/node_modules/@stdlib/string/base/replace-before/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,14 @@ out = replaceBefore( '', 'xyz', 'foo', 0 );
124124

125125
<section class="related">
126126

127+
* * *
128+
129+
## See Also
130+
131+
- <span class="package-name">[`@stdlib/string/base/replace-after`][@stdlib/string/base/replace-after]</span><span class="delimiter">: </span><span class="description">replace the substring after the first occurrence of a specified search string.</span>
132+
- <span class="package-name">[`@stdlib/string/base/replace-before-last`][@stdlib/string/base/replace-before-last]</span><span class="delimiter">: </span><span class="description">replace the substring before the last occurrence of a specified search string.</span>
133+
- <span class="package-name">[`@stdlib/string/base/replace-after-last`][@stdlib/string/base/replace-after-last]</span><span class="delimiter">: </span><span class="description">replace the substring after the last occurrence of a specified search string.</span>
134+
127135
</section>
128136

129137
<!-- /.related -->
@@ -132,6 +140,16 @@ out = replaceBefore( '', 'xyz', 'foo', 0 );
132140

133141
<section class="links">
134142

143+
<!-- <related-links> -->
144+
145+
[@stdlib/string/base/replace-after]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-after
146+
147+
[@stdlib/string/base/replace-before-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-before-last
148+
149+
[@stdlib/string/base/replace-after-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-after-last
150+
151+
<!-- </related-links> -->
152+
135153
</section>
136154

137155
<!-- /.links -->

0 commit comments

Comments
 (0)