Skip to content

Commit d178151

Browse files
committed
Auto-generated commit
1 parent 42b6862 commit d178151

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -817,6 +817,7 @@ A total of 45 issues were closed in this release:
817817

818818
<details>
819819

820+
- [`ba129b3`](https://github.com/stdlib-js/stdlib/commit/ba129b35eed5099aece6caa686c3794e9a6b08b5) - **docs:** update namespace table of contents [(#11198)](https://github.com/stdlib-js/stdlib/pull/11198) _(by stdlib-bot)_
820821
- [`a0169bc`](https://github.com/stdlib-js/stdlib/commit/a0169bcfc0d05ac94c206ac5d6d0a898ec304463) - **docs:** remove unused `ndarray2array` requires from README usage examples [(#11194)](https://github.com/stdlib-js/stdlib/pull/11194) _(by Philipp Burckhardt)_
821822
- [`3bf34ec`](https://github.com/stdlib-js/stdlib/commit/3bf34ec6df7f894f7cbee125eb3f655ebb2d6a4e) - **chore:** fix typos, grammar, and minor issues across multiple packages [(#11167)](https://github.com/stdlib-js/stdlib/pull/11167) _(by Philipp Burckhardt)_
822823
- [`28d3e7d`](https://github.com/stdlib-js/stdlib/commit/28d3e7d6b05b312ebf14896cb0d8593902e443cb) - **feat:** update `ndarray/base` TypeScript declarations [(#11166)](https://github.com/stdlib-js/stdlib/pull/11166) _(by stdlib-bot)_

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,7 @@ In addition, the namespace contains the following multidimensional array utility
162162
- <span class="signature">[`numelDimension( x, dim )`][@stdlib/ndarray/numel-dimension]</span><span class="delimiter">: </span><span class="description">return the size (i.e., number of elements) of a specified dimension for a provided ndarray.</span>
163163
- <span class="signature">[`numel( x )`][@stdlib/ndarray/numel]</span><span class="delimiter">: </span><span class="description">return the number of elements in an ndarray.</span>
164164
- <span class="signature">[`offset( x )`][@stdlib/ndarray/offset]</span><span class="delimiter">: </span><span class="description">return the index offset specifying the underlying buffer index of the first iterated ndarray element.</span>
165+
- <span class="signature">[`ones( shape[, options] )`][@stdlib/ndarray/ones]</span><span class="delimiter">: </span><span class="description">create a ones-filled ndarray having a specified shape and data type.</span>
165166
- <span class="signature">[`order( x )`][@stdlib/ndarray/order]</span><span class="delimiter">: </span><span class="description">return the layout order of a provided ndarray.</span>
166167
- <span class="signature">[`orders()`][@stdlib/ndarray/orders]</span><span class="delimiter">: </span><span class="description">list of ndarray orders.</span>
167168
- <span class="signature">[`outputDataTypePolicies()`][@stdlib/ndarray/output-dtype-policies]</span><span class="delimiter">: </span><span class="description">list of output ndarray data type policies.</span>
@@ -428,6 +429,8 @@ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
428429

429430
[@stdlib/ndarray/offset]: https://github.com/stdlib-js/ndarray/tree/main/offset
430431

432+
[@stdlib/ndarray/ones]: https://github.com/stdlib-js/ndarray/tree/main/ones
433+
431434
[@stdlib/ndarray/order]: https://github.com/stdlib-js/ndarray/tree/main/order
432435

433436
[@stdlib/ndarray/orders]: https://github.com/stdlib-js/ndarray/tree/main/orders

base/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ var o = ns;
127127
- <span class="signature">[`minUnsignedIntegerDataType( value )`][@stdlib/ndarray/base/min-unsigned-integer-dtype]</span><span class="delimiter">: </span><span class="description">determine the minimum ndarray data type for storing a provided unsigned integer value.</span>
128128
- <span class="signature">[`minViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/min-view-buffer-index]</span><span class="delimiter">: </span><span class="description">compute the minimum linear index in an underlying data buffer accessible to an array view.</span>
129129
- <span class="signature">[`minmaxViewBufferIndex( shape, strides, offset )`][@stdlib/ndarray/base/minmax-view-buffer-index]</span><span class="delimiter">: </span><span class="description">compute the minimum and maximum linear indices in an underlying data buffer which are accessible to an array view.</span>
130+
- <span class="signature">[`nans( dtype, shape, order )`][@stdlib/ndarray/base/nans]</span><span class="delimiter">: </span><span class="description">create a NaN-filled ndarray having a specified shape and data type.</span>
130131
- <span class="signature">[`ndarraylike2ndarray( x )`][@stdlib/ndarray/base/ndarraylike2ndarray]</span><span class="delimiter">: </span><span class="description">convert an ndarray-like object to an `ndarray`.</span>
131132
- <span class="signature">[`ndarraylike2object( x )`][@stdlib/ndarray/base/ndarraylike2object]</span><span class="delimiter">: </span><span class="description">convert an `ndarray`-like object to an object likely to have the same "shape".</span>
132133
- <span class="signature">[`ndarraylike2scalar( x )`][@stdlib/ndarray/base/ndarraylike2scalar]</span><span class="delimiter">: </span><span class="description">convert an ndarray-like object to a scalar value.</span>
@@ -141,9 +142,12 @@ var o = ns;
141142
- <span class="signature">[`nullaryStrided1d( fcn, arrays, dims[, options] )`][@stdlib/ndarray/base/nullary-strided1d]</span><span class="delimiter">: </span><span class="description">apply a one-dimensional strided array function to a list of specified dimensions in an ndarray.</span>
142143
- <span class="signature">[`nullaryBlockSize( dtypeX )`][@stdlib/ndarray/base/nullary-tiling-block-size]</span><span class="delimiter">: </span><span class="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
143144
- <span class="signature">[`nullary( arrays, fcn )`][@stdlib/ndarray/base/nullary]</span><span class="delimiter">: </span><span class="description">apply a nullary callback and assign results to elements in an output ndarray.</span>
145+
- <span class="signature">[`nulls( dtype, shape, order )`][@stdlib/ndarray/base/nulls]</span><span class="delimiter">: </span><span class="description">create a null-filled ndarray having a specified shape and data type.</span>
144146
- <span class="signature">[`numelDimension( x, dim )`][@stdlib/ndarray/base/numel-dimension]</span><span class="delimiter">: </span><span class="description">return the size (i.e., number of elements) of a specified dimension for a provided ndarray.</span>
145147
- <span class="signature">[`numel( shape )`][@stdlib/ndarray/base/numel]</span><span class="delimiter">: </span><span class="description">return the number of elements in an array.</span>
146148
- <span class="signature">[`offset( x )`][@stdlib/ndarray/base/offset]</span><span class="delimiter">: </span><span class="description">return the index offset specifying the underlying buffer index of the first iterated ndarray element.</span>
149+
- <span class="signature">[`onesLike( x )`][@stdlib/ndarray/base/ones-like]</span><span class="delimiter">: </span><span class="description">create a ones-filled ndarray having the same shape and data type as a provided ndarray.</span>
150+
- <span class="signature">[`ones( dtype, shape, order )`][@stdlib/ndarray/base/ones]</span><span class="delimiter">: </span><span class="description">create a ones-filled ndarray having a specified shape and data type.</span>
147151
- <span class="signature">[`order( x )`][@stdlib/ndarray/base/order]</span><span class="delimiter">: </span><span class="description">return the layout order of a provided ndarray.</span>
148152
- <span class="signature">[`outputDataType( dtypes, policy )`][@stdlib/ndarray/base/output-dtype]</span><span class="delimiter">: </span><span class="description">resolve the output ndarray data type from a list of input ndarray data types.</span>
149153
- <span class="signature">[`outputPolicyEnum2Str( policy )`][@stdlib/ndarray/base/output-policy-enum2str]</span><span class="delimiter">: </span><span class="description">return the policy string associated with an output ndarray data type policy enumeration constant.</span>
@@ -444,6 +448,8 @@ console.log( objectKeys( ns ) );
444448

445449
[@stdlib/ndarray/base/minmax-view-buffer-index]: https://github.com/stdlib-js/ndarray/tree/main/base/minmax-view-buffer-index
446450

451+
[@stdlib/ndarray/base/nans]: https://github.com/stdlib-js/ndarray/tree/main/base/nans
452+
447453
[@stdlib/ndarray/base/ndarraylike2ndarray]: https://github.com/stdlib-js/ndarray/tree/main/base/ndarraylike2ndarray
448454

449455
[@stdlib/ndarray/base/ndarraylike2object]: https://github.com/stdlib-js/ndarray/tree/main/base/ndarraylike2object
@@ -472,12 +478,18 @@ console.log( objectKeys( ns ) );
472478

473479
[@stdlib/ndarray/base/nullary]: https://github.com/stdlib-js/ndarray/tree/main/base/nullary
474480

481+
[@stdlib/ndarray/base/nulls]: https://github.com/stdlib-js/ndarray/tree/main/base/nulls
482+
475483
[@stdlib/ndarray/base/numel-dimension]: https://github.com/stdlib-js/ndarray/tree/main/base/numel-dimension
476484

477485
[@stdlib/ndarray/base/numel]: https://github.com/stdlib-js/ndarray/tree/main/base/numel
478486

479487
[@stdlib/ndarray/base/offset]: https://github.com/stdlib-js/ndarray/tree/main/base/offset
480488

489+
[@stdlib/ndarray/base/ones-like]: https://github.com/stdlib-js/ndarray/tree/main/base/ones-like
490+
491+
[@stdlib/ndarray/base/ones]: https://github.com/stdlib-js/ndarray/tree/main/base/ones
492+
481493
[@stdlib/ndarray/base/order]: https://github.com/stdlib-js/ndarray/tree/main/base/order
482494

483495
[@stdlib/ndarray/base/output-dtype]: https://github.com/stdlib-js/ndarray/tree/main/base/output-dtype

0 commit comments

Comments
 (0)