Skip to content

Commit 36539eb

Browse files
committed
Auto-generated commit
1 parent 23aab80 commit 36539eb

File tree

17 files changed

+238
-6
lines changed

17 files changed

+238
-6
lines changed

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838
timeout-minutes: 5
3939
- name: Replace all GitHub links to individual packages with npm links
4040
run: |
41-
find . -type f -name '*.md' -print0 | xargs -0 sed -Ei 's/@stdlib\/([^:]*)\]: https:\/\/github.com\/stdlib-js/@stdlib\/\1\]: https:\/\/www.npmjs.com\/package\/@stdlib/g'
41+
find . -type f -name '*.md' -print0 | xargs -0 sed -Ei '/tree\/main/b; s/@stdlib\/([^:]*)\]: https:\/\/github.com\/stdlib-js/@stdlib\/\1\]: https:\/\/www.npmjs.com\/package\/@stdlib/g'
4242
- name: Replace all stdlib GitHub dependencies with the respective npm packages
4343
run: |
4444
find package.json -type f -print0 | xargs -0 sed -Ei 's/"github:stdlib-js[^"]*"/"^0.0.x"/g'

array/README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,12 @@ str = JSON.stringify( arr.toJSON() );
247247

248248
<section class="related">
249249

250+
* * *
251+
252+
## See Also
253+
254+
- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
255+
250256
</section>
251257

252258
<!-- /.related -->
@@ -257,14 +263,18 @@ str = JSON.stringify( arr.toJSON() );
257263

258264
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray/tree/main/dtypes
259265

260-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
261-
262266
[@stdlib/array/generic]: https://github.com/stdlib-js/array-generic
263267

264268
[@stdlib/array/typed]: https://github.com/stdlib-js/array-typed
265269

266270
[@stdlib/buffer/ctor]: https://github.com/stdlib-js/buffer-ctor
267271

272+
<!-- <related-links> -->
273+
274+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
275+
276+
<!-- </related-links> -->
277+
268278
</section>
269279

270280
<!-- /.links -->

base/ctor/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -643,6 +643,13 @@ str = JSON.stringify( arr.toJSON() );
643643

644644
<section class="related">
645645

646+
* * *
647+
648+
## See Also
649+
650+
- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays.
651+
- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
652+
646653
</section>
647654

648655
<!-- /.related -->
@@ -659,6 +666,14 @@ str = JSON.stringify( arr.toJSON() );
659666

660667
[@stdlib/array/complex128]: https://github.com/stdlib-js/array-complex128
661668

669+
<!-- <related-links> -->
670+
671+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray/tree/main/array
672+
673+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
674+
675+
<!-- </related-links> -->
676+
662677
</section>
663678

664679
<!-- /.links -->

base/napi/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ This package exposes various C APIs to facilitate the creation of Node-API ndarr
9696

9797
<!-- NOTE: please keep in alphabetical order -->
9898

