From 87532bda6e65d83013e43548bdcfdd0e01661867 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Tue, 19 May 2026 03:29:58 +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/ndarray/README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 80c47c7be2bc..f5b8086d33f9 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -52,6 +52,8 @@ The namespace exports the following functions to create multidimensional arrays: - [`ndarray( dtype, buffer, shape, strides, offset, order[, options] )`][@stdlib/ndarray/ctor]: multidimensional array constructor. - [`emptyLike( x[, options] )`][@stdlib/ndarray/empty-like]: create an uninitialized ndarray having the same shape and data type as a provided ndarray. - [`empty( shape[, options] )`][@stdlib/ndarray/empty]: create an uninitialized ndarray having a specified shape and data type. +- [`falsesLike( x[, options] )`][@stdlib/ndarray/falses-like]: create an ndarray filled with `false` values and having the same shape and data type as a provided ndarray. +- [`falses( shape[, options] )`][@stdlib/ndarray/falses]: create an ndarray filled with `false` values and having a specified shape and data type. - [`FancyArray( dtype, buffer, shape, strides, offset, order[, options] )`][@stdlib/ndarray/fancy]: fancy multidimensional array constructor. - [`scalar2ndarrayLike( x, value[, options] )`][@stdlib/ndarray/from-scalar-like]: convert a scalar value to a zero-dimensional ndarray having the same data-type as a provided ndarray. - [`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]: convert a scalar value to a zero-dimensional ndarray. @@ -61,6 +63,8 @@ The namespace exports the following functions to create multidimensional arrays: - [`onesLike( x[, options] )`][@stdlib/ndarray/ones-like]: create a ones-filled ndarray having the same shape and data type as a provided ndarray. - [`ones( shape[, options] )`][@stdlib/ndarray/ones]: create a ones-filled ndarray having a specified shape and data type. - [`ndarray2fancy( x[, options] )`][@stdlib/ndarray/to-fancy]: convert an ndarray to an object supporting fancy indexing. +- [`truesLike( x[, options] )`][@stdlib/ndarray/trues-like]: create an ndarray filled with `true` values and having the same shape and data type as a provided ndarray. +- [`trues( shape[, options] )`][@stdlib/ndarray/trues]: create an ndarray filled with `true` values and having a specified shape and data type. - [`zerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]: create a zero-filled ndarray having the same shape and data type as a provided ndarray. - [`zeros( shape[, options] )`][@stdlib/ndarray/zeros]: create a zero-filled ndarray having a specified shape and data type. @@ -280,10 +284,8 @@ The namespace contains the following multidimensional array utility functions: - [`defaults()`][@stdlib/ndarray/defaults]: default ndarray settings. - [`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]: create an ndarray function interface which performs multiple dispatch. -- [`falses( shape[, options] )`][@stdlib/ndarray/falses]: create an ndarray filled with `false` values and having a specified shape and data type. - [`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]: invoke a callback function once for each ndarray element. - [`orders()`][@stdlib/ndarray/orders]: list of ndarray orders. -- [`trues( shape[, options] )`][@stdlib/ndarray/trues]: create an ndarray filled with `true` values and having a specified shape and data type. @@ -330,14 +332,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/dispatch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dispatch -[@stdlib/ndarray/falses]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/falses - [@stdlib/ndarray/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/for-each [@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders -[@stdlib/ndarray/trues]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/trues - [@stdlib/ndarray/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base [@stdlib/ndarray/iter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter @@ -570,6 +568,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/empty]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/empty +[@stdlib/ndarray/falses-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/falses-like + +[@stdlib/ndarray/falses]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/falses + [@stdlib/ndarray/fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/fancy [@stdlib/ndarray/from-scalar-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-scalar-like @@ -588,6 +590,10 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/to-fancy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-fancy +[@stdlib/ndarray/trues-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/trues-like + +[@stdlib/ndarray/trues]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/trues + [@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