Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-12-29)
+## Unreleased (2025-12-30)
 
 <section class="features">
 
@@ -675,6 +675,9 @@ A total of 37 issues were closed in this release:
 
 <details>
 
+-   [`dcc971a`](https://github.com/stdlib-js/stdlib/commit/dcc971a838258413c22944447da8c6cd1c2a63f3) - **docs:** update examples and use accessor functions _(by Athan Reines)_
+-   [`16ce439`](https://github.com/stdlib-js/stdlib/commit/16ce439eb07c2a3212008ed9d2f5f6848da200f1) - **refactor:** update examples and return the input ndarray _(by Athan Reines)_
+-   [`508b9b9`](https://github.com/stdlib-js/stdlib/commit/508b9b99fc2547eb50be79ade7f68a34c5fd2146) - **docs:** update examples and use accessor functions _(by Athan Reines)_
 -   [`11b2d44`](https://github.com/stdlib-js/stdlib/commit/11b2d445b8f91c8bf41e3c6cc9d53d6a3a9f0608) - **refactor:** ensure support for enumeration constants _(by Athan Reines)_
 -   [`7c5881e`](https://github.com/stdlib-js/stdlib/commit/7c5881ea1b0a9251b4b758d24df128a4fab28fa6) - **docs:** update dtype type _(by Athan Reines)_
 -   [`374beff`](https://github.com/stdlib-js/stdlib/commit/374beff1f47c81bea4dd825d3b25ce405c2f9375) - **docs:** update dtype type _(by Athan Reines)_

base/expand-dimensions/README.md

@@ -45,31 +45,32 @@ var expandDimensions = require( '@stdlib/ndarray/base/expand-dimensions' );
 Expands the shape of an array `x` by inserting a new dimension of size one at a specified `axis`.
 
 ```javascript
+var getShape = require( '@stdlib/ndarray/shape' );
 var array = require( '@stdlib/ndarray/array' );
 
 // Create a 2x2 ndarray:
 var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-// returns <ndarray>
+// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 
 // Prepend a singleton dimension:
 var y = expandDimensions( x, 0 );
-// returns <ndarray>
+// returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ] ]
 
-var sh = y.shape;
+var sh = getShape( y );
 // returns [ 1, 2, 2 ]
 
 // Append a singleton dimension:
 y = expandDimensions( x, 2 );
-// returns <ndarray>
+// returns <ndarray>[ [ [ 1 ], [ 2 ] ], [ [ 3 ], [ 4 ] ] ]
 
-sh = y.shape;
+sh = getShape( y );
 // returns [ 2, 2, 1 ]
 
 // Insert a singleton dimension:
 y = expandDimensions( x, 1 );
-// returns <ndarray>
+// returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
 
-sh = y.shape;
+sh = getShape( y );
 // returns [ 2, 1, 2 ]
 ```
 
@@ -101,6 +102,7 @@ sh = y.shape;
 var array = require( '@stdlib/ndarray/array' );
 var numel = require( '@stdlib/ndarray/base/numel' );
 var ind2sub = require( '@stdlib/ndarray/ind2sub' );
+var getShape = require( '@stdlib/ndarray/shape' );
 var expandDimensions = require( '@stdlib/ndarray/base/expand-dimensions' );
 
 // Create a 2-dimensional array:
@@ -112,7 +114,7 @@ var y = expandDimensions( x, 1 );
 // returns <ndarray>
 
 // Retrieve the shape:
-var sh = y.shape;
+var sh = getShape( y );
 // returns [ 2, 1, 2 ]
 
 // Retrieve the number of elements:

base/expand-dimensions/docs/repl.txt

@@ -27,21 +27,13 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
-    <ndarray>
-    > var sh = x.shape
+    <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
+    > var sh = {{alias:@stdlib/ndarray/shape}}( x )
     [ 2, 2 ]
     > var y = {{alias}}( x, 1 )
-    <ndarray>
-    > sh = y.shape
+    <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
+    > sh = {{alias:@stdlib/ndarray/shape}}( y )
     [ 2, 1, 2 ]
-    > var v = y.get( 0, 0, 0 )
-    1
-    > v = y.get( 0, 0, 1 )
-    2
-    > v = y.get( 1, 0, 0 )
-    3
-    > v = y.get( 1, 0, 1 )
-    4
 
     See Also
     --------

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

@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ndarray } from '@stdlib/types/ndarray';
+import { typedndarray } from '@stdlib/types/ndarray';
 
 /**
 * Expands the shape of an array by inserting a new dimension of size one at a specified axis.
@@ -34,33 +34,22 @@ import { ndarray } from '@stdlib/types/ndarray';
 * @returns output array
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
-* var shx = x.shape;
+* var shx = getShape( x );
 * // returns [ 2, 2 ]
 *
 * var y = expandDimensions( x, 1 );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
 *
-* var shy = y.shape;
+* var shy = getShape( y );
 * // returns [ 2, 1, 2 ]
-*
-* var v = y.get( 0, 0, 0 );
-* // returns 1
-*
-* v = y.get( 0, 0, 1 );
-* // returns 2
-*
-* v = y.get( 1, 0, 0 );
-* // returns 3
-*
-* v = y.get( 1, 0, 1 );
-* // returns 4
 */
-declare function expandDimensions( x: ndarray, axis: number ): ndarray;
+declare function expandDimensions<T = unknown>( x: typedndarray<T>, axis: number ): typedndarray<T>;
 
 
 // EXPORTS //

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

@@ -16,17 +16,17 @@
 * limitations under the License.
 */
 
-import array = require( './../../../../array' );
+import zeros = require( './../../../../zeros' );
 import expandDimensions = require( './index' );
 
 
 // TESTS //
 
 // The function returns an ndarray...
 {
-	const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+	const x = zeros( [ 2, 2 ] );
 
-	expandDimensions( x, 1 ); // $ExpectType ndarray
+	expandDimensions( x, 1 ); // $ExpectType typedndarray<number>
 }
 
 // The compiler throws an error if the function is not provided a first argument which is an ndarray...
@@ -43,7 +43,7 @@ import expandDimensions = require( './index' );
 
 // The compiler throws an error if the function is not provided a second argument which is a number...
 {
-	const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+	const x = zeros( [ 2, 2 ] );
 
 	expandDimensions( x, '5' ); // $ExpectError
 	expandDimensions( x, true ); // $ExpectError
@@ -56,7 +56,7 @@ import expandDimensions = require( './index' );
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
 {
-	const x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+	const x = zeros( [ 2, 2 ] );
 
 	expandDimensions(); // $ExpectError
 	expandDimensions( x ); // $ExpectError

base/expand-dimensions/examples/index.js

@@ -21,6 +21,7 @@
 var array = require( './../../../array' );
 var numel = require( './../../../base/numel' );
 var ind2sub = require( './../../../ind2sub' );
+var getShape = require( './../../../shape' );
 var expandDimensions = require( './../lib' );
 
 // Create a 2-dimensional array:
@@ -32,7 +33,7 @@ var y = expandDimensions( x, 1 );
 // returns <ndarray>
 
 // Retrieve the shape:
-var sh = y.shape;
+var sh = getShape( y );
 // returns [ 2, 1, 2 ]
 
 // Retrieve the number of elements:

base/expand-dimensions/lib/index.js

@@ -24,32 +24,21 @@
 * @module @stdlib/ndarray/base/expand-dimensions
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var array = require( '@stdlib/ndarray/array' );
 * var expandDimensions = require( '@stdlib/ndarray/base/expand-dimensions' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
-* var shx = x.shape;
+* var shx = getShape( x );
 * // returns [ 2, 2 ]
 *
 * var y = expandDimensions( x, 1 );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
 *
-* var shy = y.shape;
+* var shy = getShape( y );
 * // returns [ 2, 1, 2 ]
-*
-* var v = y.get( 0, 0, 0 );
-* // returns 1
-*
-* v = y.get( 0, 0, 1 );
-* // returns 2
-*
-* v = y.get( 1, 0, 0 );
-* // returns 3
-*
-* v = y.get( 1, 0, 1 );
-* // returns 4
 */
 
 // MODULES //

base/expand-dimensions/lib/main.js

@@ -47,31 +47,20 @@ var format = require( '@stdlib/string/format' );
 * @returns {ndarray} output array
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var array = require( '@stdlib/ndarray/array' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
-* var shx = x.shape;
+* var shx = getShape( x );
 * // returns [ 2, 2 ]
 *
 * var y = expandDimensions( x, 1 );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
 *
-* var shy = y.shape;
+* var shy = getShape( y );
 * // returns [ 2, 1, 2 ]
-*
-* var v = y.get( 0, 0, 0 );
-* // returns 1
-*
-* v = y.get( 0, 0, 1 );
-* // returns 2
-*
-* v = y.get( 1, 0, 0 );
-* // returns 3
-*
-* v = y.get( 1, 0, 1 );
-* // returns 4
 */
 function expandDimensions( x, axis ) {
 	var strides;