docs: update namespace table of contents

PR-URL: #7046

Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: stdlib-bot <[email protected]>

Author: stdlib-bot

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

@@ -48,7 +48,7 @@ The namespace exports the following:
 -   <span class="signature">[`anyHasOwnProp( arr, property )`][@stdlib/array/base/assert/any-has-own-property]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified own property.</span>
 -   <span class="signature">[`anyHasProp( arr, property )`][@stdlib/array/base/assert/any-has-property]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified property, either own or inherited.</span>
 -   <span class="signature">[`anyIsEntryIn( arr, property )`][@stdlib/array/base/assert/any-is-entry-in]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified property key-value pair, either own or inherited.</span>
--   <span class="signature">[`anyIsEntry( arr, property )`][@stdlib/array/base/assert/any-is-entry]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified own property key-value pair.</span>
+-   <span class="signature">[`anyIsEntry( arr, property, value )`][@stdlib/array/base/assert/any-is-entry]</span><span class="delimiter">: </span><span class="description">test whether at least one element in a provided array has a specified own property key-value pair.</span>
 -   <span class="signature">[`contains( x, value )`][@stdlib/array/base/assert/contains]</span><span class="delimiter">: </span><span class="description">test if an array contains a provided search value.</span>
 -   <span class="signature">[`hasEqualValuesIndexed( x, y )`][@stdlib/array/base/assert/has-equal-values-indexed]</span><span class="delimiter">: </span><span class="description">test if two indexed arrays have equal values.</span>
 -   <span class="signature">[`hasEqualValues( x, y )`][@stdlib/array/base/assert/has-equal-values]</span><span class="delimiter">: </span><span class="description">test if two arrays have equal values.</span>

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

