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

Commit 24700e2

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 020b355 commit 24700e2

File tree

5 files changed

+80
-72
lines changed

5 files changed

+80
-72
lines changed

‎.github/.keepalive

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-01-01T05:08:58.642Z
1+
2024-02-01T05:58:37.950Z

‎NOTICE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Copyright (c) 2016-2023 The Stdlib Authors.
1+
Copyright (c) 2016-2024 The Stdlib Authors.

‎README.md

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

5656
Alternatively,
5757

58-
- 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].
59-
- If you are using Deno, visit the [`deno` branch][deno-url].
60-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
58+
- 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]).
59+
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
60+
- 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]).
6161

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

64+
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.
65+
6466
</section>
6567

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

295297
[deno-url]: https://github.com/stdlib-js/ndarray-base-slice/tree/deno
298+
[deno-readme]: https://github.com/stdlib-js/ndarray-base-slice/blob/deno/README.md
296299
[umd-url]: https://github.com/stdlib-js/ndarray-base-slice/tree/umd
300+
[umd-readme]: https://github.com/stdlib-js/ndarray-base-slice/blob/umd/README.md
297301
[esm-url]: https://github.com/stdlib-js/ndarray-base-slice/tree/esm
302+
[esm-readme]: https://github.com/stdlib-js/ndarray-base-slice/blob/esm/README.md
298303
[branches-url]: https://github.com/stdlib-js/ndarray-base-slice/blob/main/branches.md
299304

300305
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-slice/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/slice
5050
[production-url]: https://github.com/stdlib-js/ndarray-base-slice/tree/production
5151
[deno-url]: https://github.com/stdlib-js/ndarray-base-slice/tree/deno
52+
[deno-readme]: https://github.com/stdlib-js/ndarray-base-slice/blob/deno/README.md
5253
[umd-url]: https://github.com/stdlib-js/ndarray-base-slice/tree/umd
53-
[esm-url]: https://github.com/stdlib-js/ndarray-base-slice/tree/esm
54+
[umd-readme]: https://github.com/stdlib-js/ndarray-base-slice/blob/umd/README.md
55+
[esm-url]: https://github.com/stdlib-js/ndarray-base-slice/tree/esm
56+
[esm-readme]: https://github.com/stdlib-js/ndarray-base-slice/blob/esm/README.md

‎docs/types/index.d.ts

