Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -406,6 +406,7 @@ A total of 15 issues were closed in this release:
 
 <details>
 
+-   [`89d9dc3`](https://github.com/stdlib-js/stdlib/commit/89d9dc316985aa3c194222afbf8146e58ff6d761) - **docs:** update namespace table of contents [(#7046)](https://github.com/stdlib-js/stdlib/pull/7046) _(by stdlib-bot)_
 -   [`a300862`](https://github.com/stdlib-js/stdlib/commit/a300862d4f05d4d8bd85f1e235db93ad5d35a767) - **fix:** address increment bugs _(by Athan Reines)_
 -   [`fab9873`](https://github.com/stdlib-js/stdlib/commit/fab9873a907807195f2f6673b5b97f09e383bd69) - **fix:** address index bug _(by Athan Reines)_
 -   [`c8ed1f9`](https://github.com/stdlib-js/stdlib/commit/c8ed1f99772d36d99cf0d836a506c3c83f58c02c) - **docs:** fix description _(by Athan Reines)_

README.md

@@ -115,6 +115,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>
@@ -124,6 +125,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>
@@ -160,6 +162,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>
 
@@ -294,6 +297,8 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/ndarray/empty]: https://github.com/stdlib-js/ndarray/tree/main/empty
 
+[@stdlib/ndarray/every]: https://github.com/stdlib-js/ndarray/tree/main/every
+
 [@stdlib/ndarray/fancy]: https://github.com/stdlib-js/ndarray/tree/main/fancy
 
 [@stdlib/ndarray/fill-by]: https://github.com/stdlib-js/ndarray/tree/main/fill-by
@@ -312,6 +317,8 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/ndarray/from-scalar]: https://github.com/stdlib-js/ndarray/tree/main/from-scalar
 
+[@stdlib/ndarray/includes]: https://github.com/stdlib-js/ndarray/tree/main/includes
+
 [@stdlib/ndarray/ind2sub]: https://github.com/stdlib-js/ndarray/tree/main/ind2sub
 
 [@stdlib/ndarray/index-modes]: https://github.com/stdlib-js/ndarray/tree/main/index-modes
@@ -384,6 +391,8 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/ndarray/to-json]: https://github.com/stdlib-js/ndarray/tree/main/to-json
 
+[@stdlib/ndarray/vector]: https://github.com/stdlib-js/ndarray/tree/main/vector
+
 [@stdlib/ndarray/zeros-like]: https://github.com/stdlib-js/ndarray/tree/main/zeros-like
 
 [@stdlib/ndarray/zeros]: https://github.com/stdlib-js/ndarray/tree/main/zeros

vector/README.md

@@ -53,6 +53,22 @@ The namespace exports the following:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`BooleanVector()`][@stdlib/ndarray/vector/bool]</span><span class="delimiter">: </span><span class="description">create a boolean vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`vector()`][@stdlib/ndarray/vector/ctor]</span><span class="delimiter">: </span><span class="description">create a vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Float32Vector()`][@stdlib/ndarray/vector/float32]</span><span class="delimiter">: </span><span class="description">create a single-precision floating-point vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Float64Vector()`][@stdlib/ndarray/vector/float64]</span><span class="delimiter">: </span><span class="description">create a double-precision floating-point vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Int16Vector()`][@stdlib/ndarray/vector/int16]</span><span class="delimiter">: </span><span class="description">create a signed 16-bit integer vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Int32Vector()`][@stdlib/ndarray/vector/int32]</span><span class="delimiter">: </span><span class="description">create a signed 32-bit integer vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Int8Vector()`][@stdlib/ndarray/vector/int8]</span><span class="delimiter">: </span><span class="description">create a signed 8-bit integer vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Uint16Vector()`][@stdlib/ndarray/vector/uint16]</span><span class="delimiter">: </span><span class="description">create an unsigned 16-bit integer vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Uint32Vector()`][@stdlib/ndarray/vector/uint32]</span><span class="delimiter">: </span><span class="description">create an unsigned 32-bit integer vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Uint8Vector()`][@stdlib/ndarray/vector/uint8]</span><span class="delimiter">: </span><span class="description">create an unsigned 8-bit integer vector (i.e., a one-dimensional ndarray).</span>
+-   <span class="signature">[`Uint8ClampedVector()`][@stdlib/ndarray/vector/uint8c]</span><span class="delimiter">: </span><span class="description">create a clamped unsigned 8-bit integer vector (i.e., a one-dimensional ndarray).</span>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -100,6 +116,32 @@ console.log( objectKeys( ns ) );
 
 <section class="links">
 
+<!-- <toc-links> -->
+
+[@stdlib/ndarray/vector/bool]: https://github.com/stdlib-js/ndarray/tree/main/vector/bool
+
+[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray/tree/main/vector/ctor
+
+[@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/ndarray/tree/main/vector/float32
+
+[@stdlib/ndarray/vector/float64]: https://github.com/stdlib-js/ndarray/tree/main/vector/float64
+
+[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/ndarray/tree/main/vector/int16
+
+[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/ndarray/tree/main/vector/int32
+
+[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/ndarray/tree/main/vector/int8
+
+[@stdlib/ndarray/vector/uint16]: https://github.com/stdlib-js/ndarray/tree/main/vector/uint16
+
+[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/ndarray/tree/main/vector/uint32
+
+[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/ndarray/tree/main/vector/uint8
+
+[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/ndarray/tree/main/vector/uint8c
+
+<!-- </toc-links> -->
+
 </section>
 
 <!-- /.links -->