Skip to content

Commit 4514170

Browse files
authored
docs: update namespace table of contents
PR-URL: #7162 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent bcfac3b commit 4514170

File tree

6 files changed

+416
-3
lines changed

6 files changed

+416
-3
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ var o = blas;
4848
- <span class="signature">[`caxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/caxpy]</span><span class="delimiter">: </span><span class="description">scale a single-precision complex floating-point vector by a single-precision complex floating-point constant and add the result to a single-precision complex floating-point vector.</span>
4949
- <span class="signature">[`ccopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/ccopy]</span><span class="delimiter">: </span><span class="description">copy values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.</span>
5050
- <span class="signature">[`cscal( N, alpha, x, strideX )`][@stdlib/blas/base/cscal]</span><span class="delimiter">: </span><span class="description">scales a single-precision complex floating-point vector by a single-precision complex floating-point constant.</span>
51-
- <span class="signature">[`csrot( N, cx, strideX, cy, strideY, c, s )`][@stdlib/blas/base/csrot]</span><span class="delimiter">: </span><span class="description">applies a plane rotation.</span>
51+
- <span class="signature">[`csrot( N, x, strideX, y, strideY, c, s )`][@stdlib/blas/base/csrot]</span><span class="delimiter">: </span><span class="description">apply a plane rotation.</span>
52+
- <span class="signature">[`csscal( N, alpha, x, strideX )`][@stdlib/blas/base/csscal]</span><span class="delimiter">: </span><span class="description">scale a single-precision complex floating-point vector by a single-precision floating-point constant.</span>
5253
- <span class="signature">[`cswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/cswap]</span><span class="delimiter">: </span><span class="description">interchange two complex single-precision floating-point vectors.</span>
5354
- <span class="signature">[`dasum( N, x, stride )`][@stdlib/blas/base/dasum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (_L1_ norm).</span>
5455
- <span class="signature">[`daxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant `alpha` and add the result to `y`.</span>
@@ -86,7 +87,7 @@ var o = blas;
8687
- <span class="signature">[`sswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
8788
- <span class="signature">[`zaxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/zaxpy]</span><span class="delimiter">: </span><span class="description">scale a double-precision complex floating-point vector by a double-precision complex floating-point constant and add the result to a double-precision complex floating-point vector.</span>
8889
- <span class="signature">[`zcopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/zcopy]</span><span class="delimiter">: </span><span class="description">copy values from one complex double-precision floating-point vector to another complex double-precision floating-point vector.</span>
89-
- <span class="signature">[`zdrot( N, zx, strideX, zy, strideY, c, s )`][@stdlib/blas/base/zdrot]</span><span class="delimiter">: </span><span class="description">applies a plane rotation.</span>
90+
- <span class="signature">[`zdrot( N, x, strideX, y, strideY, c, s )`][@stdlib/blas/base/zdrot]</span><span class="delimiter">: </span><span class="description">apply a plane rotation.</span>
9091
- <span class="signature">[`zdscal( N, da, zx, strideZX )`][@stdlib/blas/base/zdscal]</span><span class="delimiter">: </span><span class="description">scale a double-precision complex floating-point vector by a double-precision floating-point constant.</span>
9192
- <span class="signature">[`zscal( N, alpha, x, strideX )`][@stdlib/blas/base/zscal]</span><span class="delimiter">: </span><span class="description">scales a double-precision complex floating-point vector by a double-precision complex floating-point constant.</span>
9293
- <span class="signature">[`zswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/zswap]</span><span class="delimiter">: </span><span class="description">interchange two complex double-precision floating-point vectors.</span>
@@ -328,6 +329,8 @@ console.log( objectKeys( blas ) );
328329

329330
[@stdlib/blas/base/csrot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/csrot
330331

332+
[@stdlib/blas/base/csscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/csscal
333+
331334
[@stdlib/blas/base/cswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/cswap
332335

333336
[@stdlib/blas/base/dasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dasum

lib/node_modules/@stdlib/complex/float32/base/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ The namespace contains the following functions:
6161
- <span class="signature">[`identity( z )`][@stdlib/complex/float32/base/identity]</span><span class="delimiter">: </span><span class="description">evaluate the identity function of a single-precision complex floating-point number.</span>
6262
- <span class="signature">[`mul( z1, z2 )`][@stdlib/complex/float32/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two single-precision complex floating-point numbers.</span>
6363
- <span class="signature">[`neg( z )`][@stdlib/complex/float32/base/neg]</span><span class="delimiter">: </span><span class="description">negate a single-precision complex floating-point number.</span>
64+
- <span class="signature">[`scale( alpha, c )`][@stdlib/complex/float32/base/scale]</span><span class="delimiter">: </span><span class="description">scale a single-precision complex floating-point number by a real-valued single-precision floating-point scalar constant.</span>
6465
- <span class="signature">[`sub( z1, z2 )`][@stdlib/complex/float32/base/sub]</span><span class="delimiter">: </span><span class="description">subtract two single-precision complex floating-point numbers.</span>
6566

6667
</div>
@@ -120,6 +121,8 @@ console.log( objectKeys( ns ) );
120121

121122
[@stdlib/complex/float32/base/neg]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/neg
122123

124+
[@stdlib/complex/float32/base/scale]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/scale
125+
123126
[@stdlib/complex/float32/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/sub
124127

125128
[@stdlib/complex/float32/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert

lib/node_modules/@stdlib/math/base/special/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ var fcns = special;
326326
- <span class="signature">[`sqrtpi( x )`][@stdlib/math/base/special/sqrtpi]</span><span class="delimiter">: </span><span class="description">compute the principal square root of the product of π and a positive number.</span>
327327
- <span class="signature">[`tribonacci( n )`][@stdlib/math/base/special/tribonacci]</span><span class="delimiter">: </span><span class="description">compute the nth Tribonacci number.</span>
328328
- <span class="signature">[`trigamma( x )`][@stdlib/math/base/special/trigamma]</span><span class="delimiter">: </span><span class="description">trigamma function.</span>
329-
- <span class="signature">[`wrap( v, min, max )`][@stdlib/math/base/special/wrap]</span><span class="delimiter">: </span><span class="description">wrap a value on the half-open interval `[min,max)`.</span>
329+
- <span class="signature">[`wrap( v, min, max )`][@stdlib/math/base/special/wrap]</span><span class="delimiter">: </span><span class="description">wrap a value to the half-open interval `[min,max)`.</span>
330330

331331
</div>
332332

lib/node_modules/@stdlib/stats/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,13 @@ The namespace further contains functions for computing statistics on arrays as p
8383

8484
<!-- <toc pattern="+(array|strided)"> -->
8585

86+
<div class="namespace-toc">
87+
88+
- <span class="signature">[`array`][@stdlib/stats/array]</span><span class="delimiter">: </span><span class="description">statistical functions for arrays.</span>
89+
- <span class="signature">[`strided`][@stdlib/stats/strided]</span><span class="delimiter">: </span><span class="description">statistical operations for strided arrays.</span>
90+
91+
</div>
92+
8693
<!-- </toc> -->
8794

8895
The `base` sub-namespace contains lower-level statistical functions, including a `dists` namespace containing functions related to a wide assortment of probability distributions.
@@ -165,6 +172,10 @@ console.log( objectKeys( statistics ) );
165172

166173
[@stdlib/stats/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base
167174

175+
[@stdlib/stats/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array
176+
177+
[@stdlib/stats/strided]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided
178+
168179
[@stdlib/stats/incr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr
169180

170181
[@stdlib/stats/iter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/iter

lib/node_modules/@stdlib/stats/array/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,27 @@ The namespace exports the following:
5353

5454
<!-- <toc pattern="*"> -->
5555

56+
<div class="namespace-toc">
57+
58+
- <span class="signature">[`maxBy( x, clbk[, thisArg] )`][@stdlib/stats/array/max-by]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of an array via a callback function.</span>
59+
- <span class="signature">[`max( x )`][@stdlib/stats/array/max]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of an array.</span>
60+
- <span class="signature">[`maxabs( x )`][@stdlib/stats/array/maxabs]</span><span class="delimiter">: </span><span class="description">calculate the maximum absolute value of an array.</span>
61+
- <span class="signature">[`maxsorted( x )`][@stdlib/stats/array/maxsorted]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a sorted array.</span>
62+
- <span class="signature">[`mean( x )`][@stdlib/stats/array/mean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of an array.</span>
63+
- <span class="signature">[`mediansorted( x )`][@stdlib/stats/array/mediansorted]</span><span class="delimiter">: </span><span class="description">calculate the median value of a sorted array.</span>
64+
- <span class="signature">[`minBy( x, clbk[, thisArg] )`][@stdlib/stats/array/min-by]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of an array via a callback function.</span>
65+
- <span class="signature">[`min( x )`][@stdlib/stats/array/min]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of an array.</span>
66+
- <span class="signature">[`minabs( x )`][@stdlib/stats/array/minabs]</span><span class="delimiter">: </span><span class="description">calculate the minimum absolute value of an array.</span>
67+
- <span class="signature">[`minsorted( x )`][@stdlib/stats/array/minsorted]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a sorted array.</span>
68+
- <span class="signature">[`mskmax( x, mask )`][@stdlib/stats/array/mskmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of an array according to a mask.</span>
69+
- <span class="signature">[`mskmin( x, mask )`][@stdlib/stats/array/mskmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of an array according to a mask.</span>
70+
- <span class="signature">[`mskrange( x, mask )`][@stdlib/stats/array/mskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of an array according to a mask.</span>
71+
- <span class="signature">[`nanmax( x )`][@stdlib/stats/array/nanmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of an array, ignoring `NaN` values.</span>
72+
- <span class="signature">[`nanmin( x )`][@stdlib/stats/array/nanmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of an array, ignoring `NaN` values.</span>
73+
- <span class="signature">[`varianceyc( x[, correction] )`][@stdlib/stats/array/varianceyc]</span><span class="delimiter">: </span><span class="description">calculate the variance of an array using a one-pass algorithm proposed by Youngs and Cramer.</span>
74+
75+
</div>
76+
5677
<!-- </toc> -->
5778

5879
</section>
@@ -100,6 +121,42 @@ console.log( objectKeys( ns ) );
100121

101122
<section class="links">
102123

124+
<!-- <toc-links> -->
125+
126+
[@stdlib/stats/array/max-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/max-by
127+
128+
[@stdlib/stats/array/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/max
129+
130+
[@stdlib/stats/array/maxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/maxabs
131+
132+
[@stdlib/stats/array/maxsorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/maxsorted
133+
134+
[@stdlib/stats/array/mean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/mean
135+
136+
[@stdlib/stats/array/mediansorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/mediansorted
137+
138+
[@stdlib/stats/array/min-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/min-by
139+
140+
[@stdlib/stats/array/min]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/min
141+
142+
[@stdlib/stats/array/minabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/minabs
143+
144+
[@stdlib/stats/array/minsorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/minsorted
145+
146+
[@stdlib/stats/array/mskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/mskmax
147+
148+
[@stdlib/stats/array/mskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/mskmin
149+
150+
[@stdlib/stats/array/mskrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/mskrange
151+
152+
[@stdlib/stats/array/nanmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/nanmax
153+
154+
[@stdlib/stats/array/nanmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/nanmin
155+
156+
[@stdlib/stats/array/varianceyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/varianceyc
157+
158+
<!-- </toc-links> -->
159+
103160
</section>
104161

105162
<!-- /.links -->

0 commit comments

Comments
 (0)