Skip to content

Commit 5ac6186

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 8e6d651 commit 5ac6186

File tree

5 files changed

+74
-54
lines changed

5 files changed

+74
-54
lines changed

‎CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1035,6 +1035,8 @@ A total of 4 people contributed to this release. Thank you to the following cont
10351035

10361036
<details>
10371037

1038+
- [`df3ed1e`](https://github.com/stdlib-js/stdlib/commit/df3ed1ee7fdc62c9f49bfa38eb1df240fb752a6e) - **docs:** update namespace ToCs _(by Athan Reines)_
1039+
- [`6a3b3d7`](https://github.com/stdlib-js/stdlib/commit/6a3b3d731ca697a62e3d58900e1b6cb06e7667dd) - **chore:** update directories meta data _(by Athan Reines)_
10381040
- [`ba0c5d0`](https://github.com/stdlib-js/stdlib/commit/ba0c5d0a00c8f2b5eff6321b14dd62398be26be8) - **feat:** add `ndarraylike2ndarray` to namespace _(by Athan Reines)_
10391041
- [`e7b56b1`](https://github.com/stdlib-js/stdlib/commit/e7b56b133fffc0bf83638ab267242c25eb8a359a) - **feat:** add `ndarray/ndarraylike2ndarray` _(by Athan Reines)_
10401042
- [`453c7f9`](https://github.com/stdlib-js/stdlib/commit/453c7f9f7c8ac5b8817b1d81f98af42570f1d0a5) - **refactor:** allow array-like objects containing submodes _(by Athan Reines)_

‎README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ In addition, the namespace contains the following multidimensional array utility
125125
- <span class="signature">[`maybeBroadcastArrays( arrays )`][@stdlib/ndarray/maybe-broadcast-arrays]</span><span class="delimiter">: </span><span class="description">broadcast ndarrays to a common shape.</span>
126126
- <span class="signature">[`minDataType( value )`][@stdlib/ndarray/min-dtype]</span><span class="delimiter">: </span><span class="description">determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value.</span>
127127
- <span class="signature">[`mostlySafeCasts( [dtype] )`][@stdlib/ndarray/mostly-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 and, for floating-point data types, can be downcast.</span>
128+
- <span class="signature">[`ndarraylike2ndarray( x[, options] )`][@stdlib/ndarray/ndarraylike2ndarray]</span><span class="delimiter">: </span><span class="description">convert an ndarray-like object to an `ndarray`.</span>
128129
- <span class="signature">[`ndims( x )`][@stdlib/ndarray/ndims]</span><span class="delimiter">: </span><span class="description">return the number of ndarray dimensions.</span>
129130
- <span class="signature">[`nextDataType( [dtype] )`][@stdlib/ndarray/next-dtype]</span><span class="delimiter">: </span><span class="description">return the next larger ndarray data type of the same kind.</span>
130131
- <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>
@@ -302,6 +303,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
302303

303304
[@stdlib/ndarray/mostly-safe-casts]: https://github.com/stdlib-js/ndarray/tree/main/mostly-safe-casts
304305

306+
[@stdlib/ndarray/ndarraylike2ndarray]: https://github.com/stdlib-js/ndarray/tree/main/ndarraylike2ndarray
307+
305308
[@stdlib/ndarray/ndims]: https://github.com/stdlib-js/ndarray/tree/main/ndims
306309

307310
[@stdlib/ndarray/next-dtype]: https://github.com/stdlib-js/ndarray/tree/main/next-dtype

‎base/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ var o = ns;
8787
- <span class="signature">[`metaDataProps( meta, dtypes, obj )`][@stdlib/ndarray/base/meta-data-props]</span><span class="delimiter">: </span><span class="description">define non-enumerable read-only properties which expose ndarray function meta data.</span>
8888
- <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>
8989
- <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>
90+
- <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>
9091
- <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>
9192
- <span class="signature">[`ndims( x )`][@stdlib/ndarray/base/ndims]</span><span class="delimiter">: </span><span class="description">return the number of ndarray dimensions.</span>
9293
- <span class="signature">[`nextCartesianIndex( shape, order, idx, dim )`][@stdlib/ndarray/base/next-cartesian-index]</span><span class="delimiter">: </span><span class="description">return the next Cartesian index (i.e., set of subscripts/dimension indices).</span>
@@ -278,6 +279,8 @@ console.log( objectKeys( ns ) );
278279

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

282+
[@stdlib/ndarray/base/ndarraylike2ndarray]: https://github.com/stdlib-js/ndarray/tree/main/base/ndarraylike2ndarray
283+
281284
[@stdlib/ndarray/base/ndarraylike2object]: https://github.com/stdlib-js/ndarray/tree/main/base/ndarraylike2object
282285

283286
[@stdlib/ndarray/base/ndims]: https://github.com/stdlib-js/ndarray/tree/main/base/ndims

‎base/map/package.json

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -6,60 +6,60 @@
66
"author": {
77
"name": "The Stdlib Authors",
88
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
9-
},
10-
"contributors": [
11-
{
12-
"name": "The Stdlib Authors",
13-
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
14-
}
15-
],
16-
"main": "./lib",
17-
"directories": {
18-
"benchmark": "./benchmark",
19-
"doc": "./docs",
20-
"example": "./examples",
21-
"lib": "./lib",
22-
"test": "./test"
23-
},
24-
"types": "./docs/types",
25-
"scripts": {},
26-
"homepage": "https://github.com/stdlib-js/stdlib",
27-
"repository": {
28-
"type": "git",
29-
"url": "git://github.com/stdlib-js/stdlib.git"
30-
},
31-
"bugs": {
32-
"url": "https://github.com/stdlib-js/stdlib/issues"
33-
},
34-
"dependencies": {},
35-
"devDependencies": {},
36-
"engines": {
37-
"node": ">=0.10.0",
38-
"npm": ">2.7.0"
39-
},
40-
"os": [
41-
"aix",
42-
"darwin",
43-
"freebsd",
44-
"linux",
45-
"macos",
46-
"openbsd",
47-
"sunos",
48-
"win32",
49-
"windows"
50-
],
51-
"keywords": [
52-
"stdlib",
53-
"base",
54-
"strided",
55-
"array",
56-
"ndarray",
57-
"map",
58-
"apply",
9+
},
10+
"contributors": [
11+
{
12+
"name": "The Stdlib Authors",
13+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
14+
}
15+
],
16+
"main": "./lib",
17+
"directories": {
18+
"benchmark": "./benchmark",
19+
"doc": "./docs",
20+
"example": "./examples",
21+
"lib": "./lib",
22+
"test": "./test"
23+
},
24+
"types": "./docs/types",
25+
"scripts": {},
26+
"homepage": "https://github.com/stdlib-js/stdlib",
27+
"repository": {
28+
"type": "git",
29+
"url": "git://github.com/stdlib-js/stdlib.git"
30+
},
31+
"bugs": {
32+
"url": "https://github.com/stdlib-js/stdlib/issues"
33+
},
34+
"dependencies": {},
35+
"devDependencies": {},
36+
"engines": {
37+
"node": ">=0.10.0",
38+
"npm": ">2.7.0"
39+
},
40+
"os": [
41+
"aix",
42+
"darwin",
43+
"freebsd",
44+
"linux",
45+
"macos",
46+
"openbsd",
47+
"sunos",
48+
"win32",
49+
"windows"
50+
],
51+
"keywords": [
52+
"stdlib",
53+
"base",
54+
"strided",
55+
"array",
56+
"ndarray",
57+
"map",
58+
"apply",
5959
"unary",
60-
"foreach",
61-
"transform",
60+
"foreach",
61+
"transform",
6262
"for-each"
63-
],
64-
"__stdlib__": {}
63+
],
64+
"__stdlib__": {}
6565
}

‎iter/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,14 @@ var o = ns;
4747
- <span class="signature">[`nditerColumns( x[, options] )`][@stdlib/ndarray/iter/columns]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each column in a matrix (or stack of matrices).</span>
4848
- <span class="signature">[`nditerEntries( x[, options] )`][@stdlib/ndarray/iter/entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns `[index, value]` pairs for each element in a provided `ndarray`.</span>
4949
- <span class="signature">[`nditerIndices( shape[, options] )`][@stdlib/ndarray/iter/indices]</span><span class="delimiter">: </span><span class="description">create an iterator which returns indices for use indexing into an `ndarray` having a specified shape.</span>
50+
- <span class="signature">[`nditerInterleaveSubarrays( arr, ndims )`][@stdlib/ndarray/iter/interleave-subarrays]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over interleaved subarrays.</span>
5051
- <span class="signature">[`nditerMatrices( x[, options] )`][@stdlib/ndarray/iter/matrices]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each matrix in a stack of matrices.</span>
5152
- <span class="signature">[`nditerMatrixEntries( x[, options] )`][@stdlib/ndarray/iter/matrix-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns `[index, matrix]` pairs for each matrix in a stack of matrices.</span>
5253
- <span class="signature">[`nditerRowEntries( x[, options] )`][@stdlib/ndarray/iter/row-entries]</span><span class="delimiter">: </span><span class="description">create an iterator which returns `[index, row]` pairs for each row in a matrix (or stack of matrices).</span>
5354
- <span class="signature">[`nditerRows( x[, options] )`][@stdlib/ndarray/iter/rows]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each row in a matrix (or stack of matrices).</span>
55+
- <span class="signature">[`nditerSelectDimension( x, dim[, options] )`][@stdlib/ndarray/iter/select-dimension]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each view along a specified dimension.</span>
56+
- <span class="signature">[`nditerStacks( x, dims[, options] )`][@stdlib/ndarray/iter/stacks]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each subarray in a stack of subarrays according to a list of specified stack dimensions.</span>
57+
- <span class="signature">[`nditerSubarrays( x, ndims[, options] )`][@stdlib/ndarray/iter/subarrays]</span><span class="delimiter">: </span><span class="description">create an iterator which iterates over each subarray in a stack of subarrays.</span>
5458
- <span class="signature">[`nditer2arrayEach( iterator )`][@stdlib/ndarray/iter/to-array-each]</span><span class="delimiter">: </span><span class="description">create an iterator which converts each iterated `ndarray` to a generic array.</span>
5559
- <span class="signature">[`nditerValues( x[, options] )`][@stdlib/ndarray/iter/values]</span><span class="delimiter">: </span><span class="description">create an iterator which returns individual elements from a provided `ndarray`.</span>
5660

@@ -103,6 +107,8 @@ console.log( objectKeys( ns ) );
103107

104108
[@stdlib/ndarray/iter/indices]: https://github.com/stdlib-js/ndarray/tree/main/iter/indices
105109

110+
[@stdlib/ndarray/iter/interleave-subarrays]: https://github.com/stdlib-js/ndarray/tree/main/iter/interleave-subarrays
111+
106112
[@stdlib/ndarray/iter/matrices]: https://github.com/stdlib-js/ndarray/tree/main/iter/matrices
107113

108114
[@stdlib/ndarray/iter/matrix-entries]: https://github.com/stdlib-js/ndarray/tree/main/iter/matrix-entries
@@ -111,6 +117,12 @@ console.log( objectKeys( ns ) );
111117

112118
[@stdlib/ndarray/iter/rows]: https://github.com/stdlib-js/ndarray/tree/main/iter/rows
113119

120+
[@stdlib/ndarray/iter/select-dimension]: https://github.com/stdlib-js/ndarray/tree/main/iter/select-dimension
121+
122+
[@stdlib/ndarray/iter/stacks]: https://github.com/stdlib-js/ndarray/tree/main/iter/stacks
123+
124+
[@stdlib/ndarray/iter/subarrays]: https://github.com/stdlib-js/ndarray/tree/main/iter/subarrays
125+
114126
[@stdlib/ndarray/iter/to-array-each]: https://github.com/stdlib-js/ndarray/tree/main/iter/to-array-each
115127

116128
[@stdlib/ndarray/iter/values]: https://github.com/stdlib-js/ndarray/tree/main/iter/values

0 commit comments

Comments
 (0)