From 5ab585d182dc313da870891fafbfd79de66338dd Mon Sep 17 00:00:00 2001 From: kgryte Date: Fri, 29 Dec 2023 17:55:26 +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/ndarray/README.md | 6 ++++++ lib/node_modules/@stdlib/ndarray/base/README.md | 3 +++ .../@stdlib/stats/base/dists/truncated-normal/README.md | 4 ++++ 4 files changed, 22 insertions(+) diff --git a/lib/node_modules/@stdlib/array/base/README.md b/lib/node_modules/@stdlib/array/base/README.md index 774d2a251f9c..cf4a0639e669 100644 --- a/lib/node_modules/@stdlib/array/base/README.md +++ b/lib/node_modules/@stdlib/array/base/README.md @@ -132,6 +132,9 @@ The namespace exports the following: - [`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. - [`quaternary5d( arrays, shape, fcn )`][@stdlib/array/base/quaternary5d]: apply a quaternary callback to elements in four five-dimensional nested input arrays and assign results to elements in a five-dimensional nested output array. - [`quinary2d( arrays, shape, fcn )`][@stdlib/array/base/quinary2d]: apply a quinary callback to elements in five two-dimensional nested input arrays and assign results to elements in a two-dimensional nested output array. +- [`quinary3d( arrays, shape, fcn )`][@stdlib/array/base/quinary3d]: apply a quinary callback to elements in five three-dimensional nested input arrays and assign results to elements in a three-dimensional nested output array. +- [`quinary4d( arrays, shape, fcn )`][@stdlib/array/base/quinary4d]: apply a quinary callback to elements in five four-dimensional nested input arrays and assign results to elements in a four-dimensional nested output array. +- [`quinary5d( arrays, shape, fcn )`][@stdlib/array/base/quinary5d]: 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. - [`resolveGetter( x )`][@stdlib/array/base/resolve-getter]: return an accessor function for retrieving an element from an array-like object. - [`setter( dtype )`][@stdlib/array/base/setter]: return an accessor function for setting an element in an indexed array-like object. - [`slice( x, start, end )`][@stdlib/array/base/slice]: return a shallow copy of a portion of an array. @@ -378,6 +381,12 @@ console.log( objectKeys( ns ) ); [@stdlib/array/base/quinary2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/quinary2d +[@stdlib/array/base/quinary3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/quinary3d + +[@stdlib/array/base/quinary4d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/quinary4d + +[@stdlib/array/base/quinary5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/quinary5d + [@stdlib/array/base/resolve-getter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/resolve-getter [@stdlib/array/base/setter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/setter diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index b9759089c440..402124938bf2 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -72,6 +72,7 @@ In addition, the namespace contains the following multidimensional array utility
- [`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]: broadcast an ndarray to a specified shape. +- [`broadcastArrays( ...arrays )`][@stdlib/ndarray/broadcast-arrays]: broadcast ndarrays to a common shape. - [`ndarrayCastingModes()`][@stdlib/ndarray/casting-modes]: list of ndarray casting modes. - [`ndarrayDataBuffer( x )`][@stdlib/ndarray/data-buffer]: return the underlying data buffer of a provided ndarray. - [`defaults()`][@stdlib/ndarray/defaults]: default ndarray settings. @@ -86,6 +87,7 @@ In addition, the namespace contains the following multidimensional array utility - [`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]: convert a linear index to an array of subscripts. - [`ndarrayIndexModes()`][@stdlib/ndarray/index-modes]: list of ndarray index modes. - [`maybeBroadcastArray( x, shape )`][@stdlib/ndarray/maybe-broadcast-array]: broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. +- [`maybeBroadcastArrays( arrays )`][@stdlib/ndarray/maybe-broadcast-arrays]: broadcast ndarrays to a common shape. - [`ndarrayMinDataType( value )`][@stdlib/ndarray/min-dtype]: determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value. - [`ndarrayMostlySafeCasts( [dtype] )`][@stdlib/ndarray/mostly-safe-casts]: return a list of ndarray data types to which a provided ndarray data type can be safely cast and, for floating-point data types, can be downcast. - [`ndims( x )`][@stdlib/ndarray/ndims]: return the number of ndarray dimensions. @@ -156,6 +158,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-array +[@stdlib/ndarray/broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/broadcast-arrays + [@stdlib/ndarray/casting-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/casting-modes [@stdlib/ndarray/data-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/data-buffer @@ -184,6 +188,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/maybe-broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-array +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/maybe-broadcast-arrays + [@stdlib/ndarray/min-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/min-dtype [@stdlib/ndarray/mostly-safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/mostly-safe-casts diff --git a/lib/node_modules/@stdlib/ndarray/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 126e85e6aeed..4c853069fcaf 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -80,6 +80,7 @@ var o = ns; - [`iterationOrder( strides )`][@stdlib/ndarray/base/iteration-order]: given a stride array, determine array iteration order. - [`maxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/max-view-buffer-index]: compute the maximum linear index in an underlying data buffer accessible to an array view. - [`maybeBroadcastArray( arr, shape )`][@stdlib/ndarray/base/maybe-broadcast-array]: broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape. +- [`maybeBroadcastArrays( arrays )`][@stdlib/ndarray/base/maybe-broadcast-arrays]: broadcast ndarrays to a common shape. - [`metaDataProps( meta, dtypes, obj )`][@stdlib/ndarray/base/meta-data-props]: define non-enumerable read-only properties which expose ndarray function meta data. - [`minViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/min-view-buffer-index]: compute the minimum linear index in an underlying data buffer accessible to an array view. - [`minmaxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/minmax-view-buffer-index]: compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view. @@ -259,6 +260,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/maybe-broadcast-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/maybe-broadcast-array +[@stdlib/ndarray/base/maybe-broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/maybe-broadcast-arrays + [@stdlib/ndarray/base/meta-data-props]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/meta-data-props [@stdlib/ndarray/base/min-view-buffer-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/min-view-buffer-index diff --git a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md index 9bd3b301d1b0..a3478e00feaa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/truncated-normal/README.md @@ -55,12 +55,16 @@ The namespace contains the following functions for calculating distribution prop + + The namespace contains a constructor function for creating a [truncated normal][truncated-normal-distribution] distribution object. + +