Auto-generated commit

README.md

@@ -125,6 +125,7 @@ In addition, the namespace contains the following multidimensional array utility
 -   <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>
 -   <span class="signature">[`ndims( x )`][@stdlib/ndarray/ndims]</span><span class="delimiter">: </span><span class="description">return the number of ndarray dimensions.</span>
 -   <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>
+-   <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>
 -   <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>
 -   <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>
 -   <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].
 
 [@stdlib/ndarray/next-dtype]: https://github.com/stdlib-js/ndarray/tree/main/next-dtype
 
+[@stdlib/ndarray/numel-dimension]: https://github.com/stdlib-js/ndarray/tree/main/numel-dimension
+
 [@stdlib/ndarray/numel]: https://github.com/stdlib-js/ndarray/tree/main/numel
 
 [@stdlib/ndarray/offset]: https://github.com/stdlib-js/ndarray/tree/main/offset

base/README.md

@@ -94,6 +94,7 @@ var o = ns;
 -   <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>
 -   <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>
 -   <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>
+-   <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>
 -   <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>
 -   <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>
 -   <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 ) );
 
 [@stdlib/ndarray/base/nullary]: https://github.com/stdlib-js/ndarray/tree/main/base/nullary
 
+[@stdlib/ndarray/base/numel-dimension]: https://github.com/stdlib-js/ndarray/tree/main/base/numel-dimension
+
 [@stdlib/ndarray/base/numel]: https://github.com/stdlib-js/ndarray/tree/main/base/numel
 
 [@stdlib/ndarray/base/offset]: https://github.com/stdlib-js/ndarray/tree/main/base/offset

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

@@ -521,7 +521,7 @@ interface Namespace {
 	* @returns boolean indicating whether an ndarray is read-only
 	*
 	* @example
-	* var array = require( `@stdlib/ndarray/array` );
+	* var array = require( './../../../../array' );
 	*
 	* var x = array( [ [ 1, 2 ], [ 3, 4 ] ], {
 	*     'readonly': true

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

@@ -29,7 +29,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 * @returns boolean indicating whether an ndarray is read-only
 *
 * @example
-* var array = require( `@stdlib/ndarray/array` );
+* var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ], {
 *     'readonly': true

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

@@ -31,8 +31,8 @@ import { ndarray } from '@stdlib/types/ndarray';
 * @throws arrays must have the same shape
 *
 * @example
-* var Float64Array = require( `@stdlib/array/float64` );
-* var ndarray = require( `@stdlib/ndarray/ctor` );
+* var Float64Array = require( '@stdlib/array/float64' );
+* var ndarray = require( '@stdlib/ndarray/ctor' );
 *
 * // Create data buffers:
 * 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

@@ -40,7 +40,7 @@ import { ndarray } from '@stdlib/types/ndarray';
 * @returns broadcasted array
 *
 * @example
-* var array = require( `@stdlib/ndarray/array` );
+* var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
 * // returns <ndarray>

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

@@ -85,7 +85,7 @@ declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape,
 * @returns ndarray
 *
 * @example
-* var Complex128 = require( `@stdlib/complex/float64` );
+* var Complex128 = require( '@stdlib/complex/float64' );
 * var real = require( '@stdlib/complex/real' );
 * var imag = require( '@stdlib/complex/imag' );
 *
@@ -125,7 +125,7 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex12
 * @returns ndarray
 *
 * @example
-* var Complex64 = require( `@stdlib/complex/float32` );
+* var Complex64 = require( '@stdlib/complex/float32' );
 * var realf = require( '@stdlib/complex/realf' );
 * var imagf = require( '@stdlib/complex/imagf' );
 *

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

@@ -29,7 +29,7 @@ import { Collection } from '@stdlib/types/array';
 * @returns data type enumeration constant or null
 *
 * @example
-* var Float64Array = require( `@stdlib/array/float64` );
+* var Float64Array = require( '@stdlib/array/float64' );
 *
 * var x = new Float64Array( 10 );
 *

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

@@ -29,7 +29,7 @@ import { typedndarray, genericndarray, float64ndarray, float32ndarray, int32ndar
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'float64'
@@ -47,7 +47,7 @@ declare function data( x: float64ndarray ): float64ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'float32'
@@ -65,7 +65,7 @@ declare function data( x: float32ndarray ): float32ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'int32'
@@ -83,7 +83,7 @@ declare function data( x: int32ndarray ): int32ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'int16'
@@ -101,7 +101,7 @@ declare function data( x: int16ndarray ): int16ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'int8'
@@ -119,7 +119,7 @@ declare function data( x: int8ndarray ): int8ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'uint32'
@@ -137,7 +137,7 @@ declare function data( x: uint32ndarray ): uint32ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'uint16'
@@ -155,7 +155,7 @@ declare function data( x: uint16ndarray ): uint16ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'uint8'
@@ -173,7 +173,7 @@ declare function data( x: uint8ndarray ): uint8ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'uint8c'
@@ -191,7 +191,7 @@ declare function data( x: uint8cndarray ): uint8cndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'complex128'
@@ -209,7 +209,7 @@ declare function data( x: complex128ndarray ): complex128ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'complex64'
@@ -227,7 +227,7 @@ declare function data( x: complex64ndarray ): complex64ndarray[ 'data' ];
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'generic'
@@ -245,7 +245,7 @@ declare function data<T = unknown>( x: genericndarray<T> ): genericndarray<T>[ '
 * @returns underlying data buffer
 *
 * @example
-* var zeros = require( `@stdlib/ndarray/zeros` );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x = zeros( [ 3, 3, 3 ], {
 *     'dtype': 'float64'