Skip to content

Commit b42421c

Browse files
committed
Auto-generated commit
1 parent bc8b6bb commit b42421c

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2025-11-12)
7+
## Unreleased (2025-11-13)
88

99
<section class="features">
1010

@@ -638,6 +638,7 @@ A total of 32 issues were closed in this release:
638638

639639
<details>
640640

641+
- [`c934b79`](https://github.com/stdlib-js/stdlib/commit/c934b79b7fef69aa707c58f8042648e3c7aa5925) - **docs:** update namespace table of contents [(#8517)](https://github.com/stdlib-js/stdlib/pull/8517) _(by stdlib-bot)_
641642
- [`037800a`](https://github.com/stdlib-js/stdlib/commit/037800a4294184df000d19e2ded62351016dce42) - **test:** use assertion utility and update example _(by Athan Reines)_
642643
- [`6d0ad29`](https://github.com/stdlib-js/stdlib/commit/6d0ad290fdb48864de0c09c5dd55c9eff7a22586) - **test:** use assertion utility and update example _(by Athan Reines)_
643644
- [`e091542`](https://github.com/stdlib-js/stdlib/commit/e091542b1f458f3dfb68bdae82314930575404c7) - **docs:** update example _(by Athan Reines)_

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,14 @@ In addition, the namespace contains the following multidimensional array utility
104104

105105
<div class="namespace-toc">
106106

107+
- <span class="signature">[`anyBy( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element along one or more `ndarray` dimensions passes a test implemented by a predicate function.</span>
108+
- <span class="signature">[`any( x[, options] )`][@stdlib/ndarray/any]</span><span class="delimiter">: </span><span class="description">test whether at least one element along one or more `ndarray` dimensions is truthy.</span>
107109
- <span class="signature">[`at( x[, ...indices] )`][@stdlib/ndarray/at]</span><span class="delimiter">: </span><span class="description">return an `ndarray` element.</span>
108110
- <span class="signature">[`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]</span><span class="delimiter">: </span><span class="description">broadcast an ndarray to a specified shape.</span>
109111
- <span class="signature">[`broadcastArrays( ...arrays )`][@stdlib/ndarray/broadcast-arrays]</span><span class="delimiter">: </span><span class="description">broadcast ndarrays to a common shape.</span>
110112
- <span class="signature">[`castingModes()`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</span>
113+
- <span class="signature">[`concat( arrays[, dim] )`][@stdlib/ndarray/concat]</span><span class="delimiter">: </span><span class="description">concatenate a list of ndarrays along a specified ndarray dimension.</span>
114+
- <span class="signature">[`copy( x[, options] )`][@stdlib/ndarray/copy]</span><span class="delimiter">: </span><span class="description">copy an input ndarray to a new ndarray having the same shape and data type.</span>
111115
- <span class="signature">[`countFalsy( x[, options] )`][@stdlib/ndarray/count-falsy]</span><span class="delimiter">: </span><span class="description">count the number of falsy elements along one or more `ndarray` dimensions.</span>
112116
- <span class="signature">[`countIf( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/count-if]</span><span class="delimiter">: </span><span class="description">count the number of truthy elements along one or more `ndarray` dimensions.</span>
113117
- <span class="signature">[`countTruthy( x[, options] )`][@stdlib/ndarray/count-truthy]</span><span class="delimiter">: </span><span class="description">count the number of truthy elements along one or more `ndarray` dimensions.</span>
@@ -126,9 +130,11 @@ In addition, the namespace contains the following multidimensional array utility
126130
- <span class="signature">[`fill( x, value )`][@stdlib/ndarray/fill]</span><span class="delimiter">: </span><span class="description">fill an input `ndarray` with a specified value.</span>
127131
- <span class="signature">[`filterMap( x[, options], fcn[, thisArg] )`][@stdlib/ndarray/filter-map]</span><span class="delimiter">: </span><span class="description">filter and map elements in an input ndarray to elements in a new output ndarray according to a callback function.</span>
128132
- <span class="signature">[`filter( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/filter]</span><span class="delimiter">: </span><span class="description">return a shallow copy of an ndarray containing only those elements which pass a test implemented by a predicate function.</span>
133+
- <span class="signature">[`find( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/find]</span><span class="delimiter">: </span><span class="description">return a new ndarray containing the first elements which pass a test implemented by a predicate function along one or more ndarray dimensions.</span>
129134
- <span class="signature">[`flag( x, name )`][@stdlib/ndarray/flag]</span><span class="delimiter">: </span><span class="description">return a specified flag for a provided ndarray.</span>
130135
- <span class="signature">[`flags( x )`][@stdlib/ndarray/flags]</span><span class="delimiter">: </span><span class="description">return the flags of a provided ndarray.</span>
131136
- <span class="signature">[`flattenBy( x[, options], fcn[, thisArg] )`][@stdlib/ndarray/flatten-by]</span><span class="delimiter">: </span><span class="description">flatten an ndarray according to a callback function.</span>
137+
- <span class="signature">[`flattenFrom( x, dim[, options] )`][@stdlib/ndarray/flatten-from]</span><span class="delimiter">: </span><span class="description">return a copy of an input ndarray where all dimensions of the input ndarray are flattened starting from a specified dimension.</span>
132138
- <span class="signature">[`flatten( x[, options] )`][@stdlib/ndarray/flatten]</span><span class="delimiter">: </span><span class="description">return a flattened copy of an input ndarray.</span>
133139
- <span class="signature">[`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]</span><span class="delimiter">: </span><span class="description">invoke a callback function once for each ndarray element.</span>
134140
- <span class="signature">[`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]</span><span class="delimiter">: </span><span class="description">convert a scalar value to a zero-dimensional ndarray.</span>
@@ -151,11 +157,15 @@ In addition, the namespace contains the following multidimensional array utility
151157
- <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>
152158
- <span class="signature">[`orders()`][@stdlib/ndarray/orders]</span><span class="delimiter">: </span><span class="description">list of ndarray orders.</span>
153159
- <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>
160+
- <span class="signature">[`pop( x[, options] )`][@stdlib/ndarray/pop]</span><span class="delimiter">: </span><span class="description">return an array containing a read-only truncated view of an input `ndarray` and a read-only view of the last element(s) along a specified dimension.</span>
154161
- <span class="signature">[`promotionRules( [dtype1, dtype2] )`][@stdlib/ndarray/promotion-rules]</span><span class="delimiter">: </span><span class="description">return the ndarray data type with the smallest size and closest "kind" to which ndarray data types can be **safely** cast.</span>
155162
- <span class="signature">[`reject( x[, options], predicate[, thisArg] )`][@stdlib/ndarray/reject]</span><span class="delimiter">: </span><span class="description">return a shallow copy of an ndarray containing only those elements which fail a test implemented by a predicate function.</span>
163+
- <span class="signature">[`reverseDimension( x, dim )`][@stdlib/ndarray/reverse-dimension]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of an input `ndarray` in which the order of elements along a specified dimension is reversed.</span>
164+
- <span class="signature">[`reverse( x )`][@stdlib/ndarray/reverse]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of an input `ndarray` in which the order of elements along each dimension is reversed.</span>
156165
- <span class="signature">[`safeCasts( [dtype] )`][@stdlib/ndarray/safe-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast.</span>
157166
- <span class="signature">[`sameKindCasts( [dtype] )`][@stdlib/ndarray/same-kind-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind".</span>
158167
- <span class="signature">[`shape( x )`][@stdlib/ndarray/shape]</span><span class="delimiter">: </span><span class="description">return the shape of a provided ndarray.</span>
168+
- <span class="signature">[`shift( x[, options] )`][@stdlib/ndarray/shift]</span><span class="delimiter">: </span><span class="description">return an array containing a read-only truncated view of an input `ndarray` and a read-only view of the first element(s) along a specified dimension.</span>
159169
- <span class="signature">[`sliceAssign( x, y, ...s[, options] )`][@stdlib/ndarray/slice-assign]</span><span class="delimiter">: </span><span class="description">assign element values from a broadcasted input `ndarray` to corresponding elements in an output `ndarray` view.</span>
160170
- <span class="signature">[`sliceDimensionFrom( x, dim, start[, options] )`][@stdlib/ndarray/slice-dimension-from]</span><span class="delimiter">: </span><span class="description">return a read-only shifted view of an input `ndarray` along a specified dimension.</span>
161171
- <span class="signature">[`sliceDimensionTo( x, dim, stop[, options] )`][@stdlib/ndarray/slice-dimension-to]</span><span class="delimiter">: </span><span class="description">return a read-only truncated view of an input `ndarray` along a specified dimension.</span>
@@ -170,6 +180,7 @@ In addition, the namespace contains the following multidimensional array utility
170180
- <span class="signature">[`ndarray2array( x )`][@stdlib/ndarray/to-array]</span><span class="delimiter">: </span><span class="description">convert an ndarray to a generic array.</span>
171181
- <span class="signature">[`ndarray2fancy( x[, options] )`][@stdlib/ndarray/to-fancy]</span><span class="delimiter">: </span><span class="description">convert an ndarray to an object supporting fancy indexing.</span>
172182
- <span class="signature">[`ndarray2json( x )`][@stdlib/ndarray/to-json]</span><span class="delimiter">: </span><span class="description">serialize an ndarray as a JSON object.</span>
183+
- <span class="signature">[`toReversed( x )`][@stdlib/ndarray/to-reversed]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where the order of elements of an input `ndarray` is reversed along each dimension.</span>
173184
- <span class="signature">[`vector`][@stdlib/ndarray/vector]</span><span class="delimiter">: </span><span class="description">vector constructors and associated utilities.</span>
174185
- <span class="signature">[`with( x, indices, value )`][@stdlib/ndarray/with]</span><span class="delimiter">: </span><span class="description">return a new ndarray with the element at a specified index replaced by a provided value.</span>
175186
- <span class="signature">[`zerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]</span><span class="delimiter">: </span><span class="description">create a zero-filled ndarray having the same shape and data type as a provided ndarray.</span>
@@ -284,6 +295,10 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
284295

285296
<!-- <toc-links> -->
286297

298+
[@stdlib/ndarray/any-by]: https://github.com/stdlib-js/ndarray/tree/main/any-by
299+
300+
[@stdlib/ndarray/any]: https://github.com/stdlib-js/ndarray/tree/main/any
301+
287302
[@stdlib/ndarray/at]: https://github.com/stdlib-js/ndarray/tree/main/at
288303

289304
[@stdlib/ndarray/broadcast-array]: https://github.com/stdlib-js/ndarray/tree/main/broadcast-array
@@ -292,6 +307,10 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
292307

293308
[@stdlib/ndarray/casting-modes]: https://github.com/stdlib-js/ndarray/tree/main/casting-modes
294309

310+
[@stdlib/ndarray/concat]: https://github.com/stdlib-js/ndarray/tree/main/concat
311+
312+
[@stdlib/ndarray/copy]: https://github.com/stdlib-js/ndarray/tree/main/copy
313+
295314
[@stdlib/ndarray/count-falsy]: https://github.com/stdlib-js/ndarray/tree/main/count-falsy
296315

297316
[@stdlib/ndarray/count-if]: https://github.com/stdlib-js/ndarray/tree/main/count-if
@@ -328,12 +347,16 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
328347

329348
[@stdlib/ndarray/filter]: https://github.com/stdlib-js/ndarray/tree/main/filter
330349

350+
[@stdlib/ndarray/find]: https://github.com/stdlib-js/ndarray/tree/main/find
351+
331352
[@stdlib/ndarray/flag]: https://github.com/stdlib-js/ndarray/tree/main/flag
332353

333354
[@stdlib/ndarray/flags]: https://github.com/stdlib-js/ndarray/tree/main/flags
334355

335356
[@stdlib/ndarray/flatten-by]: https://github.com/stdlib-js/ndarray/tree/main/flatten-by
336357

358+
[@stdlib/ndarray/flatten-from]: https://github.com/stdlib-js/ndarray/tree/main/flatten-from
359+
337360
[@stdlib/ndarray/flatten]: https://github.com/stdlib-js/ndarray/tree/main/flatten
338361

339362
[@stdlib/ndarray/for-each]: https://github.com/stdlib-js/ndarray/tree/main/for-each
@@ -378,16 +401,24 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
378401

379402
[@stdlib/ndarray/output-dtype-policies]: https://github.com/stdlib-js/ndarray/tree/main/output-dtype-policies
380403

404+
[@stdlib/ndarray/pop]: https://github.com/stdlib-js/ndarray/tree/main/pop
405+
381406
[@stdlib/ndarray/promotion-rules]: https://github.com/stdlib-js/ndarray/tree/main/promotion-rules
382407

383408
[@stdlib/ndarray/reject]: https://github.com/stdlib-js/ndarray/tree/main/reject
384409

410+
[@stdlib/ndarray/reverse-dimension]: https://github.com/stdlib-js/ndarray/tree/main/reverse-dimension
411+
412+
[@stdlib/ndarray/reverse]: https://github.com/stdlib-js/ndarray/tree/main/reverse
413+
385414
[@stdlib/ndarray/safe-casts]: https://github.com/stdlib-js/ndarray/tree/main/safe-casts
386415

387416
[@stdlib/ndarray/same-kind-casts]: https://github.com/stdlib-js/ndarray/tree/main/same-kind-casts
388417

389418
[@stdlib/ndarray/shape]: https://github.com/stdlib-js/ndarray/tree/main/shape
390419

420+
[@stdlib/ndarray/shift]: https://github.com/stdlib-js/ndarray/tree/main/shift
421+
391422
[@stdlib/ndarray/slice-assign]: https://github.com/stdlib-js/ndarray/tree/main/slice-assign
392423

393424
[@stdlib/ndarray/slice-dimension-from]: https://github.com/stdlib-js/ndarray/tree/main/slice-dimension-from
@@ -416,6 +447,8 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
416447

417448
[@stdlib/ndarray/to-json]: https://github.com/stdlib-js/ndarray/tree/main/to-json
418449

450+
[@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/ndarray/tree/main/to-reversed
451+
419452
[@stdlib/ndarray/vector]: https://github.com/stdlib-js/ndarray/tree/main/vector
420453

421454
[@stdlib/ndarray/with]: https://github.com/stdlib-js/ndarray/tree/main/with

0 commit comments

Comments
 (0)