Skip to content

Commit 6b34523

Browse files
kgrytekgryte
committed
docs: update links
1 parent b5b276d commit 6b34523

File tree

26 files changed

+423
-42
lines changed

26 files changed

+423
-42
lines changed

‎lib/node_modules/@stdlib/ndarray/broadcast-array/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,14 @@ for ( i = 0; i < N; i++ ) {
126126

127127
<section class="related">
128128

129+
* * *
130+
131+
## See Also
132+
133+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
134+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
135+
- <span class="package-name">[`@stdlib/ndarray/maybe-broadcast-array`][@stdlib/ndarray/maybe-broadcast-array]</span><span class="delimiter">: </span><span class="description">broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.</span>
136+
129137
</section>
130138

131139
<!-- /.related -->
@@ -138,6 +146,14 @@ for ( i = 0; i < N; i++ ) {
138146

139147
[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
140148

149+
<!-- <related-links> -->
150+
151+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
152+
153+
[@stdlib/ndarray/maybe-broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array
154+
155+
<!-- </related-links> -->
156+
141157
</section>
142158

143159
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/ctor/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -3540,6 +3540,7 @@ int main( void ) {
35403540
## See Also
35413541

35423542
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
3543+
- <span class="package-name">[`@stdlib/ndarray/fancy`][@stdlib/ndarray/fancy]</span><span class="delimiter">: </span><span class="description">fancy multidimensional array constructor.</span>
35433544

35443545
</section>
35453546

@@ -3561,6 +3562,8 @@ int main( void ) {
35613562

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

3565+
[@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy
3566+
35643567
<!-- </related-links> -->
35653568

35663569
</section>

‎lib/node_modules/@stdlib/ndarray/data-buffer/README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,14 @@ buf = data( x );
137137

138138
<section class="related">
139139

140+
* * *
141+
142+
## See Also
143+
144+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
145+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
146+
- <span class="package-name">[`@stdlib/ndarray/dtype`][@stdlib/ndarray/dtype]</span><span class="delimiter">: </span><span class="description">return the data type of a provided ndarray.</span>
147+
140148
</section>
141149

142150
<!-- /.related -->
@@ -145,7 +153,15 @@ buf = data( x );
145153

146154
<section class="links">
147155

148-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
156+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
157+
158+
<!-- <related-links> -->
159+
160+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
161+
162+
[@stdlib/ndarray/dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtype
163+
164+
<!-- </related-links> -->
149165

150166
</section>
151167

‎lib/node_modules/@stdlib/ndarray/dispatch-by/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,11 @@ console.log( 'TODO' );
183183

184184
<section class="links">
185185

186-
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib
186+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
187187

188-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
188+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
189189

190-
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib
190+
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
191191

192192
<!-- <related-links> -->
193193

‎lib/node_modules/@stdlib/ndarray/dispatch/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -266,11 +266,11 @@ console.log( ybuf );
266266

267267
<section class="links">
268268

269-
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib
269+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
270270

271-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
271+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
272272

273-
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib
273+
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
274274

275275
<!-- <related-links> -->
276276

‎lib/node_modules/@stdlib/ndarray/dtype/README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,14 @@ for ( i = 0; i < slices.length; i++ ) {
132132

133133
<section class="related">
134134

135+
* * *
136+
137+
## See Also
138+
139+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
140+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
141+
- <span class="package-name">[`@stdlib/ndarray/dtypes`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
142+
135143
</section>
136144

137145
<!-- /.related -->
@@ -140,9 +148,15 @@ for ( i = 0; i < slices.length; i++ ) {
140148

141149
<section class="links">
142150

143-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
151+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
152+
153+
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
154+
155+
<!-- <related-links> -->
156+
157+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
144158

145-
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib
159+
<!-- </related-links> -->
146160

147161
</section>
148162

‎lib/node_modules/@stdlib/ndarray/empty-like/README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,13 @@ for ( i = 0; i < dt.length; i++ ) {
153153

154154
<section class="related">
155155

156+
* * *
157+
158+
## See Also
159+
160+
- <span class="package-name">[`@stdlib/ndarray/empty`][@stdlib/ndarray/empty]</span><span class="delimiter">: </span><span class="description">create an uninitialized ndarray having a specified shape and data type.</span>
161+
- <span class="package-name">[`@stdlib/ndarray/zeros-like`][@stdlib/ndarray/zeros-like]</span><span class="delimiter">: </span><span class="description">create a zero-filled ndarray having the same shape and data type as a provided ndarray.</span>
162+
156163
</section>
157164

158165
<!-- /.related -->
@@ -161,9 +168,17 @@ for ( i = 0; i < dt.length; i++ ) {
161168

162169
<section class="links">
163170

164-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
171+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
172+
173+
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
174+
175+
<!-- <related-links> -->
176+
177+
[@stdlib/ndarray/empty]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty
178+
179+
[@stdlib/ndarray/zeros-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/zeros-like
165180

166-
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib
181+
<!-- </related-links> -->
167182

168183
</section>
169184

‎lib/node_modules/@stdlib/ndarray/empty/README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,13 @@ for ( i = 0; i < dt.length; i++ ) {
149149

150150
<section class="related">
151151

152+
* * *
153+
154+
## See Also
155+
156+
- <span class="package-name">[`@stdlib/ndarray/empty-like`][@stdlib/ndarray/empty-like]</span><span class="delimiter">: </span><span class="description">create an uninitialized ndarray having the same shape and data type as a provided ndarray.</span>
157+
- <span class="package-name">[`@stdlib/ndarray/zeros`][@stdlib/ndarray/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled ndarray having a specified shape and data type.</span>
158+
152159
</section>
153160

154161
<!-- /.related -->
@@ -157,9 +164,17 @@ for ( i = 0; i < dt.length; i++ ) {
157164

158165
<section class="links">
159166

160-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
167+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
168+
169+
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
170+
171+
<!-- <related-links> -->
172+
173+
[@stdlib/ndarray/empty-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty-like
174+
175+
[@stdlib/ndarray/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/zeros
161176

162-
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib
177+
<!-- </related-links> -->
163178

164179
</section>
165180

‎lib/node_modules/@stdlib/ndarray/fancy/README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -763,6 +763,13 @@ console.log( toArray( y4 ) );
763763

764764
<section class="related">
765765

766+
* * *
767+
768+
## See Also
769+
770+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
771+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
772+
766773
</section>
767774

768775
<!-- /.related -->
@@ -785,7 +792,14 @@ console.log( toArray( y4 ) );
785792

786793
[@stdlib/proxy/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/proxy/ctor
787794

795+
<!-- <related-links> -->
796+
797+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
798+
799+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
800+
801+
<!-- </related-links> -->
802+
788803
</section>
789804

790805
<!-- /.links -->
791-

‎lib/node_modules/@stdlib/ndarray/from-scalar/README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,13 @@ for ( i = 0; i < dt.length; i++ ) {
146146

147147
<section class="related">
148148

149+
* * *
150+
151+
## See Also
152+
153+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
154+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
155+
149156
</section>
150157

151158
<!-- /.related -->
@@ -154,9 +161,15 @@ for ( i = 0; i < dt.length; i++ ) {
154161

155162
<section class="links">
156163

157-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
164+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
165+
166+
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
167+
168+
<!-- <related-links> -->
169+
170+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
158171

159-
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib
172+
<!-- </related-links> -->
160173

161174
</section>
162175

‎lib/node_modules/@stdlib/ndarray/maybe-broadcast-array/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,14 @@ for ( i = 0; i < N; i++ ) {
126126

127127
<section class="related">
128128

129+
* * *
130+
131+
## See Also
132+
133+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
134+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
135+
- <span class="package-name">[`@stdlib/ndarray/broadcast-array`][@stdlib/ndarray/broadcast-array]</span><span class="delimiter">: </span><span class="description">broadcast an ndarray to a specified shape.</span>
136+
129137
</section>
130138

131139
<!-- /.related -->
@@ -138,6 +146,14 @@ for ( i = 0; i < N; i++ ) {
138146

139147
[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
140148

149+
<!-- <related-links> -->
150+
151+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
152+
153+
[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-array
154+
155+
<!-- </related-links> -->
156+
141157
</section>
142158

143159
<!-- /.links -->

‎lib/node_modules/@stdlib/ndarray/mostly-safe-casts/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ for ( i = 0; i < DTYPES.length; i++ ) {
127127

128128
- <span class="package-name">[`@stdlib/ndarray/casting-modes`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</span>
129129
- <span class="package-name">[`@stdlib/ndarray/dtypes`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
130+
- <span class="package-name">[`@stdlib/ndarray/safe-casts`][@stdlib/ndarray/safe-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast.</span>
130131
- <span class="package-name">[`@stdlib/ndarray/same-kind-casts`][@stdlib/ndarray/same-kind-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same kind.</span>
131132

132133
</section>
@@ -143,6 +144,8 @@ for ( i = 0; i < DTYPES.length; i++ ) {
143144

144145
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
145146

147+
[@stdlib/ndarray/safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/safe-casts
148+
146149
[@stdlib/ndarray/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/same-kind-casts
147150

148151
<!-- </related-links> -->

‎lib/node_modules/@stdlib/ndarray/ndims/README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,15 @@ for ( i = 0; i < slices.length; i++ ) {
130130

131131
<section class="related">
132132

133+
* * *
134+
135+
## See Also
136+
137+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
138+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
139+
- <span class="package-name">[`@stdlib/ndarray/numel`][@stdlib/ndarray/numel]</span><span class="delimiter">: </span><span class="description">return the number of elements in an ndarray.</span>
140+
- <span class="package-name">[`@stdlib/ndarray/shape`][@stdlib/ndarray/shape]</span><span class="delimiter">: </span><span class="description">return the shape of a provided ndarray.</span>
141+
133142
</section>
134143

135144
<!-- /.related -->
@@ -138,7 +147,17 @@ for ( i = 0; i < slices.length; i++ ) {
138147

139148
<section class="links">
140149

141-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
150+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
151+
152+
<!-- <related-links> -->
153+
154+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
155+
156+
[@stdlib/ndarray/numel]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/numel
157+
158+
[@stdlib/ndarray/shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/shape
159+
160+
<!-- </related-links> -->
142161

143162
</section>
144163

‎lib/node_modules/@stdlib/ndarray/numel/README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,13 @@ for ( i = 0; i < slices.length; i++ ) {
130130

131131
<section class="related">
132132

133+
* * *
134+
135+
## See Also
136+
137+
- <span class="package-name">[`@stdlib/ndarray/array`][@stdlib/ndarray/array]</span><span class="delimiter">: </span><span class="description">multidimensional arrays.</span>
138+
- <span class="package-name">[`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]</span><span class="delimiter">: </span><span class="description">multidimensional array constructor.</span>
139+
133140
</section>
134141

135142
<!-- /.related -->
@@ -138,7 +145,13 @@ for ( i = 0; i < slices.length; i++ ) {
138145

139146
<section class="links">
140147

141-
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib
148+
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
149+
150+
<!-- <related-links> -->
151+
152+
[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array
153+
154+
<!-- </related-links> -->
142155

143156
</section>
144157

0 commit comments

Comments
 (0)