8000 Auto-generated commit · stdlib-js/ndarray-base@e67bc6b · GitHub
[go: up one dir, main page]
Skip to content

Commit e67bc6b

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 4e2253f commit e67bc6b

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

‎README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,14 @@ npm install @stdlib/ndarray-base
4545

4646
Alternatively,
4747

48-
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm` branch][esm-url].
49-
- If you are using Deno, visit the [`deno` branch][deno-url].
50-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
48+
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
49+
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
50+
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
5151

5252
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
5353

54+
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
55+
5456
</section>
5557

5658
<section class="usage">
@@ -275,8 +277,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
275277
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
276278

277279
[deno-url]: https://github.com/stdlib-js/ndarray-base/tree/deno
280+
[deno-readme]: https://github.com/stdlib-js/ndarray-base/blob/deno/README.md
278281
[umd-url]: https://github.com/stdlib-js/ndarray-base/tree/umd
282+
[umd-readme]: https://github.com/stdlib-js/ndarray-base/blob/umd/README.md
279283
[esm-url]: https://github.com/stdlib-js/ndarray-base/tree/esm
284+
[esm-readme]: https://github.com/stdlib-js/ndarray-base/blob/esm/README.md
280285
[branches-url]: https://github.com/stdlib-js/ndarray-base/blob/main/branches.md
281286

282287
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base/main/LICENSE

‎branches.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ This repository has the following branches:
2424

2525
- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
2626
- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network).
27-
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
28-
- **deno**: [Deno][deno-url] branch for use in Deno.
29-
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
27+
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
28+
- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
29+
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
3030

3131
The following diagram illustrates the relationships among the above branches:
3232

@@ -49,5 +49,8 @@ C -->|bundle| F[umd];
4949
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base
5050
[production-url]: https://github.com/stdlib-js/ndarray-base/tree/production
5151
[deno-url]: https://github.com/stdlib-js/ndarray-base/tree/deno
52+
[deno-readme]: https://github.com/stdlib-js/ndarray-base/blob/deno/README.md
5253
[umd-url]: https://github.com/stdlib-js/ndarray-base/tree/umd
53-
[esm-url]: https://github.com/stdlib-js/ndarray-base/tree/esm
54+
[umd-readme]: https://github.com/stdlib-js/ndarray-base/blob/umd/README.md
55+
[esm-url]: https://github.com/stdlib-js/ndarray-base/tree/esm
56+
[esm-readme]: https://github.com/stdlib-js/ndarray-base/blob/esm/README.md

‎docs/types/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1715,6 +1715,7 @@ interface Namespace {
17151715
*
17161716
* - **sh**: dimensions sorted in loop order.
17171717
* - **sx**: ndarray strides sorted in loop order.
1718+
* - **idx**: dimension indices sorted in loop order.
17181719
*
17191720
* - When iterating over the elements of a multi-dimensional array, accessing elements which are closer in memory can improve performance. To this end, loop interchange is a technique used in loop nest optimization to improve locality of reference and take advantage of CPU cache.
17201721
*
@@ -1737,6 +1738,9 @@ interface Namespace {
17371738
*
17381739
* var ssx = o.sx;
17391740
* // returns [ 1, 4, 12 ]
1741+
*
1742+
* var idx = o.idx;
1743+
* // returns [ 2, 1, 0 ]
17401744
*/
17411745
nullaryLoopOrder: typeof nullaryLoopOrder;
17421746

0 commit comments

Comments
 (0)
0