Skip to content

Commit a9f37ff

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 9500c1c commit a9f37ff

File tree

86 files changed

+1511
-1505
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+1511
-1505
lines changed

‎README.md

+3
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">[`ndarrayMostlySafeCasts( [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>
126126
- <span class="signature">[`ndims( x )`][@stdlib/ndarray/ndims]</span><span class="delimiter">: </span><span class="description">return the number of ndarray dimensions.</span>
127127
- <span class="signature">[`ndarrayNextDataType( [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>
128+
- <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>
128129
- <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>
129130
- <span class="signature">[`ndarrayOffset( 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>
130131
- <span class="signature">[`ndarrayOrder( x )`][@stdlib/ndarray/order]</span><span class="delimiter">: </span><span class="description">return the layout order of a provided ndarray.</span>
@@ -300,6 +301,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
300301

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

304+
[@stdlib/ndarray/numel-dimension]: https://github.com/stdlib-js/ndarray/tree/main/numel-dimension
305+
303306
[@stdlib/ndarray/numel]: https://github.com/stdlib-js/ndarray/tree/main/numel
304307

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

‎base/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ var o = ns;
9494
- <span class="signature">[`nullaryLoopOrder( shape, stridesX )`][@stdlib/ndarray/base/nullary-loop-interchange-order]</span><span class="delimiter">: </span><span class="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
9595
- <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>
9696
- <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>
97+
- <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>
9798
- <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>
9899
- <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>
99100
- <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>
@@ -290,6 +291,8 @@ console.log( objectKeys( ns ) );
290291

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

294+
[@stdlib/ndarray/base/numel-dimension]: https://github.com/stdlib-js/ndarray/tree/main/base/numel-dimension
295+
293296
[@stdlib/ndarray/base/numel]: https://github.com/stdlib-js/ndarray/tree/main/base/numel
294297

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

‎base/assert/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ interface Namespace {
521521
* @returns boolean indicating whether an ndarray is read-only
522522
*
523523
* @example
524-
* var array = require( `@stdlib/ndarray/array` );
524+
* var array = require( './../../../../array' );
525525
*
526526
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ], {
527527
* 'readonly': true

‎base/assert/is-read-only/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { ndarray } from '@stdlib/types/ndarray';
2929
* @returns boolean indicating whether an ndarray is read-only
3030
*
3131
* @example
32-
* var array = require( `@stdlib/ndarray/array` );
32+
* var array = require( '@stdlib/ndarray/array' );
3333
*
3434
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ], {
3535
* 'readonly': true

‎base/assign/docs/types/index.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ import { ndarray } from '@stdlib/types/ndarray';
3131
* @throws arrays must have the same shape
3232
*
3333
* @example
34-
* var Float64Array = require( `@stdlib/array/float64` );
35-
* var ndarray = require( `@stdlib/ndarray/ctor` );
34+
* var Float64Array = require( '@stdlib/array/float64' );
35+
* var ndarray = require( '@stdlib/ndarray/ctor' );
3636
*
3737
* // Create data buffers:
3838
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );

‎base/broadcast-array/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ import { ndarray } from '@stdlib/types/ndarray';
4040
* @returns broadcasted array
4141
*
4242
* @example
43-
* var array = require( `@stdlib/ndarray/array` );
43+
* var array = require( '@stdlib/ndarray/array' );
4444
*
4545
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
4646
* // returns <ndarray>

‎base/broadcast-scalar/docs/types/index.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape,
8585
* @returns ndarray
8686
*
8787
* @example
88-
* var Complex128 = require( `@stdlib/complex/float64` );
88+
* var Complex128 = require( '@stdlib/complex/float64' );
8989
* var real = require( '@stdlib/complex/real' );
9090
* var imag = require( '@stdlib/complex/imag' );
9191
*
@@ -125,7 +125,7 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex12
125125
* @returns ndarray
126126
*
127127
* @example
128-
* var Complex64 = require( `@stdlib/complex/float32` );
128+
* var Complex64 = require( '@stdlib/complex/float32' );
129129
* var realf = require( '@stdlib/complex/realf' );
130130
* var imagf = require( '@stdlib/complex/imagf' );
131131
*

‎base/buffer-dtype-enum/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { Collection } from '@stdlib/types/array';
2929
* @returns data type enumeration constant or null
3030
*
3131
* @example
32-
* var Float64Array = require( `@stdlib/array/float64` );
32+
* var Float64Array = require( '@stdlib/array/float64' );
3333
*
3434
* var x = new Float64Array( 10 );
3535
*

‎base/data-buffer/docs/types/index.d.ts

+13-13
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { typedndarray, genericndarray, float64ndarray, float32ndarray, int32ndar
2929
* @returns underlying data buffer
3030
*
3131
* @example
32-
* var zeros = require( `@stdlib/ndarray/zeros` );
32+
* var zeros = require( '@stdlib/ndarray/zeros' );
3333
*
3434
* var x = zeros( [ 3, 3, 3 ], {
3535
* 'dtype': 'float64'
@@ -47,7 +47,7 @@ declare function data( x: float64ndarray ): float64ndarray[ 'data' ];
4747
* @returns underlying data buffer
4848
*
4949
* @example
50-
* var zeros = require( `@stdlib/ndarray/zeros` );
50+
* var zeros = require( '@stdlib/ndarray/zeros' );
5151
*
5252
* var x = zeros( [ 3, 3, 3 ], {
5353
* 'dtype': 'float32'
@@ -65,7 +65,7 @@ declare function data( x: float32ndarray ): float32ndarray[ 'data' ];
6565
* @returns underlying data buffer
6666
*
6767
* @example
68-
* var zeros = require( `@stdlib/ndarray/zeros` );
68+
* var zeros = require( '@stdlib/ndarray/zeros' );
6969
*
7070
* var x = zeros( [ 3, 3, 3 ], {
7171
* 'dtype': 'int32'
@@ -83,7 +83,7 @@ declare function data( x: int32ndarray ): int32ndarray[ 'data' ];
8383
* @returns underlying data buffer
8484
*
8585
* @example
86-
* var zeros = require( `@stdlib/ndarray/zeros` );
86+
* var zeros = require( '@stdlib/ndarray/zeros' );
8787
*
8888
* var x = zeros( [ 3, 3, 3 ], {
8989
* 'dtype': 'int16'
@@ -101,7 +101,7 @@ declare function data( x: int16ndarray ): int16ndarray[ 'data' ];
101101
* @returns underlying data buffer
102102
*
103103
* @example
104-
* var zeros = require( `@stdlib/ndarray/zeros` );
104+
* var zeros = require( '@stdlib/ndarray/zeros' );
105105
*
106106
* var x = zeros( [ 3, 3, 3 ], {
107107
* 'dtype': 'int8'
@@ -119,7 +119,7 @@ declare function data( x: int8ndarray ): int8ndarray[ 'data' ];
119119
* @returns underlying data buffer
120120
*
121121
* @example
122-
* var zeros = require( `@stdlib/ndarray/zeros` );
122+
* var zeros = require( '@stdlib/ndarray/zeros' );
123123
*
124124
* var x = zeros( [ 3, 3, 3 ], {
125125
* 'dtype': 'uint32'
@@ -137,7 +137,7 @@ declare function data( x: uint32ndarray ): uint32ndarray[ 'data' ];
137137
* @returns underlying data buffer
138138
*
139139
* @example
140-
* var zeros = require( `@stdlib/ndarray/zeros` );
140+
* var zeros = require( '@stdlib/ndarray/zeros' );
141141
*
142142
* var x = zeros( [ 3, 3, 3 ], {
143143
* 'dtype': 'uint16'
@@ -155,7 +155,7 @@ declare function data( x: uint16ndarray ): uint16ndarray[ 'data' ];
155155
* @returns underlying data buffer
156156
*
157157
* @example
158-
* var zeros = require( `@stdlib/ndarray/zeros` );
158+
* var zeros = require( '@stdlib/ndarray/zeros' );
159159
*
160160
* var x = zeros( [ 3, 3, 3 ], {
161161
* 'dtype': 'uint8'
@@ -173,7 +173,7 @@ declare function data( x: uint8ndarray ): uint8ndarray[ 'data' ];
173173
* @returns underlying data buffer
174174
*
175175
* @example
176-
* var zeros = require( `@stdlib/ndarray/zeros` );
176+
* var zeros = require( '@stdlib/ndarray/zeros' );
177177
*
178178
* var x = zeros( [ 3, 3, 3 ], {
179179
* 'dtype': 'uint8c'
@@ -191,7 +191,7 @@ declare function data( x: uint8cndarray ): uint8cndarray[ 'data' ];
191191
* @returns underlying data buffer
192192
*
193193
* @example
194-
* var zeros = require( `@stdlib/ndarray/zeros` );
194+
* var zeros = require( '@stdlib/ndarray/zeros' );
195195
*
196196
* var x = zeros( [ 3, 3, 3 ], {
197197
* 'dtype': 'complex128'
@@ -209,7 +209,7 @@ declare function data( x: complex128ndarray ): complex128ndarray[ 'data' ];
209209
* @returns underlying data buffer
210210
*
211211
* @example
212-
* var zeros = require( `@stdlib/ndarray/zeros` );
212+
* var zeros = require( '@stdlib/ndarray/zeros' );
213213
*
214214
* var x = zeros( [ 3, 3, 3 ], {
215215
* 'dtype': 'complex64'
@@ -227,7 +227,7 @@ declare function data( x: complex64ndarray ): complex64ndarray[ 'data' ];
227227
* @returns underlying data buffer
228228
*
229229
* @example
230-
* var zeros = require( `@stdlib/ndarray/zeros` );
230+
* var zeros = require( '@stdlib/ndarray/zeros' );
231231
*
232232
* var x = zeros( [ 3, 3, 3 ], {
233233
* 'dtype': 'generic'
@@ -245,7 +245,7 @@ declare function data<T = unknown>( x: genericndarray<T> ): genericndarray<T>[ '
245245
* @returns underlying data buffer
246246
*
247247
* @example
248-
* var zeros = require( `@stdlib/ndarray/zeros` );
248+
* var zeros = require( '@stdlib/ndarray/zeros' );
249249
*
250250
* var x = zeros( [ 3, 3, 3 ], {
251251
* 'dtype': 'float64'

0 commit comments

Comments
 (0)