From ea12fa8d25ffb167119a928ab75f79dc69fcd200 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Mon, 17 Jun 2024 13:07:38 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- lib/node_modules/@stdlib/array/base/README.md | 9 +++++++++ lib/node_modules/@stdlib/array/base/assert/README.md | 6 ++++++ 2 files changed, 15 insertions(+) diff --git a/lib/node_modules/@stdlib/array/base/README.md b/lib/node_modules/@stdlib/array/base/README.md index 65147e504036..ce68fc38ce40 100644 --- a/lib/node_modules/@stdlib/array/base/README.md +++ b/lib/node_modules/@stdlib/array/base/README.md @@ -93,6 +93,8 @@ The namespace exports the following: - [`countSameValueZero( x, value )`][@stdlib/array/base/count-same-value-zero]: count the number of elements in an array that are equal to a specified value. - [`countSameValue( x, value )`][@stdlib/array/base/count-same-value]: count the number of elements in an array that are equal to a specified value. - [`countTruthy( x )`][@stdlib/array/base/count-truthy]: count the number of truthy elements in an array. +- [`cuany( x )`][@stdlib/array/base/cuany]: cumulatively test whether at least one element in a provided array is truthy. +- [`cuevery( x )`][@stdlib/array/base/cuevery]: cumulatively test whether every element in a provided array is truthy. - [`dedupe( x, limit, equalNaNs )`][@stdlib/array/base/dedupe]: remove consecutive duplicated values. - [`everyByRight( x, predicate[, thisArg] )`][@stdlib/array/base/every-by-right]: test whether all elements in an array pass a test implemented by a predicate function, iterating from right to left. - [`everyBy( x, predicate[, thisArg] )`][@stdlib/array/base/every-by]: test whether all elements in an array pass a test implemented by a predicate function. @@ -168,6 +170,7 @@ The namespace exports the following: - [`ones4d( shape )`][@stdlib/array/base/ones4d]: create a four-dimensional nested array filled with ones. - [`ones5d( shape )`][@stdlib/array/base/ones5d]: create a five-dimensional nested array filled with ones. - [`onesnd( shape )`][@stdlib/array/base/onesnd]: create an n-dimensional nested array filled with ones. +- [`put( x, indices, values, mode )`][@stdlib/array/base/put]: replace specified elements of an array with provided values. - [`quaternary2d( arrays, shape, fcn )`][@stdlib/array/base/quaternary2d]: apply a quaternary callback to elements in four two-dimensional nested input arrays and assign results to elements in a two-dimensional nested output array. - [`quaternary3d( arrays, shape, fcn )`][@stdlib/array/base/quaternary3d]: apply a quaternary callback to elements in four three-dimensional nested input arrays and assign results to elements in a three-dimensional nested output array. - [`quaternary4d( arrays, shape, fcn )`][@stdlib/array/base/quaternary4d]: apply a quaternary callback to elements in four four-dimensional nested input arrays and assign results to elements in a four-dimensional nested output array. @@ -350,6 +353,10 @@ console.log( objectKeys( ns ) ); [@stdlib/array/base/count-truthy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/count-truthy +[@stdlib/array/base/cuany]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cuany + +[@stdlib/array/base/cuevery]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cuevery + [@stdlib/array/base/dedupe]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/dedupe [@stdlib/array/base/every-by-right]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/every-by-right @@ -500,6 +507,8 @@ console.log( objectKeys( ns ) ); [@stdlib/array/base/onesnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/onesnd +[@stdlib/array/base/put]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/put + [@stdlib/array/base/quaternary2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/quaternary2d [@stdlib/array/base/quaternary3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/quaternary3d diff --git a/lib/node_modules/@stdlib/array/base/assert/README.md b/lib/node_modules/@stdlib/array/base/assert/README.md index b2d27de4888c..173c9888d612 100644 --- a/lib/node_modules/@stdlib/array/base/assert/README.md +++ b/lib/node_modules/@stdlib/array/base/assert/README.md @@ -48,6 +48,8 @@ The namespace exports the following: - [`contains( x, value )`][@stdlib/array/base/assert/contains]: test if an array contains a provided search value. - [`hasSameValues( x, y )`][@stdlib/array/base/assert/has-same-values]: test if two arrays have the same values. - [`isAccessorArray( value )`][@stdlib/array/base/assert/is-accessor-array]: test if an array-like object supports the accessor (get/set) protocol. +- [`isBooleanDataType( value )`][@stdlib/array/base/assert/is-boolean-data-type]: test if an input value is a supported array boolean data type. +- [`isBooleanArray( value )`][@stdlib/array/base/assert/is-booleanarray]: test if a value is a `BooleanArray`. - [`isComplexFloatingPointDataType( value )`][@stdlib/array/base/assert/is-complex-floating-point-data-type]: test if an input value is a supported array complex-valued floating-point data type. - [`isComplexTypedArray( value )`][@stdlib/array/base/assert/is-complex-typed-array]: test if a value is a complex typed array. - [`isComplex128Array( value )`][@stdlib/array/base/assert/is-complex128array]: test if a value is a `Complex128Array`. @@ -111,6 +113,10 @@ console.log( objectKeys( ns ) ); [@stdlib/array/base/assert/is-accessor-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-accessor-array +[@stdlib/array/base/assert/is-boolean-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-boolean-data-type + +[@stdlib/array/base/assert/is-booleanarray]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-booleanarray + [@stdlib/array/base/assert/is-complex-floating-point-data-type]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-complex-floating-point-data-type [@stdlib/array/base/assert/is-complex-typed-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/assert/is-complex-typed-array