99-
- [`@stdlib/ndarray/base/napi/unary`][@stdlib/ndarray/base/napi/unary]: https://github.com/stdlib-js/ndarray/tree/main/base/napi/unary`][@stdlib/ndarray/base/napi/unary
100-
- [`@stdlib/ndarray/base/unary`][@stdlib/ndarray/base/unary]: https://github.com/stdlib-js/ndarray/tree/main/base/unary`][@stdlib/ndarray/base/unary
101-
- [`@stdlib/ndarray/dtypes`][@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray/tree/main/dtypes`][@stdlib/ndarray/dtypes
99+
- [`@stdlib/ndarray/base/napi/unary`][@stdlib/ndarray/base/napi/unary]: Node-API interfaces and macros for registering one or more [`@stdlib/ndarray/base/unary`][@stdlib/ndarray/base/unary] interfaces with support for multiple dispatch.
100+
- [`@stdlib/ndarray/base/unary`][@stdlib/ndarray/base/unary]: ndarray loops for operating on a single input ndarray and one or more output ndarrays.
101+
- [`@stdlib/ndarray/dtypes`][@stdlib/ndarray/dtypes]: supported ndarray data types.
102102

103103
For API documentation, consult the individual packages.
104104

base/unary/README.md

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

33533353
<section class="related">
33543354

3355+
* * *
3356+
3357+
## See Also
3358+
3359+
- [`@stdlib/ndarray/dispatch`][@stdlib/ndarray/dispatch]: create an ndarray function interface which performs multiple dispatch.
3360+
33553361
</section>
33563362

33573363
<!-- /.related -->
@@ -3360,6 +3366,12 @@ int main() {
33603366

33613367
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
33623368

3369+
<!-- <related-links> -->
3370+
3371+
[@stdlib/ndarray/dispatch]: https://github.com/stdlib-js/ndarray/tree/main/dispatch
3372+
3373+
<!-- </related-links> -->
3374+
33633375
</section>
33643376

33653377
<!-- /.links -->

casting-modes/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,13 @@ bool = isMode( 'beep' );
126126

127127
<section class="related">
128128

129+
* * *
130+
131+
## See Also
132+
133+
- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays.
134+
- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
135+
129136
</section>
130137

131138
<!-- /.related -->
@@ -134,6 +141,14 @@ bool = isMode( 'beep' );
134141

135142
<section class="links">
136143

144+
<!-- <related-links> -->
145+
146+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray/tree/main/array
147+
148+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
149+
150+
<!-- </related-links> -->
151+
137152
</section>
138153

139154
<!-- /.links -->

dispatch/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,13 @@ console.log( ybuf );
251251

252252
<section class="related">
253253

254+
* * *
255+
256+
## See Also
257+
258+
- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays.
259+
- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
260+
254261
</section>
255262

256263
<!-- /.related -->
@@ -259,8 +266,14 @@ console.log( ybuf );
259266

260267
<section class="links">
261268

269+
<!-- <related-links> -->
270+
271+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray/tree/main/array
272+
262273
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
263274

275+
<!-- </related-links> -->
276+
264277
</section>
265278

266279
<!-- /.links -->

dtypes/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,15 @@ bool = isdtype( 'beep' );
128128

129129
<section class="related">
130130

131+
* * *
132+
133+
## See Also
134+
135+
- [`@stdlib/array/dtypes`][@stdlib/array/dtypes]: list of array data types.
136+
- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays.
137+
- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
138+
- [`@stdlib/array/typed-dtypes`][@stdlib/array/typed-dtypes]: list of typed array data types.
139+
131140
</section>
132141

133142
<!-- /.related -->
@@ -136,6 +145,18 @@ bool = isdtype( 'beep' );
136145

137146
<section class="links">
138147

148+
<!-- <related-links> -->
149+
150+
[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes
151+
152+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray/tree/main/array
153+
154+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
155+
156+
[@stdlib/array/typed-dtypes]: https://github.com/stdlib-js/array-typed-dtypes
157+
158+
<!-- </related-links> -->
159+
139160
</section>
140161

141162
<!-- /.links -->

ind2sub/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,14 @@ for ( i = 0; i < len; i++ ) {
181181

182182
<section class="related">
183183

184+
* * *
185+
186+
## See Also
187+
188+
- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays.
189+
- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
190+
- [`@stdlib/ndarray/sub2ind`][@stdlib/ndarray/sub2ind]: convert subscripts to a linear index.
191+
184192
</section>
185193

186194
<!-- /.related -->
@@ -189,6 +197,16 @@ for ( i = 0; i < len; i++ ) {
189197

190198
<section class="links">
191199

200+
<!-- <related-links> -->
201+
202+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray/tree/main/array
203+
204+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
205+
206+
[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray/tree/main/sub2ind
207+
208+
<!-- </related-links> -->
209+
192210
</section>
193211

194212
<!-- /.links -->

index-modes/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,13 @@ bool = isMode( 'beep' );
118118

119119
<section class="related">
120120

121+
* * *
122+
123+
## See Also
124+
125+
- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays.
126+
- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
127+
121128
</section>
122129

123130
<!-- /.related -->
@@ -126,6 +133,14 @@ bool = isMode( 'beep' );
126133

127134
<section class="links">
128135

136+
<!-- <related-links> -->
137+
138+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray/tree/main/array
139+
140+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
141+
142+
<!-- </related-links> -->
143+
129144
</section>
130145

131146
<!-- /.links -->

0 commit comments

Comments
 (0)