Lines changed: 63 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ import { MultiSlice } from '@stdlib/types/slice';
3333
* @returns output array
3434
*
3535
* @example
36-
* var Slice = require( `@stdlib/slice/ctor` );
37-
* var MultiSlice = require( `@stdlib/slice/multi` );
38-
* var typedarray = require( `@stdlib/array/typed` );
39-
* var ndarray = require( `@stdlib/ndarray/ctor` );
40-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
36+
* var Slice = require( '@stdlib/slice-ctor' );
37+
* var MultiSlice = require( '@stdlib/slice-multi' );
38+
* var typedarray = require( '@stdlib/array-typed' );
39+
* var ndarray = require( '@stdlib/ndarray-ctor' );
40+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
4141
*
4242
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' );
4343
* var shape = [ 3, 2 ];
@@ -77,11 +77,11 @@ declare function slice( x: float64ndarray, s: MultiSlice, strict: boolean, writa
7777
* @returns output array
7878
*
7979
* @example
80-
* var Slice = require( `@stdlib/slice/ctor` );
81-
* var MultiSlice = require( `@stdlib/slice/multi` );
82-
* var typedarray = require( `@stdlib/array/typed` );
83-
* var ndarray = require( `@stdlib/ndarray/ctor` );
84-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
80+
* var Slice = require( '@stdlib/slice-ctor' );
81+
* var MultiSlice = require( '@stdlib/slice-multi' );
82+
* var typedarray = require( '@stdlib/array-typed' );
83+
* var ndarray = require( '@stdlib/ndarray-ctor' );
84+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
8585
*
8686
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float32' );
8787
* var shape = [ 3, 2 ];
@@ -121,11 +121,11 @@ declare function slice( x: float32ndarray, s: MultiSlice, strict: boolean, writa
121121
* @returns output array
122122
*
123123
* @example
124-
* var Slice = require( `@stdlib/slice/ctor` );
125-
* var MultiSlice = require( `@stdlib/slice/multi` );
126-
* var typedarray = require( `@stdlib/array/typed` );
127-
* var ndarray = require( `@stdlib/ndarray/ctor` );
128-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
124+
* var Slice = require( '@stdlib/slice-ctor' );
125+
* var MultiSlice = require( '@stdlib/slice-multi' );
126+
* var typedarray = require( '@stdlib/array-typed' );
127+
* var ndarray = require( '@stdlib/ndarray-ctor' );
128+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
129129
*
130130
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int32' );
131131
* var shape = [ 3, 2 ];
@@ -165,11 +165,11 @@ declare function slice( x: int32ndarray, s: MultiSlice, strict: boolean, writabl
165165
* @returns output array
166166
*
167167
* @example
168-
* var Slice = require( `@stdlib/slice/ctor` );
169-
* var MultiSlice = require( `@stdlib/slice/multi` );
170-
* var typedarray = require( `@stdlib/array/typed` );
171-
* var ndarray = require( `@stdlib/ndarray/ctor` );
172-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
168+
* var Slice = require( '@stdlib/slice-ctor' );
169+
* var MultiSlice = require( '@stdlib/slice-multi' );
170+
* var typedarray = require( '@stdlib/array-typed' );
171+
* var ndarray = require( '@stdlib/ndarray-ctor' );
172+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
173173
*
174174
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int16' );
175175
* var shape = [ 3, 2 ];
@@ -209,11 +209,11 @@ declare function slice( x: int16ndarray, s: MultiSlice, strict: boolean, writabl
209209
* @returns output array
210210
*
211211
* @example
212-
* var Slice = require( `@stdlib/slice/ctor` );
213-
* var MultiSlice = require( `@stdlib/slice/multi` );
214-
* var typedarray = require( `@stdlib/array/typed` );
215-
* var ndarray = require( `@stdlib/ndarray/ctor` );
216-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
212+
* var Slice = require( '@stdlib/slice-ctor' );
213+
* var MultiSlice = require( '@stdlib/slice-multi' );
214+
* var typedarray = require( '@stdlib/array-typed' );
215+
* var ndarray = require( '@stdlib/ndarray-ctor' );
216+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
217217
*
218218
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int8' );
219219
* var shape = [ 3, 2 ];
@@ -253,11 +253,11 @@ declare function slice( x: int8ndarray, s: MultiSlice, strict: boolean, writable
253253
* @returns output array
254254
*
255255
* @example
256-
* var Slice = require( `@stdlib/slice/ctor` );
257-
* var MultiSlice = require( `@stdlib/slice/multi` );
258-
* var typedarray = require( `@stdlib/array/typed` );
259-
* var ndarray = require( `@stdlib/ndarray/ctor` );
260-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
256+
* var Slice = require( '@stdlib/slice-ctor' );
257+
* var MultiSlice = require( '@stdlib/slice-multi' );
258+
* var typedarray = require( '@stdlib/array-typed' );
259+
* var ndarray = require( '@stdlib/ndarray-ctor' );
260+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
261261
*
262262
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint32' );
263263
* var shape = [ 3, 2 ];
@@ -297,11 +297,11 @@ declare function slice( x: uint32ndarray, s: MultiSlice, strict: boolean, writab
297297
* @returns output array
298298
*
299299
* @example
300-
* var Slice = require( `@stdlib/slice/ctor` );
301-
* var MultiSlice = require( `@stdlib/slice/multi` );
302-
* var typedarray = require( `@stdlib/array/typed` );
303-
* var ndarray = require( `@stdlib/ndarray/ctor` );
304-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
300+
* var Slice = require( '@stdlib/slice-ctor' );
301+
* var MultiSlice = require( '@stdlib/slice-multi' );
302+
* var typedarray = require( '@stdlib/array-typed' );
303+
* var ndarray = require( '@stdlib/ndarray-ctor' );
304+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
305305
*
306306
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint16' );
307307
* var shape = [ 3, 2 ];
@@ -341,11 +341,11 @@ declare function slice( x: uint16ndarray, s: MultiSlice, strict: boolean, writab
341341
* @returns output array
342342
*
343343
* @example
344-
* var Slice = require( `@stdlib/slice/ctor` );
345-
* var MultiSlice = require( `@stdlib/slice/multi` );
346-
* var typedarray = require( `@stdlib/array/typed` );
347-
* var ndarray = require( `@stdlib/ndarray/ctor` );
348-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
344+
* var Slice = require( '@stdlib/slice-ctor' );
345+
* var MultiSlice = require( '@stdlib/slice-multi' );
346+
* var typedarray = require( '@stdlib/array-typed' );
347+
* var ndarray = require( '@stdlib/ndarray-ctor' );
348+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
349349
*
350350
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint8' );
351351
* var shape = [ 3, 2 ];
@@ -385,11 +385,11 @@ declare function slice( x: uint8ndarray, s: MultiSlice, strict: boolean, writabl
385385
* @returns output array
386386
*
387387
* @example
388-
* var Slice = require( `@stdlib/slice/ctor` );
389-
* var MultiSlice = require( `@stdlib/slice/multi` );
390-
* var typedarray = require( `@stdlib/array/typed` );
391-
* var ndarray = require( `@stdlib/ndarray/ctor` );
392-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
388+
* var Slice = require( '@stdlib/slice-ctor' );
389+
* var MultiSlice = require( '@stdlib/slice-multi' );
390+
* var typedarray = require( '@stdlib/array-typed' );
391+
* var ndarray = require( '@stdlib/ndarray-ctor' );
392+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
393393
*
394394
* var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint8c' );
395395
* var shape = [ 3, 2 ];
@@ -429,11 +429,11 @@ declare function slice( x: uint8cndarray, s: MultiSlice, strict: boolean, writab
429429
* @returns output array
430430
*
431431
* @example
432-
* var Slice = require( `@stdlib/slice/ctor` );
433-
* var MultiSlice = require( `@stdlib/slice/multi` );
434-
* var typedarray = require( `@stdlib/array/typed` );
435-
* var ndarray = require( `@stdlib/ndarray/ctor` );
436-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
432+
* var Slice = require( '@stdlib/slice-ctor' );
433+
* var MultiSlice = require( '@stdlib/slice-multi' );
434+
* var typedarray = require( '@stdlib/array-typed' );
435+
* var ndarray = require( '@stdlib/ndarray-ctor' );
436+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
437437
*
438438
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ], 'complex128' );
439439
* var shape = [ 3, 2 ];
@@ -467,11 +467,11 @@ declare function slice( x: complex128ndarray, s: MultiSlice, strict: boolean, wr
467467
* @returns output array
468468
*
469469
* @example
470-
* var Slice = require( `@stdlib/slice/ctor` );
471-
* var MultiSlice = require( `@stdlib/slice/multi` );
472-
* var typedarray = require( `@stdlib/array/typed` );
473-
* var ndarray = require( `@stdlib/ndarray/ctor` );
474-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
470+
* var Slice = require( '@stdlib/slice-ctor' );
471+
* var MultiSlice = require( '@stdlib/slice-multi' );
472+
* var typedarray = require( '@stdlib/array-typed' );
473+
* var ndarray = require( '@stdlib/ndarray-ctor' );
474+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
475475
*
476476
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ], 'complex64' );
477477
* var shape = [ 3, 2 ];
@@ -505,10 +505,10 @@ declare function slice( x: complex64ndarray, s: MultiSlice, strict: boolean, wri
505505
* @returns output array
506506
*
507507
* @example
508-
* var Slice = require( `@stdlib/slice/ctor` );
509-
* var MultiSlice = require( `@stdlib/slice/multi` );
510-
* var ndarray = require( `@stdlib/ndarray/ctor` );
511-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
508+
* var Slice = require( '@stdlib/slice-ctor' );
509+
* var MultiSlice = require( '@stdlib/slice-multi' );
510+
* var ndarray = require( '@stdlib/ndarray-ctor' );
511+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
512512
*
513513
* var buffer = [ 1, 2, 3, 4, 5, 6 ];
514514
* var shape = [ 3, 2 ];
@@ -548,10 +548,10 @@ declare function slice<T = unknown>( x: genericndarray<T>, s: MultiSlice, strict
548548
* @returns output array
549549
*
550550
* @example
551-
* var Slice = require( `@stdlib/slice/ctor` );
552-
* var MultiSlice = require( `@stdlib/slice/multi` );
553-
* var ndarray = require( `@stdlib/ndarray/ctor` );
554-
* var ndarray2array = require( `@stdlib/ndarray/to-array` );
551+
* var Slice = require( '@stdlib/slice-ctor' );
552+
* var MultiSlice = require( '@stdlib/slice-multi' );
553+
* var ndarray = require( '@stdlib/ndarray-ctor' );
554+
* var ndarray2array = require( '@stdlib/ndarray-to-array' );
555555
*
556556
* var buffer = [ 1, 2, 3, 4, 5, 6 ];
557557
* var shape = [ 3, 2 ];

0 commit comments

Comments
 (0)
0