Auto-generated commit

stdlib-js · Nov 9, 2023 · 17b2189 · 17b2189
1 parent 5431cd1
commit 17b2189
Show file tree

Hide file tree

Showing 10 changed files with 170 additions and 0 deletions.
diff --git a/iter/column-entries/README.md b/iter/column-entries/README.md
@@ -177,6 +177,15 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -191,6 +200,16 @@ while ( true ) {
 
 [@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/ndarray/tree/main/iter/columns
+
+[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/entries
+
+[@stdlib/ndarray/iter/row-entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/row-entries
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/columns/README.md b/iter/columns/README.md
@@ -175,6 +175,14 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -189,6 +197,14 @@ while ( true ) {
 
 [@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/column-entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/column-entries
+
+[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/ndarray/tree/main/iter/rows
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/entries/README.md b/iter/entries/README.md
@@ -166,6 +166,14 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -178,6 +186,14 @@ while ( true ) {
 
 [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/indices]: https://github.com/stdlib-js/ndarray/tree/main/iter/indices
+
+[@stdlib/ndarray/iter/values]: https://github.com/stdlib-js/ndarray/tree/main/iter/values
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/indices/README.md b/iter/indices/README.md
@@ -163,6 +163,14 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -175,6 +183,14 @@ while ( true ) {
 
 [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/entries
+
+[@stdlib/ndarray/iter/values]: https://github.com/stdlib-js/ndarray/tree/main/iter/values
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/matrices/README.md b/iter/matrices/README.md
@@ -169,6 +169,15 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -183,6 +192,16 @@ while ( true ) {
 
 [@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/ndarray/tree/main/iter/columns
+
+[@stdlib/ndarray/iter/matrix-entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/matrix-entries
+
+[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/ndarray/tree/main/iter/rows
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/matrix-entries/README.md b/iter/matrix-entries/README.md
@@ -177,6 +177,16 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -191,6 +201,18 @@ while ( true ) {
 
 [@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/column-entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/column-entries
+
+[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/entries
+
+[@stdlib/ndarray/iter/matrices]: https://github.com/stdlib-js/ndarray/tree/main/iter/matrices
+
+[@stdlib/ndarray/iter/row-entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/row-entries
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/row-entries/README.md b/iter/row-entries/README.md
@@ -177,6 +177,15 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -191,6 +200,16 @@ while ( true ) {
 
 [@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/column-entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/column-entries
+
+[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/entries
+
+[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/ndarray/tree/main/iter/rows
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/rows/README.md b/iter/rows/README.md
@@ -175,6 +175,14 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <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>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -189,6 +197,14 @@ while ( true ) {
 
 [@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/ndarray/tree/main/iter/columns
+
+[@stdlib/ndarray/iter/row-entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/row-entries
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/to-array-each/README.md b/iter/to-array-each/README.md
@@ -135,6 +135,13 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -149,6 +156,10 @@ while ( true ) {
 
 [@stdlib/ndarray/to-array]: https://github.com/stdlib-js/ndarray/tree/main/to-array
 
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->
diff --git a/iter/values/README.md b/iter/values/README.md
@@ -165,6 +165,14 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
+-   <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>
+-   <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>
+
 </section>
 
 <!-- /.related -->
@@ -177,6 +185,14 @@ while ( true ) {
 
 [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
 
+<!-- <related-links> -->
+
+[@stdlib/ndarray/iter/entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/entries
+
+[@stdlib/ndarray/iter/indices]: https://github.com/stdlib-js/ndarray/tree/main/iter/indices
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->