Skip to content

Commit c3320f1

Browse files
authored
docs: update namespace table of contents
PR-URL: #6764 Reviewed-by: Athan Reines <[email protected]>
1 parent 9dacfb9 commit c3320f1

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

Diff for: lib/node_modules/@stdlib/array/base/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ The namespace exports the following:
6060
- <span class="signature">[`at4d( x, i0, i1, i2, i3 )`][@stdlib/array/base/at4d]</span><span class="delimiter">: </span><span class="description">return an element from a four-dimensional nested array.</span>
6161
- <span class="signature">[`at5d( x, i0, i1, i2, i3, i4 )`][@stdlib/array/base/at5d]</span><span class="delimiter">: </span><span class="description">return an element from a five-dimensional nested array.</span>
6262
- <span class="signature">[`atnd( x, i0[, ...indices] )`][@stdlib/array/base/atnd]</span><span class="delimiter">: </span><span class="description">return an element from an n-dimensional nested array.</span>
63+
- <span class="signature">[`banded`][@stdlib/array/base/banded]</span><span class="delimiter">: </span><span class="description">banded array utilities.</span>
6364
- <span class="signature">[`bifurcateEntriesBy( x, predicate[, thisArg] )`][@stdlib/array/base/bifurcate-entries-by]</span><span class="delimiter">: </span><span class="description">split element entries into two groups according to a predicate function.</span>
6465
- <span class="signature">[`bifurcateEntries( x, filter )`][@stdlib/array/base/bifurcate-entries]</span><span class="delimiter">: </span><span class="description">split array element entries into two groups.</span>
6566
- <span class="signature">[`bifurcateIndicesBy( x, predicate[, thisArg] )`][@stdlib/array/base/bifurcate-indices-by]</span><span class="delimiter">: </span><span class="description">split element indices into two groups according to a predicate function.</span>
@@ -97,6 +98,7 @@ The namespace exports the following:
9798
- <span class="signature">[`copy( x )`][@stdlib/array/base/copy]</span><span class="delimiter">: </span><span class="description">copy the elements of an array-like object to a new "generic" array.</span>
9899
- <span class="signature">[`countFalsy( x )`][@stdlib/array/base/count-falsy]</span><span class="delimiter">: </span><span class="description">count the number of falsy elements in an array.</span>
99100
- <span class="signature">[`countIf( x, predicate[, thisArg] )`][@stdlib/array/base/count-if]</span><span class="delimiter">: </span><span class="description">count the number of elements in an array which pass a test implemented by a predicate function.</span>
101+
- <span class="signature">[`countIfs( x0, predicate0[, x1, predicate1[, x2, predicate2[, ...args]]] )`][@stdlib/array/base/count-ifs]</span><span class="delimiter">: </span><span class="description">perform element-wise evaluation of one or more input arrays according to provided predicate functions and count the number of elements for which all predicates respectively return `true`.</span>
100102
- <span class="signature">[`countSameValueZero( x, value )`][@stdlib/array/base/count-same-value-zero]</span><span class="delimiter">: </span><span class="description">count the number of elements in an array that are equal to a specified value.</span>
101103
- <span class="signature">[`countSameValue( x, value )`][@stdlib/array/base/count-same-value]</span><span class="delimiter">: </span><span class="description">count the number of elements in an array that are equal to a specified value.</span>
102104
- <span class="signature">[`countTruthy( x )`][@stdlib/array/base/count-truthy]</span><span class="delimiter">: </span><span class="description">count the number of truthy elements in an array.</span>
@@ -160,6 +162,7 @@ The namespace exports the following:
160162
- <span class="signature">[`lastIndexOf( x, searchElement, fromIndex )`][@stdlib/array/base/last-index-of]</span><span class="delimiter">: </span><span class="description">return the index of the last element which equals a provided search element.</span>
161163
- <span class="signature">[`last( x )`][@stdlib/array/base/last]</span><span class="delimiter">: </span><span class="description">return the last element of an array-like object.</span>
162164
- <span class="signature">[`linspace( start, stop, length )`][@stdlib/array/base/linspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array.</span>
165+
- <span class="signature">[`linspace2d( start, stop, shape, colexicographic )`][@stdlib/array/base/linspace2d]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced two-dimensional nested numeric array.</span>
163166
- <span class="signature">[`logspace( a, b, length )`][@stdlib/array/base/logspace]</span><span class="delimiter">: </span><span class="description">generate a logarithmically spaced numeric array.</span>
164167
- <span class="signature">[`map2d( x, shape, fcn[, thisArg] )`][@stdlib/array/base/map2d]</span><span class="delimiter">: </span><span class="description">apply a function to elements in a two-dimensional nested input array and assign results to elements in a new two-dimensional nested output array.</span>
165168
- <span class="signature">[`map3d( x, shape, fcn[, thisArg] )`][@stdlib/array/base/map3d]</span><span class="delimiter">: </span><span class="description">apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.</span>
@@ -205,6 +208,7 @@ The namespace exports the following:
205208
- <span class="signature">[`quinary5d( arrays, shape, fcn )`][@stdlib/array/base/quinary5d]</span><span class="delimiter">: </span><span class="description">apply a quinary callback to elements in five five-dimensional nested input arrays and assign results to elements in a five-dimensional nested output array.</span>
206209
- <span class="signature">[`reject( x, predicate[, thisArg] )`][@stdlib/array/base/reject]</span><span class="delimiter">: </span><span class="description">return a shallow copy of an array containing only those elements which fail a test implemented by a predicate function.</span>
207210
- <span class="signature">[`removeAt( x, index )`][@stdlib/array/base/remove-at]</span><span class="delimiter">: </span><span class="description">remove an element from an array.</span>
211+
- <span class="signature">[`reshape( x, fromShape, toShape, colexicographic )`][@stdlib/array/base/reshape]</span><span class="delimiter">: </span><span class="description">reshape a nested array into another nested array having a desired shape.</span>
208212
- <span class="signature">[`resolveGetter( x )`][@stdlib/array/base/resolve-getter]</span><span class="delimiter">: </span><span class="description">return an accessor function for retrieving an element from an array-like object.</span>
209213
- <span class="signature">[`resolveSetter( x )`][@stdlib/array/base/resolve-setter]</span><span class="delimiter">: </span><span class="description">return an accessor function for setting an element in an array-like object.</span>
210214
- <span class="signature">[`reverse( x )`][@stdlib/array/base/reverse]</span><span class="delimiter">: </span><span class="description">reverse an array in-place.</span>
@@ -216,6 +220,8 @@ The namespace exports the following:
216220
- <span class="signature">[`strided2array3d( x, shape, strides, offset )`][@stdlib/array/base/strided2array3d]</span><span class="delimiter">: </span><span class="description">convert a strided array to a three-dimensional nested array.</span>
217221
- <span class="signature">[`strided2array4d( x, shape, strides, offset )`][@stdlib/array/base/strided2array4d]</span><span class="delimiter">: </span><span class="description">convert a strided array to a four-dimensional nested array.</span>
218222
- <span class="signature">[`strided2array5d( x, shape, strides, offset )`][@stdlib/array/base/strided2array5d]</span><span class="delimiter">: </span><span class="description">convert a strided array to a five-dimensional nested array.</span>
223+
- <span class="signature">[`symmetricBanded`][@stdlib/array/base/symmetric-banded]</span><span class="delimiter">: </span><span class="description">symmetric banded array utilities.</span>
224+
- <span class="signature">[`symmetric`][@stdlib/array/base/symmetric]</span><span class="delimiter">: </span><span class="description">symmetric array utilities.</span>
219225
- <span class="signature">[`takeIndexed( x, indices )`][@stdlib/array/base/take-indexed]</span><span class="delimiter">: </span><span class="description">take elements from an indexed array.</span>
220226
- <span class="signature">[`takeIndexed2( x, y, indices )`][@stdlib/array/base/take-indexed2]</span><span class="delimiter">: </span><span class="description">take elements from two indexed arrays in a single pass.</span>
221227
- <span class="signature">[`take( x, indices, mode )`][@stdlib/array/base/take]</span><span class="delimiter">: </span><span class="description">take elements from an array.</span>
@@ -336,6 +342,8 @@ var squared = ns.map2d( arr2d, [ 2, 3 ], randu );
336342

337343
[@stdlib/array/base/atnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/atnd
338344

345+
[@stdlib/array/base/banded]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/banded
346+
339347
[@stdlib/array/base/bifurcate-entries-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/bifurcate-entries-by
340348

341349
[@stdlib/array/base/bifurcate-entries]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/bifurcate-entries
@@ -410,6 +418,8 @@ var squared = ns.map2d( arr2d, [ 2, 3 ], randu );
410418

411419
[@stdlib/array/base/count-if]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/count-if
412420

421+
[@stdlib/array/base/count-ifs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/count-ifs
422+
413423
[@stdlib/array/base/count-same-value-zero]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/count-same-value-zero
414424

415425
[@stdlib/array/base/count-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/count-same-value
@@ -536,6 +546,8 @@ var squared = ns.map2d( arr2d, [ 2, 3 ], randu );
536546

537547
[@stdlib/array/base/linspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/linspace
538548

549+
[@stdlib/array/base/linspace2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/linspace2d
550+
539551
[@stdlib/array/base/logspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/logspace
540552

541553
[@stdlib/array/base/map2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map2d
@@ -626,6 +638,8 @@ var squared = ns.map2d( arr2d, [ 2, 3 ], randu );
626638

627639
[@stdlib/array/base/remove-at]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/remove-at
628640

641+
[@stdlib/array/base/reshape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/reshape
642+
629643
[@stdlib/array/base/resolve-getter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/resolve-getter
630644

631645
[@stdlib/array/base/resolve-setter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/resolve-setter
@@ -648,6 +662,10 @@ var squared = ns.map2d( arr2d, [ 2, 3 ], randu );
648662

649663
[@stdlib/array/base/strided2array5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/strided2array5d
650664

665+
[@stdlib/array/base/symmetric-banded]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/symmetric-banded
666+
667+
[@stdlib/array/base/symmetric]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/symmetric
668+
651669
[@stdlib/array/base/take-indexed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-indexed
652670

653671
[@stdlib/array/base/take-indexed2]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/take-indexed2

Diff for: lib/node_modules/@stdlib/complex/float32/base/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,10 @@ The namespace contains the following functions:
5858
<div class="namespace-toc">
5959

6060
- <span class="signature">[`add( z1, z2 )`][@stdlib/complex/float32/base/add]</span><span class="delimiter">: </span><span class="description">add two single-precision complex floating-point numbers.</span>
61+
- <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>
6162
- <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>
63+
- <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">[`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>
6265

6366
</div>
6467

@@ -111,8 +114,14 @@ console.log( objectKeys( ns ) );
111114

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

117+
[@stdlib/complex/float32/base/identity]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/identity
118+
114119
[@stdlib/complex/float32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/mul
115120

121+
[@stdlib/complex/float32/base/neg]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/neg
122+
123+
[@stdlib/complex/float32/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/sub
124+
116125
[@stdlib/complex/float32/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert
117126

118127
<!-- </toc-links> -->

0 commit comments

Comments
 (0)