Skip to content

Commit 7f0a642

Browse files
stdlib-botstdlib-bot
committed
docs: update related packages sections
1 parent 7e8187a commit 7f0a642

File tree

15 files changed

+199
-10
lines changed

15 files changed

+199
-10
lines changed

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,12 @@ out = flatten4dBy( x, [ 2, 2, 2, 2 ], true, fcn );
184184

185185
<section class="related">
186186

187+
* * *
188+
189+
## See Also
190+
191+
- <span class="package-name">[`@stdlib/array/base/flatten4d`][@stdlib/array/base/flatten4d]</span><span class="delimiter">: </span><span class="description">flatten a four-dimensional nested array.</span>
192+
187193
</section>
188194

189195
<!-- /.related -->
@@ -192,6 +198,12 @@ out = flatten4dBy( x, [ 2, 2, 2, 2 ], true, fcn );
192198

193199
<section class="links">
194200

201+
<!-- <related-links> -->
202+
203+
[@stdlib/array/base/flatten4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten4d
204+
205+
<!-- </related-links> -->
206+
195207
</section>
196208

197209
<!-- /.links -->

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,17 @@ console.log( arr );
103103

104104
<section class="related">
105105

106+
* * *
107+
108+
## See Also
109+
110+
- <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>
111+
- <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>
112+
- <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>
113+
- <span class="package-name">[`@stdlib/array/base/zeros4d`][@stdlib/array/base/zeros4d]</span><span class="delimiter">: </span><span class="description">create a zero-filled four-dimensional nested array.</span>
114+
- <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>
115+
- <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>
116+
106117
</section>
107118

108119
<!-- /.related -->
@@ -111,6 +122,22 @@ console.log( arr );
111122

112123
<section class="links">
113124

125+
<!-- <related-links> -->
126+
127+
[@stdlib/array/base/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros
128+
129+
[@stdlib/array/base/ones2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones2d
130+
131+
[@stdlib/array/base/zeros3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros3d
132+
133+
[@stdlib/array/base/zeros4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros4d
134+
135+
[@stdlib/array/base/zeros5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros5d
136+
137+
[@stdlib/array/base/zerosnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zerosnd
138+
139+
<!-- </related-links> -->
140+
114141
</section>
115142

116143
<!-- /.links -->

‎lib/node_modules/@stdlib/assert/has-atob-support/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,12 @@ $ has-atob-support
108108

109109
<section class="related">
110110

111+
* * *
112+
113+
## See Also
114+
115+
- <span class="package-name">[`@stdlib/assert/has-btoa-support`][@stdlib/assert/has-btoa-support]</span><span class="delimiter">: </span><span class="description">detect native btoa support.</span>
116+
111117
</section>
112118

113119
<!-- /.related -->
@@ -118,6 +124,12 @@ $ has-atob-support
118124

119125
[mdn-atob]: https://developer.mozilla.org/en-US/docs/Web/API/Window/atob
120126

127+
<!-- <related-links> -->
128+
129+
[@stdlib/assert/has-btoa-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-btoa-support
130+
131+
<!-- </related-links> -->
132+
121133
</section>
122134

123135
<!-- /.links -->

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,12 @@ bool = isWebAssemblyMemory( new ArrayBuffer( 10 ) );
8181

8282
<section class="related">
8383

84+
* * *
85+
86+
## See Also
87+
88+
- <span class="package-name">[`@stdlib/assert/has-wasm-support`][@stdlib/assert/has-wasm-support]</span><span class="delimiter">: </span><span class="description">detect native WebAssembly support.</span>
89+
8490
</section>
8591

8692
<!-- /.related -->
@@ -91,6 +97,12 @@ bool = isWebAssemblyMemory( new ArrayBuffer( 10 ) );
9197

9298
[@stdlib/wasm/memory]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/wasm/memory
9399

100+
<!-- <related-links> -->
101+
102+
[@stdlib/assert/has-wasm-support]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-wasm-support
103+
104+
<!-- </related-links> -->
105+
94106
</section>
95107

96108
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/base/saxpy/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,8 @@ int main( void ) {
307307
308308
## See Also
309309
310-
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</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 x by a constant and add the result to y.</span>
310+
- <span class="package-name">[`@stdlib/blas/base/daxpy`][@stdlib/blas/base/daxpy]</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>
312312
313313
</section>
314314

‎lib/node_modules/@stdlib/blas/base/sswap/README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,15 @@ int main( void ) {
304304
305305
<section class="related">
306306
307+
* * *
308+
309+
## See Also
310+
311+
- <span class="package-name">[`@stdlib/blas/base/dswap`][@stdlib/blas/base/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
312+
- <span class="package-name">[`@stdlib/blas/base/gswap`][@stdlib/blas/base/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
313+
- <span class="package-name">[`@stdlib/blas/base/scopy`][@stdlib/blas/base/scopy]</span><span class="delimiter">: </span><span class="description">copy values from x into y.</span>
314+
- <span class="package-name">[`@stdlib/blas/sswap`][@stdlib/blas/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
315+
307316
</section>
308317
309318
<!-- /.related -->
@@ -320,6 +329,18 @@ int main( void ) {
320329
321330
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
322331
332+
<!-- <related-links> -->
333+
334+
[@stdlib/blas/base/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dswap
335+
336+
[@stdlib/blas/base/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/gswap
337+
338+
[@stdlib/blas/base/scopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/scopy
339+
340+
[@stdlib/blas/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/sswap
341+
342+
<!-- </related-links> -->
343+
323344
</section>
324345
325346
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/sswap/README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,14 @@ console.log( ndarray2array( y ) );
145145

146146
<section class="related">
147147

148+
* * *
149+
150+
## See Also
151+
152+
- <span class="package-name">[`@stdlib/blas/base/sswap`][@stdlib/blas/base/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
153+
- <span class="package-name">[`@stdlib/blas/dswap`][@stdlib/blas/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
154+
- <span class="package-name">[`@stdlib/blas/gswap`][@stdlib/blas/gswap]</span><span class="delimiter">: </span><span class="description">interchange two vectors.</span>
155+
148156
</section>
149157

150158
<!-- /.related -->
@@ -161,6 +169,14 @@ console.log( ndarray2array( y ) );
161169

162170
[@stdlib/blas/base/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sswap
163171

172+
<!-- <related-links> -->
173+
174+
[@stdlib/blas/dswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/dswap
175+
176+
[@stdlib/blas/gswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/gswap
177+
178+
<!-- </related-links> -->
179+
164180
</section>
165181

166182
<!-- /.links -->

‎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/iter/while-each/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,12 @@ while ( true ) {
220220

221221
<section class="related">
222222

223+
* * *
224+
225+
## See Also
226+
227+
- <span class="package-name">[`@stdlib/iter/until-each`][@stdlib/iter/until-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.</span>
228+
223229
</section>
224230

225231
<!-- /.related -->
@@ -228,6 +234,12 @@ while ( true ) {
228234

229235
<section class="links">
230236

237+
<!-- <related-links> -->
238+
239+
[@stdlib/iter/until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/until-each
240+
241+
<!-- </related-links> -->
242+
231243
</section>
232244

233245
<!-- /.links -->

‎lib/node_modules/@stdlib/lapack/base/dlassq/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ limitations under the License.
2424
2525
<section class="intro">
2626

27-
This routine returns the values $s_{textrm{out}}$ and $\textrm{ss}_{\textrm{out}}$ such that
27+
This routine returns the values $s_{textrm{out}}$ and $\\textrm{ss}_{\\textrm{out}}$ such that
2828

2929
<!-- <equation class="equation" label="eq:sum_of_squares" align="center" raw="s_{\textrm{out}}^2 \cdot \textrm{ss}_{\textrm{out}} = x_0^2 + \ldots + x_{N-1}^2 + s_{\textrm{in}}^2 \cdot \textrm{ss}_{\textrm{in}}" alt="Sum of squares represented in scaled form"> -->
3030

@@ -35,7 +35,7 @@ This routine returns the values $s_{textrm{out}}$ and $\textrm{ss}_{\textrm{out}
3535

3636
<!-- </equation> -->
3737

38-
where $x_i = X_{(i-1) \cdot \textrm{sx}}$ and $\textrm{sx}$ is the stride of `X`. The value of $\textrm{ss}_{\textrm{in}}$ is assumed to be nonnegative.
38+
where $x_i = X_{(i-1) \\cdot \\textrm{sx}}$ and $\\textrm{sx}$ is the stride of `X`. The value of $\\textrm{ss}\_{\\textrm{in}}$ is assumed to be nonnegative.
3939

4040
</section>
4141

0 commit comments

Comments
 (0)