Skip to content

Commit 6c6d8bd

Browse files
kgrytekgryte
committed
docs: update links
1 parent 6a6526a commit 6c6d8bd

File tree

10 files changed

+185
-15
lines changed

10 files changed

+185
-15
lines changed

‎lib/node_modules/@stdlib/ndarray/iter/column-entries/README.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,15 @@ while ( true ) {
177177

178178
<section class="related">
179179

180+
* * *
181+
182+
## See Also
183+
184+
- <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>
185+
- <span class="package-name">[`@stdlib/ndarray/iter/entries`][@stdlib/ndarray/iter/entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, value] pairs for each element in a provided ndarray.</span>
186+
- <span class="package-name">[`@stdlib/ndarray/iter/row-entries`][@stdlib/ndarray/iter/row-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, row] pairs for each row in a matrix (or stack of matrices).</span>
187+
- <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>
188+
180189
</section>
181190

182191
<!-- /.related -->
@@ -187,9 +196,19 @@ while ( true ) {
187196

188197
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
189198

190-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
199+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
200+
201+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
202+
203+
<!-- <related-links> -->
204+
205+
[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/columns
206+
207+
[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/entries
208+
209+
[@stdlib/ndarray/iter/row-entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/row-entries
191210

192-
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib
211+
<!-- </related-links> -->
193212

194213
</section>
195214

‎lib/node_modules/@stdlib/ndarray/iter/columns/README.md‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,14 @@ while ( true ) {
175175

176176
<section class="related">
177177

178+
* * *
179+
180+
## See Also
181+
182+
- <span class="package-name">[`@stdlib/ndarray/iter/column-entries`][@stdlib/ndarray/iter/column-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, column] pairs for each column in a matrix (or stack of matrices).</span>
183+
- <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>
184+
- <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>
185+
178186
</section>
179187

180188
<!-- /.related -->
@@ -185,9 +193,17 @@ while ( true ) {
185193

186194
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
187195

188-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
196+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
197+
198+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
199+
200+
<!-- <related-links> -->
201+
202+
[@stdlib/ndarray/iter/column-entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/column-entries
203+
204+
[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/rows
189205

190-
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib
206+
<!-- </related-links> -->
191207

192208
</section>
193209

‎lib/node_modules/@stdlib/ndarray/iter/entries/README.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,14 @@ while ( true ) {
166166

167167
<section class="related">
168168

169+
* * *
170+
171+
## See Also
172+
173+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
174+
- <span class="package-name">[`@stdlib/ndarray/iter/indices`][@stdlib/ndarray/iter/indices]</span><span class="delimiter">: </span><span class="description">create an iterator which returns indices for use indexing into an ndarray having a specified shape.</span>
175+
- <span class="package-name">[`@stdlib/ndarray/iter/values`][@stdlib/ndarray/iter/values]</span><span class="delimiter">: </span><span class="description">create an iterator which returns individual elements from a provided ndarray.</span>
176+
169177
</section>
170178

171179
<!-- /.related -->
@@ -176,7 +184,15 @@ while ( true ) {
176184

177185
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
178186

179-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
187+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
188+
189+
<!-- <related-links> -->
190+
191+
[@stdlib/ndarray/iter/indices]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/indices
192+
193+
[@stdlib/ndarray/iter/values]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/values
194+
195+
<!-- </related-links> -->
180196

181197
</section>
182198

‎lib/node_modules/@stdlib/ndarray/iter/indices/README.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,14 @@ while ( true ) {
163163

164164
<section class="related">
165165

166+
* * *
167+
168+
## See Also
169+
170+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
171+
- <span class="package-name">[`@stdlib/ndarray/iter/entries`][@stdlib/ndarray/iter/entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, value] pairs for each element in a provided ndarray.</span>
172+
- <span class="package-name">[`@stdlib/ndarray/iter/values`][@stdlib/ndarray/iter/values]</span><span class="delimiter">: </span><span class="description">create an iterator which returns individual elements from a provided ndarray.</span>
173+
166174
</section>
167175

168176
<!-- /.related -->
@@ -173,7 +181,15 @@ while ( true ) {
173181

174182
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
175183

176-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
184+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
185+
186+
<!-- <related-links> -->
187+
188+
[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/entries
189+
190+
[@stdlib/ndarray/iter/values]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/values
191+
192+
<!-- </related-links> -->
177193

178194
</section>
179195

‎lib/node_modules/@stdlib/ndarray/iter/matrices/README.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,15 @@ while ( true ) {
169169

170170
<section class="related">
171171

172+
* * *
173+
174+
## See Also
175+
176+
- <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>
177+
- <span class="package-name">[`@stdlib/ndarray/iter/matrix-entries`][@stdlib/ndarray/iter/matrix-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, matrix] pairs for each matrix in a stack of matrices.</span>
178+
- <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>
179+
- <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>
180+
172181
</section>
173182

174183
<!-- /.related -->
@@ -179,9 +188,19 @@ while ( true ) {
179188

180189
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
181190

182-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
191+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
192+
193+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
194+
195+
<!-- <related-links> -->
196+
197+
[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/columns
198+
199+
[@stdlib/ndarray/iter/matrix-entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/matrix-entries
200+
201+
[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/rows
183202

184-
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib
203+
<!-- </related-links> -->
185204

186205
</section>
187206

‎lib/node_modules/@stdlib/ndarray/iter/matrix-entries/README.md‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,16 @@ while ( true ) {
177177

178178
<section class="related">
179179

180+
* * *
181+
182+
## See Also
183+
184+
- <span class="package-name">[`@stdlib/ndarray/iter/column-entries`][@stdlib/ndarray/iter/column-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, column] pairs for each column in a matrix (or stack of matrices).</span>
185+
- <span class="package-name">[`@stdlib/ndarray/iter/entries`][@stdlib/ndarray/iter/entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, value] pairs for each element in a provided ndarray.</span>
186+
- <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>
187+
- <span class="package-name">[`@stdlib/ndarray/iter/row-entries`][@stdlib/ndarray/iter/row-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, row] pairs for each row in a matrix (or stack of matrices).</span>
188+
- <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>
189+
180190
</section>
181191

182192
<!-- /.related -->
@@ -187,9 +197,21 @@ while ( true ) {
187197

188198
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
189199

190-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
200+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
201+
202+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
203+
204+
<!-- <related-links> -->
205+
206+
[@stdlib/ndarray/iter/column-entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/column-entries
207+
208+
[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/entries
209+
210+
[@stdlib/ndarray/iter/matrices]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/matrices
211+
212+
[@stdlib/ndarray/iter/row-entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/row-entries
191213

192-
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib
214+
<!-- </related-links> -->
193215

194216
</section>
195217

‎lib/node_modules/@stdlib/ndarray/iter/row-entries/README.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,15 @@ while ( true ) {
177177

178178
<section class="related">
179179

180+
* * *
181+
182+
## See Also
183+
184+
- <span class="package-name">[`@stdlib/ndarray/iter/column-entries`][@stdlib/ndarray/iter/column-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, column] pairs for each column in a matrix (or stack of matrices).</span>
185+
- <span class="package-name">[`@stdlib/ndarray/iter/entries`][@stdlib/ndarray/iter/entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, value] pairs for each element in a provided ndarray.</span>
186+
- <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>
187+
- <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>
188+
180189
</section>
181190

182191
<!-- /.related -->
@@ -187,9 +196,19 @@ while ( true ) {
187196

188197
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
189198

190-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
199+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
200+
201+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
202+
203+
<!-- <related-links> -->
204+
205+
[@stdlib/ndarray/iter/column-entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/column-entries
206+
207+
[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/entries
208+
209+
[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/rows
191210

192-
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib
211+
<!-- </related-links> -->
193212

194213
</section>
195214

‎lib/node_modules/@stdlib/ndarray/iter/rows/README.md‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,14 @@ while ( true ) {
175175

176176
<section class="related">
177177

178+
* * *
179+
180+
## See Also
181+
182+
- <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>
183+
- <span class="package-name">[`@stdlib/ndarray/iter/row-entries`][@stdlib/ndarray/iter/row-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, row] pairs for each row in a matrix (or stack of matrices).</span>
184+
- <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>
185+
178186
</section>
179187

180188
<!-- /.related -->
@@ -185,9 +193,17 @@ while ( true ) {
185193

186194
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
187195

188-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
196+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
197+
198+
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/slice
199+
200+
<!-- <related-links> -->
201+
202+
[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/columns
203+
204+
[@stdlib/ndarray/iter/row-entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/row-entries
189205

190-
[@stdlib/ndarray/slice]: https://github.com/stdlib-js/stdlib
206+
<!-- </related-links> -->
191207

192208
</section>
193209

‎lib/node_modules/@stdlib/ndarray/iter/to-array-each/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,13 @@ while ( true ) {
135135

136136
<section class="related">
137137

138+
* * *
139+
140+
## See Also
141+
142+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
143+
- <span class="package-name">[`@stdlib/ndarray/to-array`][@stdlib/ndarray/to-array]</span><span class="delimiter">: </span><span class="description">convert an ndarray to a generic array.</span>
144+
138145
</section>
139146

140147
<!-- /.related -->
@@ -149,6 +156,10 @@ while ( true ) {
149156

150157
[@stdlib/ndarray/to-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-array
151158

159+
<!-- <related-links> -->
160+
161+
<!-- </related-links> -->
162+
152163
</section>
153164

154165
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/iter/values/README.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,14 @@ while ( true ) {
165165

166166
<section class="related">
167167

168+
* * *
169+
170+
## See Also
171+
172+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
173+
- <span class="package-name">[`@stdlib/ndarray/iter/entries`][@stdlib/ndarray/iter/entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns \[index, value] pairs for each element in a provided ndarray.</span>
174+
- <span class="package-name">[`@stdlib/ndarray/iter/indices`][@stdlib/ndarray/iter/indices]</span><span class="delimiter">: </span><span class="description">create an iterator which returns indices for use indexing into an ndarray having a specified shape.</span>
175+
168176
</section>
169177

170178
<!-- /.related -->
@@ -175,7 +183,15 @@ while ( true ) {
175183

176184
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
177185

178-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
186+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
187+
188+
<!-- <related-links> -->
189+
190+
[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/entries
191+
192+
[@stdlib/ndarray/iter/indices]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/indices
193+
194+
<!-- </related-links> -->
179195

180196
</section>
181197

0 commit comments

Comments
 (0)