docs: update namespace table of contents

PR-URL: #1213 Signed-off-by: stdlib-bot <[email protected]> Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
stdlib-js · Dec 26, 2023 · 5184bd0 · 5184bd0 · stdlib-bot · Dec 26, 2023
1 parent 4ef9ce3
commit 5184bd0
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 0 deletions.
diff --git a/lib/node_modules/@stdlib/blas/base/README.md b/lib/node_modules/@stdlib/blas/base/README.md
@@ -52,6 +52,7 @@ var o = blas;
 -   <span class="signature">[`dcopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/dcopy]</span><span class="delimiter">: </span><span class="description">copy values from `x` into `y`.</span>
 -   <span class="signature">[`ddot( N, x, strideX, y, strideY )`][@stdlib/blas/base/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two double-precision floating-point vectors.</span>
 -   <span class="signature">[`dnrm2( N, x, stride )`][@stdlib/blas/base/dnrm2]</span><span class="delimiter">: </span><span class="description">calculate the L2-norm of a double-precision floating-point vector.</span>
+-   <span class="signature">[`drotg( a, b )`][@stdlib/blas/base/drotg]</span><span class="delimiter">: </span><span class="description">construct a Givens plane rotation.</span>
 -   <span class="signature">[`dscal( N, alpha, x, stride )`][@stdlib/blas/base/dscal]</span><span class="delimiter">: </span><span class="description">multiply a double-precision floating-point vector `x` by a constant `alpha`.</span>
 -   <span class="signature">[`dsdot( N, x, strideX, y, strideY )`][@stdlib/blas/base/dsdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product with extended accumulation and result of two single-precision floating-point vectors.</span>
 -   <span class="signature">[`dswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/dswap]</span><span class="delimiter">: </span><span class="description">interchange two double-precision floating-point vectors.</span>
@@ -80,6 +81,8 @@ var o = blas;
 
 <!-- <toc pattern="+(*amax|*lsame|*xerbla*)"> -->
 
+
+
 <!-- </toc> -->
 
 </section>
