Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -702,6 +702,7 @@ A total of 40 issues were closed in this release:
 
 <details>
 
+-   [`8ea33d5`](https://github.com/stdlib-js/stdlib/commit/8ea33d58d9a5beb31e6023ceaf331fc4175c74fa) - **docs:** rename parameter _(by Athan Reines)_
 -   [`5149a6b`](https://github.com/stdlib-js/stdlib/commit/5149a6b650b60568bd0df248c2a97a3d8ca2ca87) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`1aff763`](https://github.com/stdlib-js/stdlib/commit/1aff763c61863b7d737a699db89729d2bba0e1bc) - **feat:** add `ndarray/spread-dimensions` [(#9424)](https://github.com/stdlib-js/stdlib/pull/9424) _(by Muhammad Haris, Athan Reines)_
 -   [`9d53583`](https://github.com/stdlib-js/stdlib/commit/9d53583c9f82e1b2e5dc084849d98bd9c3214d45) - **test:** update descriptions _(by Athan Reines)_

base/expand-dimensions/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # expandDimensions
 
-> Expand the shape of an array by inserting a new dimension of size one at a specified axis.
+> Expand the shape of an array by inserting a new dimension of size one at a specified dimension index.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -40,9 +40,9 @@ limitations under the License.
 var expandDimensions = require( '@stdlib/ndarray/base/expand-dimensions' );
 ```
 
-#### expandDimensions( x, axis, writable )
+#### expandDimensions( x, dim, writable )
 
-Expands the shape of an array `x` by inserting a new dimension of size one at a specified `axis`.
+Expands the shape of an array `x` by inserting a new dimension of size one at a specified dimension index.
 
 ```javascript
 var getShape = require( '@stdlib/ndarray/shape' );
@@ -77,7 +77,7 @@ sh = getShape( y );
 The function accepts the following arguments:
 
 -   **x**: input ndarray.
--   **axis**: axis at which to insert a singleton dimension.
+-   **dim**: dimension index at which to insert a singleton dimension.
 -   **writable**: boolean indicating whether a returned ndarray should be writable.
 
 </section>
@@ -90,7 +90,7 @@ The function accepts the following arguments:
 
 ## Notes
 
--   A provided axis must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative `axis`, the axis position at which to insert a singleton dimension is computed as `N + axis + 1`. Hence, if provided `-1`, the resolved axis position is `N` (i.e., a singleton dimension is appended to the input array).
+-   A provided dimension index must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative dimension index, the position at which to insert a singleton dimension is computed as `N + dim + 1`. Hence, if provided `-1`, the resolved position is `N` (i.e., a singleton dimension is appended to the input array).
 -   The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
 
 </section>

base/expand-dimensions/docs/repl.txt

@@ -1,15 +1,15 @@
 
-{{alias}}( x, axis, writable )
+{{alias}}( x, dim, writable )
     Expands the shape of an array by inserting a new dimension of size one at a
-    specified axis.
+    specified dimension index.
 
-    A provided axis must reside on the interval `[-N-1, N]`, where `N` is the
-    rank (i.e., number of dimensions) of the provided input array.
+    A provided dimension index must reside on the interval `[-N-1, N]`, where
+    `N` is the rank (i.e., number of dimensions) of the provided input array.
 
-    If provided a negative axis value, the axis position at which to insert a
-    singleton dimension is computed as `N + axis + 1`. Hence, if provided `-1`,
-    the resolved axis position is `N` (i.e., a singleton dimension is appended
-    to the input array).
+    If provided a negative dimension index, the position at which to insert a
+    singleton dimension is computed as `N + dim + 1`. Hence, if provided `-1`,
+    the resolved position is `N` (i.e., a singleton dimension is appended to the
+    input array).
 
     The `writable` parameter only applies to ndarray constructors supporting
     read-only instances.
@@ -19,8 +19,8 @@
     x: ndarray
         Input array.
 
-    axis: integer
-        Axis at which to insert a singleton dimension.
+    dim: integer
+        Dimension index at which to insert a singleton dimension.
 
     writable: boolean
         Boolean indicating whether the returned ndarray should be writable.

base/expand-dimensions/docs/types/index.d.ts

@@ -23,14 +23,14 @@
 import { typedndarray } from '@stdlib/types/ndarray';
 
 /**
-* Expands the shape of an array by inserting a new dimension of size one at a specified axis.
+* Expands the shape of an array by inserting a new dimension of size one at a specified dimension index.
 *
 * ## Notes
 *
-* -   A provided axis must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative `axis`, the axis position at which to insert a singleton dimension is computed as `N + axis + 1`. Hence, if provided `-1`, the resolved axis position is `N` (i.e., a singleton dimension is appended to the input array).
+* -   A provided dimension index must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative dimension index, the position at which to insert a singleton dimension is computed as `N + dim + 1`. Hence, if provided `-1`, the resolved position is `N` (i.e., a singleton dimension is appended to the input array).
 *
 * @param x - input array
-* @param axis - axis at which to insert a singleton dimension
+* @param dim - dimension index at which to insert a singleton dimension
 * @param writable - boolean indicating whether the returned ndarray should be writable
 * @returns output array
 *
@@ -43,7 +43,7 @@ import { typedndarray } from '@stdlib/types/ndarray';
 * var y = expandDimensions( x, 1, false );
 * // returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
 */
-declare function expandDimensions<T = unknown>( x: typedndarray<T>, axis: number, writable: boolean ): typedndarray<T>;
+declare function expandDimensions<T = unknown, U extends typedndarray<T> = typedndarray<T>>( x: U, dim: number, writable: boolean ): U;
 
 
 // EXPORTS //

base/expand-dimensions/docs/types/test.ts

@@ -16,6 +16,8 @@
 * limitations under the License.
 */
 
+/* eslint-disable space-in-parens */
+
 import zeros = require( './../../../../zeros' );
 import expandDimensions = require( './index' );
 
@@ -24,9 +26,11 @@ import expandDimensions = require( './index' );
 
 // The function returns an ndarray...
 {
-	const x = zeros( [ 2, 2 ] );
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
-	expandDimensions( x, 1, false ); // $ExpectType typedndarray<number>
+	expandDimensions( x, 1, false ); // $ExpectType float64ndarray
 }
 
 // The compiler throws an error if the function is not provided a first argument which is an ndarray...

base/expand-dimensions/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Expand the shape of an array by inserting a new dimension of size one at a specified axis.
+* Expand the shape of an array by inserting a new dimension of size one at a specified dimension index.
 *
 * @module @stdlib/ndarray/base/expand-dimensions
 *

base/expand-dimensions/lib/main.js

@@ -34,16 +34,16 @@ var format = require( '@stdlib/string/format' );
 // MAIN //
 
 /**
-* Expands the shape of an array by inserting a new dimension of size one at a specified axis.
+* Expands the shape of an array by inserting a new dimension of size one at a specified dimension index.
 *
 * ## Notes
 *
-* -   A provided axis must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative `axis`, the axis position at which to insert a singleton dimension is computed as `N + axis + 1`. Hence, if provided `-1`, the resolved axis position is `N` (i.e., a singleton dimension is appended to the input array).
+* -   A provided dimension index must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative dimension index, the position at which to insert a singleton dimension is computed as `N + dim + 1`. Hence, if provided `-1`, the resolved position is `N` (i.e., a singleton dimension is appended to the input array).
 *
 * @param {ndarray} x - input array
-* @param {integer} axis - axis at which to insert a singleton dimension
+* @param {integer} dim - dimension index at which to insert a singleton dimension
 * @param {boolean} writable - boolean indicating whether the returned ndarray should be writable
-* @throws {RangeError} must provide a valid axis
+* @throws {RangeError} must provide a valid dimension index
 * @returns {ndarray} output array
 *
 * @example
@@ -55,7 +55,7 @@ var format = require( '@stdlib/string/format' );
 * var y = expandDimensions( x, 1, false );
 * // returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
 */
-function expandDimensions( x, axis, writable ) {
+function expandDimensions( x, dim, writable ) {
 	var strides;
 	var shape;
 	var isrm;
@@ -76,9 +76,9 @@ function expandDimensions( x, axis, writable ) {
 	strides = [];
 	shape = [];
 
-	d = normalizeIndex( axis, N );
+	d = normalizeIndex( dim, N );
 	if ( d === -1 ) {
-		throw new RangeError( format( 'invalid argument. Specified axis is out-of-bounds. Must be on the interval: [-%u, %u]. Value: `%d`.', N+1, N, axis ) );
+		throw new RangeError( format( 'invalid argument. Specified dimension index is out-of-bounds. Must be on the interval: [-%u, %u]. Value: `%d`.', N+1, N, dim ) );
 	}
 	if ( d === 0 ) {
 		// Prepend singleton dimension...

base/expand-dimensions/test/test.js

@@ -39,7 +39,7 @@ tape( 'main export is a function', function test( t ) {
 	t.end();
 });
 
-tape( 'the function throws an error if provided an invalid `axis` argument', function test( t ) {
+tape( 'the function throws an error if provided an invalid second argument', function test( t ) {
 	var values;
 	var x;
 	var i;
@@ -87,7 +87,7 @@ tape( 'the function prepends singleton dimensions', function test( t ) {
 	t.end();
 });
 
-tape( 'the function prepends singleton dimensions (negative axis)', function test( t ) {
+tape( 'the function prepends singleton dimensions (negative index)', function test( t ) {
 	var x;
 	var y;
 
@@ -133,7 +133,7 @@ tape( 'the function appends singleton dimensions', function test( t ) {
 	t.end();
 });
 
-tape( 'the function appends singleton dimensions (negative axis)', function test( t ) {
+tape( 'the function appends singleton dimensions (negative index)', function test( t ) {
 	var x;
 	var y;
 
@@ -179,7 +179,7 @@ tape( 'the function inserts singleton dimensions', function test( t ) {
 	t.end();
 });
 
-tape( 'the function inserts singleton dimensions (negative axis)', function test( t ) {
+tape( 'the function inserts singleton dimensions (negative index)', function test( t ) {
 	var x;
 	var y;
 
@@ -217,7 +217,7 @@ tape( 'the function prepends singleton dimensions (base; row-major)', function t
 	t.end();
 });
 
-tape( 'the function prepends singleton dimensions (base; row-major; negative axis)', function test( t ) {
+tape( 'the function prepends singleton dimensions (base; row-major; negative index)', function test( t ) {
 	var x;
 	var y;
 
@@ -277,7 +277,7 @@ tape( 'the function appends singleton dimensions (base; row-major)', function te
 	t.end();
 });
 
-tape( 'the function appends singleton dimensions (base; row-major; negative axis)', function test( t ) {
+tape( 'the function appends singleton dimensions (base; row-major; negative index)', function test( t ) {
 	var x;
 	var y;
 
@@ -337,7 +337,7 @@ tape( 'the function inserts singleton dimensions (base; row-major)', function te
 	t.end();
 });
 
-tape( 'the function inserts singleton dimensions (base; row-major; negative axis)', function test( t ) {
+tape( 'the function inserts singleton dimensions (base; row-major; negative index)', function test( t ) {
 	var x;
 	var y;