Skip to content

Commit f231799

Browse files
authored
docs: update related packages sections
PR-URL: #4545 Reviewed-by: Athan Reines <[email protected]>
1 parent c4d642d commit f231799

File tree

5 files changed

+68
-5
lines changed

5 files changed

+68
-5
lines changed

lib/node_modules/@stdlib/array/base/ones4d/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,17 @@ out = ones4d( [ 1, 1, 3, 1 ] );
9595

9696
<section class="related">
9797

98+
* * *
99+
100+
## See Also
101+
102+
- <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>
103+
- <span class="package-name">[`@stdlib/array/base/ones`][@stdlib/array/base/ones]</span><span class="delimiter">: </span><span class="description">create a generic array filled with ones.</span>
104+
- <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>
105+
- <span class="package-name">[`@stdlib/array/base/ones3d`][@stdlib/array/base/ones3d]</span><span class="delimiter">: </span><span class="description">create a three-dimensional nested array filled with ones.</span>
106+
- <span class="package-name">[`@stdlib/array/base/ones5d`][@stdlib/array/base/ones5d]</span><span class="delimiter">: </span><span class="description">create a five-dimensional nested array filled with ones.</span>
107+
- <span class="package-name">[`@stdlib/array/base/onesnd`][@stdlib/array/base/onesnd]</span><span class="delimiter">: </span><span class="description">create an n-dimensional nested array filled with ones.</span>
108+
98109
</section>
99110

100111
<!-- /.related -->
@@ -103,6 +114,22 @@ out = ones4d( [ 1, 1, 3, 1 ] );
103114

104115
<section class="links">
105116

117+
<!-- <related-links> -->
118+
119+
[@stdlib/array/base/zeros4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/zeros4d
120+
121+
[@stdlib/array/base/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones
122+
123+
[@stdlib/array/base/ones2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones2d
124+
125+
[@stdlib/array/base/ones3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones3d
126+
127+
[@stdlib/array/base/ones5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/ones5d
128+
129+
[@stdlib/array/base/onesnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/onesnd
130+
131+
<!-- </related-links> -->
132+
106133
</section>
107134

108135
<!-- /.links -->

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,10 @@ console.log( v );
176176

177177
## See Also
178178

179-
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumpw`][@stdlib/blas/ext/base/dapxsumpw]</span><span class="delimiter">: </span><span class="description">adds a constant to each double-precision floating-point strided array element and computes the sum using pairwise summation.</span>
180-
- <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>
179+
- <span class="package-name">[`@stdlib/blas/ext/base/dapxsumpw`][@stdlib/blas/ext/base/dapxsumpw]</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 using pairwise summation.</span>
180+
- <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>
181181
- <span class="package-name">[`@stdlib/blas/ext/base/gsumpw`][@stdlib/blas/ext/base/gsumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using pairwise summation.</span>
182-
- <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>
182+
- <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>
183183

184184
</section>
185185

lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,8 @@ Macro for the maximum base 10 exponent for a [single-precision floating-point nu
130130

131131
## See Also
132132

133-
- <span class="package-name">[`@stdlib/constants/float32/max-base2-exponent`][@stdlib/constants/float32/max-base2-exponent]</span><span class="delimiter">: </span><span class="description">the maximum biased base 2 exponent for a single-precision floating-point number.</span>
133+
- <span class="package-name">[`@stdlib/constants/float32/max-base10-exponent-subnormal`][@stdlib/constants/float32/max-base10-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the maximum base 10 exponent for a subnormal single-precision floating-point number.</span>
134+
- <span class="package-name">[`@stdlib/constants/float64/max-base10-exponent`][@stdlib/constants/float64/max-base10-exponent]</span><span class="delimiter">: </span><span class="description">the maximum base 10 exponent for a double-precision floating-point number.</span>
134135

135136
</section>
136137

@@ -144,7 +145,9 @@ Macro for the maximum base 10 exponent for a [single-precision floating-point nu
144145

145146
<!-- <related-links> -->
146147

147-
[@stdlib/constants/float32/max-base2-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base2-exponent
148+
[@stdlib/constants/float32/max-base10-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base10-exponent-subnormal
149+
150+
[@stdlib/constants/float64/max-base10-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/max-base10-exponent
148151

149152
<!-- </related-links> -->
150153

lib/node_modules/@stdlib/constants/float32/min-base10-exponent-subnormal/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,13 @@ Macro for the minimum base 10 exponent for a subnormal [single-precision floatin
126126

127127
<section class="related">
128128

129+
* * *
130+
131+
## See Also
132+
133+
- <span class="package-name">[`@stdlib/constants/float32/min-base10-exponent`][@stdlib/constants/float32/min-base10-exponent]</span><span class="delimiter">: </span><span class="description">the minimum base 10 exponent for a normal single-precision floating-point number.</span>
134+
- <span class="package-name">[`@stdlib/constants/float64/min-base10-exponent-subnormal`][@stdlib/constants/float64/min-base10-exponent-subnormal]</span><span class="delimiter">: </span><span class="description">the minimum base 10 exponent for a subnormal double-precision floating-point number.</span>
135+
129136
</section>
130137

131138
<!-- /.related -->
@@ -138,6 +145,10 @@ Macro for the minimum base 10 exponent for a subnormal [single-precision floatin
138145

139146
<!-- <related-links> -->
140147

148+
[@stdlib/constants/float32/min-base10-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base10-exponent
149+
150+
[@stdlib/constants/float64/min-base10-exponent-subnormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/min-base10-exponent-subnormal
151+
141152
<!-- </related-links> -->
142153

143154
</section>

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,16 @@ while ( true ) {
170170

171171
<section class="related">
172172

173+
* * *
174+
175+
## See Also
176+
177+
- <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>
178+
- <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>
179+
- <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>
180+
- <span class="package-name">[`@stdlib/ndarray/iter/stacks`][@stdlib/ndarray/iter/stacks]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions.</span>
181+
- <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>
182+
173183
</section>
174184

175185
<!-- /.related -->
@@ -184,6 +194,18 @@ while ( true ) {
184194

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

197+
<!-- <related-links> -->
198+
199+
[@stdlib/ndarray/iter/columns]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/columns
200+
201+
[@stdlib/ndarray/iter/matrices]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/matrices
202+
203+
[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/rows
204+
205+
[@stdlib/ndarray/iter/stacks]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter/stacks
206+
207+
<!-- </related-links> -->
208+
187209
</section>
188210

189211
<!-- /.links -->

0 commit comments

Comments
 (0)