@@ -133,6 +136,8 @@ console.log( objectKeys( blas ) );
 
 [@stdlib/blas/base/dnrm2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dnrm2
 
+[@stdlib/blas/base/drotg]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/drotg
+
 [@stdlib/blas/base/dscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dscal
 
 [@stdlib/blas/base/dsdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dsdot

diff --git a/lib/node_modules/@stdlib/iter/README.md b/lib/node_modules/@stdlib/iter/README.md
@@ -98,6 +98,7 @@ var keys = objectKeys( ns );
 -   <span class="signature">[`iterUnique( iterator )`][@stdlib/iter/unique]</span><span class="delimiter">: </span><span class="description">create an iterator which returns unique values.</span>
 -   <span class="signature">[`iterUnitspace( start[, stop] )`][@stdlib/iter/unitspace]</span><span class="delimiter">: </span><span class="description">create an iterator which returns numbers incremented by `1`.</span>
 -   <span class="signature">[`iterUnshift( iterator, ...items )`][@stdlib/iter/unshift]</span><span class="delimiter">: </span><span class="description">create an iterator which prepends values to the beginning of a provided iterator.</span>
+-   <span class="signature">[`whileEach( iterator, predicate, fcn[, thisArg] )`][@stdlib/iter/while-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value.</span>
 
 </div>
 
@@ -304,6 +305,8 @@ while ( true ) {
 
 [@stdlib/iter/unshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/unshift
 
+[@stdlib/iter/while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/while-each
+
 <!-- </toc-links> -->
 
 </section>

diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md
@@ -75,6 +75,7 @@ In addition, the namespace contains the following multidimensional array utility
 -   <span class="signature">[`ndarrayCastingModes()`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</span>
 -   <span class="signature">[`ndarrayDataBuffer( x )`][@stdlib/ndarray/data-buffer]</span><span class="delimiter">: </span><span class="description">return the underlying data buffer of a provided ndarray.</span>
 -   <span class="signature">[`defaults()`][@stdlib/ndarray/defaults]</span><span class="delimiter">: </span><span class="description">default ndarray settings.</span>
+-   <span class="signature">[`dispatchBy( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch-by]</span><span class="delimiter">: </span><span class="description">create an ndarray function interface which performs multiple dispatch.</span>
 -   <span class="signature">[`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]</span><span class="delimiter">: </span><span class="description">create an ndarray function interface which performs multiple dispatch.</span>
 -   <span class="signature">[`ndarrayDataType( x )`][@stdlib/ndarray/dtype]</span><span class="delimiter">: </span><span class="description">return the data type of a provided ndarray.</span>
 -   <span class="signature">[`ndarrayDataTypes( [kind] )`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
@@ -161,6 +162,8 @@ console.log( objectKeys( ns ) );
 
 [@stdlib/ndarray/defaults]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/defaults
 
+[@stdlib/ndarray/dispatch-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dispatch-by
+
 [@stdlib/ndarray/dispatch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dispatch
 
 [@stdlib/ndarray/dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtype

diff --git a/lib/node_modules/@stdlib/random/array/README.md b/lib/node_modules/@stdlib/random/array/README.md
@@ -52,6 +52,7 @@ The namespace contains the following:
 -   <span class="signature">[`discreteUniform( len, a, b[, options] )`][@stdlib/random/array/discrete-uniform]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a discrete uniform distribution.</span>
 -   <span class="signature">[`exponential( len, lambda[, options] )`][@stdlib/random/array/exponential]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an exponential distribution.</span>
 -   <span class="signature">[`gamma( len, alpha, beta[, options] )`][@stdlib/random/array/gamma]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a gamma distribution.</span>
+-   <span class="signature">[`geometric( len, p[, options] )`][@stdlib/random/array/geometric]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an geometric distribution.</span>
 -   <span class="signature">[`invgamma( len, alpha, beta[, options] )`][@stdlib/random/array/invgamma]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from an inverse gamma distribution.</span>
 -   <span class="signature">[`lognormal( len, mu, sigma[, options] )`][@stdlib/random/array/lognormal]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers drawn from a lognormal distribution.</span>
 -   <span class="signature">[`minstdShuffle( len[, options] )`][@stdlib/random/array/minstd-shuffle]</span><span class="delimiter">: </span><span class="description">create an array containing pseudorandom numbers generated using a linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span>
@@ -116,6 +117,8 @@ console.log( objectKeys( ns ) );
 
 [@stdlib/random/array/gamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/gamma
 
+[@stdlib/random/array/geometric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/geometric
+
 [@stdlib/random/array/invgamma]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/invgamma
 
 [@stdlib/random/array/lognormal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/lognormal

diff --git a/lib/node_modules/@stdlib/string/README.md b/lib/node_modules/@stdlib/string/README.md
@@ -63,6 +63,7 @@ The namespace exposes the following string manipulation functions:
 -   <span class="signature">[`ltrimN( str, n[, chars] )`][@stdlib/string/left-trim-n]</span><span class="delimiter">: </span><span class="description">trim `n` characters from the end of a string.</span>
 -   <span class="signature">[`ltrim( str )`][@stdlib/string/left-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning of a string.</span>
 -   <span class="signature">[`lowercase( str )`][@stdlib/string/lowercase]</span><span class="delimiter">: </span><span class="description">convert a string to lowercase.</span>
+-   <span class="signature">[`nextCodePointIndex( string[, fromIndex] )`][@stdlib/string/next-code-point-index]</span><span class="delimiter">: </span><span class="description">return the position of the next Unicode code point in a string after a specified position.</span>
 -   <span class="signature">[`nextGraphemeClusterBreak( string[, fromIndex] )`][@stdlib/string/next-grapheme-cluster-break]</span><span class="delimiter">: </span><span class="description">return the next extended grapheme cluster break in a string after a specified position.</span>
 -   <span class="signature">[`numGraphemeClusters( str )`][@stdlib/string/num-grapheme-clusters]</span><span class="delimiter">: </span><span class="description">return the number of grapheme clusters in a string.</span>
 -   <span class="signature">[`num2words( value[, options] )`][@stdlib/string/num2words]</span><span class="delimiter">: </span><span class="description">convert a number to a word representation.</span>
@@ -176,6 +177,8 @@ console.log( getKeys( string ) );
 
 [@stdlib/string/lowercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/lowercase
 
+[@stdlib/string/next-code-point-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/next-code-point-index
+
 [@stdlib/string/next-grapheme-cluster-break]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/next-grapheme-cluster-break
 
 [@stdlib/string/num-grapheme-clusters]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/num-grapheme-clusters

diff --git a/lib/node_modules/@stdlib/string/base/README.md b/lib/node_modules/@stdlib/string/base/README.md
@@ -45,6 +45,7 @@ The namespace contains the following functions:
 
 <div class="namespace-toc">
 
+-   <span class="signature">[`altcase( str )`][@stdlib/string/base/altcase]</span><span class="delimiter">: </span><span class="description">convert a string to alternate case.</span>
 -   <span class="signature">[`camelcase( str )`][@stdlib/string/base/camelcase]</span><span class="delimiter">: </span><span class="description">convert a string to camel case.</span>
 -   <span class="signature">[`capitalize( str )`][@stdlib/string/base/capitalize]</span><span class="delimiter">: </span><span class="description">capitalize the first character in a string.</span>
 -   <span class="signature">[`codePointAt( string, position, backward )`][@stdlib/string/base/code-point-at]</span><span class="delimiter">: </span><span class="description">return a Unicode code point from a string at a specified position.</span>
@@ -71,15 +72,22 @@ The namespace contains the following functions:
 -   <span class="signature">[`removeFirstCodePoint( str, n )`][@stdlib/string/base/remove-first-code-point]</span><span class="delimiter">: </span><span class="description">remove the first `n` Unicode code points of a string.</span>
 -   <span class="signature">[`removeFirstGraphemeCluster( str, n )`][@stdlib/string/base/remove-first-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">remove the first `n` grapheme clusters (i.e., user-perceived characters) of a string.</span>
 -   <span class="signature">[`removeFirst( str, n )`][@stdlib/string/base/remove-first]</span><span class="delimiter">: </span><span class="description">remove the first `n` UTF-16 code units of a string.</span>
+-   <span class="signature">[`removeLastCodePoint( str, n )`][@stdlib/string/base/remove-last-code-point]</span><span class="delimiter">: </span><span class="description">remove the last `n` Unicode code points of a string.</span>
+-   <span class="signature">[`removeLastGraphemeCluster( str, n )`][@stdlib/string/base/remove-last-grapheme-cluster]</span><span class="delimiter">: </span><span class="description">remove the last `n` grapheme clusters (i.e., user-perceived characters) of a string.</span>
+-   <span class="signature">[`removeLast( str, n )`][@stdlib/string/base/remove-last]</span><span class="delimiter">: </span><span class="description">remove the last `n` UTF-16 code units of a string.</span>
 -   <span class="signature">[`repeat( str, n )`][@stdlib/string/base/repeat]</span><span class="delimiter">: </span><span class="description">repeat a string a specified number of times and return the concatenated result.</span>
 -   <span class="signature">[`replaceBefore( str, search, replacement )`][@stdlib/string/base/replace-before]</span><span class="delimiter">: </span><span class="description">replace the substring before the first occurrence of a specified search string.</span>
 -   <span class="signature">[`replace( str, search, newval )`][@stdlib/string/base/replace]</span><span class="delimiter">: </span><span class="description">replace search occurrences with a replacement string.</span>
+-   <span class="signature">[`reverseCodePoints( str )`][@stdlib/string/base/reverse-code-points]</span><span class="delimiter">: </span><span class="description">reverse the Unicode code points of a string.</span>
+-   <span class="signature">[`reverseGraphemeClusters( str )`][@stdlib/string/base/reverse-grapheme-clusters]</span><span class="delimiter">: </span><span class="description">reverse the grapheme clusters (i.e., user-perceived characters) of a string.</span>
+-   <span class="signature">[`reverse( str )`][@stdlib/string/base/reverse]</span><span class="delimiter">: </span><span class="description">reverse the UTF-16 code units of a string.</span>
 -   <span class="signature">[`rpad( str, len, pad )`][@stdlib/string/base/right-pad]</span><span class="delimiter">: </span><span class="description">right pad a string.</span>
 -   <span class="signature">[`rtrim( str )`][@stdlib/string/base/right-trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the end of a string.</span>
 -   <span class="signature">[`snakecase( str )`][@stdlib/string/base/snakecase]</span><span class="delimiter">: </span><span class="description">convert a string to snake case.</span>
 -   <span class="signature">[`startcase( str )`][@stdlib/string/base/startcase]</span><span class="delimiter">: </span><span class="description">capitalize the first letter of each word in a string.</span>
 -   <span class="signature">[`startsWith( str, search, position )`][@stdlib/string/base/starts-with]</span><span class="delimiter">: </span><span class="description">test if a string starts with the characters of another string.</span>
 -   <span class="signature">[`trim( str )`][@stdlib/string/base/trim]</span><span class="delimiter">: </span><span class="description">trim whitespace characters from the beginning and end of a string.</span>
+-   <span class="signature">[`truncateMiddle( str, len, seq )`][@stdlib/string/base/truncate-middle]</span><span class="delimiter">: </span><span class="description">truncate the middle UTF-16 code units of a string to return a string having a specified length.</span>
 -   <span class="signature">[`uncapitalize( str )`][@stdlib/string/base/uncapitalize]</span><span class="delimiter">: </span><span class="description">uncapitalize the first character of a string.</span>
 -   <span class="signature">[`uppercase( str )`][@stdlib/string/base/uppercase]</span><span class="delimiter">: </span><span class="description">convert a string to uppercase.</span>
 
@@ -156,6 +164,8 @@ str = ns.trim( str );
 
 <!-- <toc-links> -->
 
+[@stdlib/string/base/altcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/altcase
+
 [@stdlib/string/base/camelcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/camelcase
 
 [@stdlib/string/base/capitalize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/capitalize
@@ -208,12 +218,24 @@ str = ns.trim( str );
 
 [@stdlib/string/base/remove-first]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-first
 
+[@stdlib/string/base/remove-last-code-point]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-last-code-point
+
+[@stdlib/string/base/remove-last-grapheme-cluster]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-last-grapheme-cluster
+
+[@stdlib/string/base/remove-last]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/remove-last
+
 [@stdlib/string/base/repeat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/repeat
 
 [@stdlib/string/base/replace-before]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace-before
 
 [@stdlib/string/base/replace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/replace
 
+[@stdlib/string/base/reverse-code-points]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/reverse-code-points
+
+[@stdlib/string/base/reverse-grapheme-clusters]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/reverse-grapheme-clusters
+
+[@stdlib/string/base/reverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/reverse
+
 [@stdlib/string/base/right-pad]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/right-pad
 
 [@stdlib/string/base/right-trim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/right-trim
@@ -226,6 +248,8 @@ str = ns.trim( str );
 
 [@stdlib/string/base/trim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/trim
 
+[@stdlib/string/base/truncate-middle]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/truncate-middle
+
 [@stdlib/string/base/uncapitalize]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uncapitalize
 
 [@stdlib/string/base/uppercase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/uppercase

diff --git a/lib/node_modules/@stdlib/string/base/distances/README.md b/lib/node_modules/@stdlib/string/base/distances/README.md
@@ -45,6 +45,7 @@ The namespace contains the following functions:
 
 <div class="namespace-toc">
 
+-   <span class="signature">[`hammingDistance( s1, s2 )`][@stdlib/string/base/distances/hamming]</span><span class="delimiter">: </span><span class="description">calculate the Hamming distance between two equal-length strings.</span>
 -   <span class="signature">[`levenshteinDistance( s1, s2 )`][@stdlib/string/base/distances/levenshtein]</span><span class="delimiter">: </span><span class="description">calculate the Levenshtein (edit) distance between two strings.</span>
 
 </div>
@@ -97,6 +98,8 @@ var dist = ns.levenshteinDistance( 'algorithm', 'altruistic' );
 
 <!-- <toc-links> -->
 
+[@stdlib/string/base/distances/hamming]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/distances/hamming
+
 [@stdlib/string/base/distances/levenshtein]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/distances/levenshtein
 
 <!-- </toc-links> -->
Package	Statements	Branches	Functions	Lines
blas/base	$\color{green}285/285$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}285/285$ $\color{green}+100.00\%$
iter	$\color{green}528/528$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}528/528$ $\color{green}+100.00\%$
ndarray	$\color{green}447/447$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}447/447$ $\color{green}+100.00\%$
random/array	$\color{green}186/186$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}186/186$ $\color{green}+100.00\%$
string	$\color{green}532/532$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}532/532$ $\color{green}+100.00\%$
string/base	$\color{green}447/447$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}447/447$ $\color{green}+100.00\%$
string/base/distances	$\color{green}60/60$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}0/0$ $\color{green}+100.00\%$	$\color{green}60/60$ $\color{green}+100.00\%$