diff --git a/README.md b/README.md index 6f33d377..1bf0314e 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,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. @@ -117,6 +118,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. @@ -252,6 +254,8 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray/tree/main/broadcast-array +[@stdlib/ndarray/broadcast-arrays]: https://github.com/stdlib-js/ndarray/tree/main/broadcast-arrays + [@stdlib/ndarray/casting-modes]: https://github.com/stdlib-js/ndarray/tree/main/casting-modes [@stdlib/ndarray/data-buffer]: https://github.com/stdlib-js/ndarray/tree/main/data-buffer @@ -280,6 +284,8 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [@stdlib/ndarray/maybe-broadcast-array]: https://github.com/stdlib-js/ndarray/tree/main/maybe-broadcast-array +[@stdlib/ndarray/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray/tree/main/maybe-broadcast-arrays + [@stdlib/ndarray/min-dtype]: https://github.com/stdlib-js/ndarray/tree/main/min-dtype [@stdlib/ndarray/mostly-safe-casts]: https://github.com/stdlib-js/ndarray/tree/main/mostly-safe-casts diff --git a/base/README.md b/base/README.md index 9bf0fb81..004d912b 100644 --- a/base/README.md +++ b/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/ndarray/tree/main/base/maybe-broadcast-array +[@stdlib/ndarray/base/maybe-broadcast-arrays]: https://github.com/stdlib-js/ndarray/tree/main/base/maybe-broadcast-arrays + [@stdlib/ndarray/base/meta-data-props]: https://github.com/stdlib-js/ndarray/tree/main/base/meta-data-props [@stdlib/ndarray/base/min-view-buffer-index]: https://github.com/stdlib-js/ndarray/tree/main/base/min-view-buffer-index