@@ -249,17 +249,28 @@ The namespace includes utilities for validating other special arrays or buffers:
 -   <span class="signature">[`isEmptyArrayLikeObject( value )`][@stdlib/assert/is-empty-array-like-object]</span><span class="delimiter">: </span><span class="description">test if a value is an empty array-like object.</span>
 -   <span class="signature">[`isEmptyArray( value )`][@stdlib/assert/is-empty-array]</span><span class="delimiter">: </span><span class="description">test if a value is an empty array.</span>
 -   <span class="signature">[`isEqualArray( v1, v2 )`][@stdlib/assert/is-equal-array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both generic arrays and have equal values.</span>
+-   <span class="signature">[`isEqualBooleanArray( v1, v2 )`][@stdlib/assert/is-equal-booleanarray]</span><span class="delimiter">: </span><span class="description">test if two arguments are both BooleanArrays and have equal values.</span>
+-   <span class="signature">[`isEqualInt16Array( v1, v2 )`][@stdlib/assert/is-equal-int16array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Int16Arrays and have equal values.</span>
+-   <span class="signature">[`isEqualInt32Array( v1, v2 )`][@stdlib/assert/is-equal-int32array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Int32Arrays and have equal values.</span>
+-   <span class="signature">[`isEqualInt8Array( v1, v2 )`][@stdlib/assert/is-equal-int8array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Int8Arrays and have equal values.</span>
+-   <span class="signature">[`isEqualUint16Array( v1, v2 )`][@stdlib/assert/is-equal-uint16array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Uint16Arrays and have equal values.</span>
+-   <span class="signature">[`isEqualUint32Array( v1, v2 )`][@stdlib/assert/is-equal-uint32array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Uint32Arrays and have equal values.</span>
+-   <span class="signature">[`isEqualUint8Array( v1, v2 )`][@stdlib/assert/is-equal-uint8array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Uint8Arrays and have equal values.</span>
+-   <span class="signature">[`isEqualUint8ClampedArray( v1, v2 )`][@stdlib/assert/is-equal-uint8clampedarray]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Uint8ClampedArrays and have equal values.</span>
 -   <span class="signature">[`isFalsyArray( value )`][@stdlib/assert/is-falsy-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only falsy values.</span>
 -   <span class="signature">[`isFiniteArray( value )`][@stdlib/assert/is-finite-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only finite numbers.</span>
 -   <span class="signature">[`isNumericArray( value )`][@stdlib/assert/is-numeric-array]</span><span class="delimiter">: </span><span class="description">test if a value is a numeric array.</span>
 -   <span class="signature">[`isPlainObjectArray( value )`][@stdlib/assert/is-plain-object-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only plain objects.</span>
 -   <span class="signature">[`isProbabilityArray( value )`][@stdlib/assert/is-probability-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only probabilities.</span>
+-   <span class="signature">[`isSameAccessorArray( v1, v2 )`][@stdlib/assert/is-same-accessor-array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both accessor arrays and have the same values.</span>
+-   <span class="signature">[`isSameArrayLikeObject( v1, v2 )`][@stdlib/assert/is-same-array-like-object]</span><span class="delimiter">: </span><span class="description">test if two arguments are both array-like objects and have the same values.</span>
 -   <span class="signature">[`isSameArrayLike( v1, v2 )`][@stdlib/assert/is-same-array-like]</span><span class="delimiter">: </span><span class="description">test if two arguments are both array-like and have the same values.</span>
 -   <span class="signature">[`isSameArray( v1, v2 )`][@stdlib/assert/is-same-array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both generic arrays and have the same values.</span>
 -   <span class="signature">[`isSameComplex128Array( v1, v2 )`][@stdlib/assert/is-same-complex128array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Complex128Arrays and have the same values.</span>
 -   <span class="signature">[`isSameComplex64Array( v1, v2 )`][@stdlib/assert/is-same-complex64array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Complex64Arrays and have the same values.</span>
 -   <span class="signature">[`isSameFloat32Array( v1, v2 )`][@stdlib/assert/is-same-float32array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float32Arrays and have the same values.</span>
 -   <span class="signature">[`isSameFloat64Array( v1, v2 )`][@stdlib/assert/is-same-float64array]</span><span class="delimiter">: </span><span class="description">test if two arguments are both Float64Arrays and have the same values.</span>
+-   <span class="signature">[`isSameTypedArrayLike( v1, v2 )`][@stdlib/assert/is-same-typed-array-like]</span><span class="delimiter">: </span><span class="description">test if two arguments are both typed-array-like objects and have the same values.</span>
 -   <span class="signature">[`isSharedArrayBuffer( value )`][@stdlib/assert/is-sharedarraybuffer]</span><span class="delimiter">: </span><span class="description">test if a value is a SharedArrayBuffer.</span>
 -   <span class="signature">[`isTruthyArray( value )`][@stdlib/assert/is-truthy-array]</span><span class="delimiter">: </span><span class="description">test if a value is an array-like object containing only truthy values.</span>
 -   <span class="signature">[`isTypedArrayLength( value )`][@stdlib/assert/is-typed-array-length]</span><span class="delimiter">: </span><span class="description">test if a value is a valid typed array length.</span>
@@ -414,6 +425,7 @@ The remaining namespace utilities are as follows:
 -   <span class="signature">[`isEmptyString( value )`][@stdlib/assert/is-empty-string]</span><span class="delimiter">: </span><span class="description">test if a value is an empty string.</span>
 -   <span class="signature">[`isEnumerablePropertyIn( value, property )`][@stdlib/assert/is-enumerable-property-in]</span><span class="delimiter">: </span><span class="description">test if an object's own or inherited property is enumerable.</span>
 -   <span class="signature">[`isEnumerableProperty( value, property )`][@stdlib/assert/is-enumerable-property]</span><span class="delimiter">: </span><span class="description">test if an object's own property is enumerable.</span>
+-   <span class="signature">[`isEqualDateObject( d1, d2 )`][@stdlib/assert/is-equal-date-object]</span><span class="delimiter">: </span><span class="description">test if two values are [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) objects corresponding to the same date and time.</span>
 -   <span class="signature">[`isEven( value )`][@stdlib/assert/is-even]</span><span class="delimiter">: </span><span class="description">test if a value is an even number.</span>
 -   <span class="signature">[`isFalsy( value )`][@stdlib/assert/is-falsy]</span><span class="delimiter">: </span><span class="description">test if a value is falsy.</span>
 -   <span class="signature">[`isFinite( value )`][@stdlib/assert/is-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a finite number.</span>
@@ -627,6 +639,8 @@ console.log( objectKeys( assert ) );
 
 [@stdlib/assert/is-enumerable-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-enumerable-property
 
+[@stdlib/assert/is-equal-date-object]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-date-object
+
 [@stdlib/assert/is-even]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-even
 
 [@stdlib/assert/is-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-falsy
@@ -919,6 +933,22 @@ console.log( objectKeys( assert ) );
 
 [@stdlib/assert/is-equal-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-array
 
+[@stdlib/assert/is-equal-booleanarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-booleanarray
+
+[@stdlib/assert/is-equal-int16array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-int16array
+
+[@stdlib/assert/is-equal-int32array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-int32array
+
+[@stdlib/assert/is-equal-int8array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-int8array
+
+[@stdlib/assert/is-equal-uint16array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-uint16array
+
+[@stdlib/assert/is-equal-uint32array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-uint32array
+
+[@stdlib/assert/is-equal-uint8array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-uint8array
+
+[@stdlib/assert/is-equal-uint8clampedarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-equal-uint8clampedarray
+
 [@stdlib/assert/is-falsy-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-falsy-array
 
 [@stdlib/assert/is-finite-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-finite-array
@@ -929,6 +959,10 @@ console.log( objectKeys( assert ) );
 
 [@stdlib/assert/is-probability-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-probability-array
 
+[@stdlib/assert/is-same-accessor-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-accessor-array
+
+[@stdlib/assert/is-same-array-like-object]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-array-like-object
+
 [@stdlib/assert/is-same-array-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-array-like
 
 [@stdlib/assert/is-same-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-array
@@ -941,6 +975,8 @@ console.log( objectKeys( assert ) );
 
 [@stdlib/assert/is-same-float64array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-float64array
 
+[@stdlib/assert/is-same-typed-array-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-typed-array-like
+
 [@stdlib/assert/is-sharedarraybuffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-sharedarraybuffer
 
 [@stdlib/assert/is-truthy-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-truthy-array

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

@@ -82,6 +82,7 @@ In addition, the namespace contains the following multidimensional array utility
 -   <span class="signature">[`dtypes( [kind] )`][@stdlib/ndarray/dtypes]</span><span class="delimiter">: </span><span class="description">list of ndarray data types.</span>
 -   <span class="signature">[`emptyLike( x[, options] )`][@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>
 -   <span class="signature">[`empty( shape[, options] )`][@stdlib/ndarray/empty]</span><span class="delimiter">: </span><span class="description">create an uninitialized ndarray having a specified shape and data type.</span>
+-   <span class="signature">[`every( x[, options] )`][@stdlib/ndarray/every]</span><span class="delimiter">: </span><span class="description">test whether every element along one or more `ndarray` dimensions is truthy.</span>
 -   <span class="signature">[`FancyArray( dtype, buffer, shape, strides, offset, order[, options] )`][@stdlib/ndarray/fancy]</span><span class="delimiter">: </span><span class="description">fancy multidimensional array constructor.</span>
 -   <span class="signature">[`fillBy( x, fcn[, thisArg] )`][@stdlib/ndarray/fill-by]</span><span class="delimiter">: </span><span class="description">fill an input ndarray according to a callback function.</span>
 -   <span class="signature">[`fill( x, value )`][@stdlib/ndarray/fill]</span><span class="delimiter">: </span><span class="description">fill an input `ndarray` with a specified value.</span>
@@ -91,6 +92,7 @@ In addition, the namespace contains the following multidimensional array utility
 -   <span class="signature">[`flags( x )`][@stdlib/ndarray/flags]</span><span class="delimiter">: </span><span class="description">return the flags of a provided ndarray.</span>
 -   <span class="signature">[`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]</span><span class="delimiter">: </span><span class="description">invoke a callback function once for each ndarray element.</span>
 -   <span class="signature">[`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]</span><span class="delimiter">: </span><span class="description">convert a scalar value to a zero-dimensional ndarray.</span>
+-   <span class="signature">[`includes( x, searchElement[, options] )`][@stdlib/ndarray/includes]</span><span class="delimiter">: </span><span class="description">test whether an `ndarray` contains a specified value along one or more dimensions.</span>
 -   <span class="signature">[`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]</span><span class="delimiter">: </span><span class="description">convert a linear index to an array of subscripts.</span>
 -   <span class="signature">[`indexModes()`][@stdlib/ndarray/index-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray index modes.</span>
 -   <span class="signature">[`ndindex( x[, options] )`][@stdlib/ndarray/index]</span><span class="delimiter">: </span><span class="description">ndarray index constructor.</span>
@@ -127,6 +129,7 @@ In addition, the namespace contains the following multidimensional array utility
 -   <span class="signature">[`ndarray2array( x )`][@stdlib/ndarray/to-array]</span><span class="delimiter">: </span><span class="description">convert an ndarray to a generic array.</span>
 -   <span class="signature">[`ndarray2fancy( x[, options] )`][@stdlib/ndarray/to-fancy]</span><span class="delimiter">: </span><span class="description">convert an ndarray to an object supporting fancy indexing.</span>
 -   <span class="signature">[`ndarray2json( x )`][@stdlib/ndarray/to-json]</span><span class="delimiter">: </span><span class="description">serialize an ndarray as a JSON object.</span>
+-   <span class="signature">[`vector`][@stdlib/ndarray/vector]</span><span class="delimiter">: </span><span class="description">vector constructors and associated utilities.</span>
 -   <span class="signature">[`zerosLike( x[, options] )`][@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>
 -   <span class="signature">[`zeros( shape[, options] )`][@stdlib/ndarray/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled ndarray having a specified shape and data type.</span>
 
@@ -193,6 +196,8 @@ console.log( objectKeys( ns ) );
 
 [@stdlib/ndarray/empty]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty
 
+[@stdlib/ndarray/every]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/every
+
 [@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy
 
 [@stdlib/ndarray/fill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fill-by
@@ -211,6 +216,8 @@ console.log( objectKeys( ns ) );
 
 [@stdlib/ndarray/from-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-scalar
 
+[@stdlib/ndarray/includes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/includes
+
 [@stdlib/ndarray/ind2sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub
 
 [@stdlib/ndarray/index-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/index-modes
@@ -283,6 +290,8 @@ console.log( objectKeys( ns ) );
 
 [@stdlib/ndarray/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-json
 
+[@stdlib/ndarray/vector]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector
+
 [@stdlib/ndarray/zeros-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/zeros-like
 
 [@stdlib/ndarray/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/zeros