Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -702,6 +702,7 @@ A total of 40 issues were closed in this release:
 
 <details>
 
+-   [`3686f6f`](https://github.com/stdlib-js/stdlib/commit/3686f6f542397f4000ce69cd3f1e9f5052d68321) - **docs:** improve doctests for ndarray instances in `ndarray/flatten` [(#9665)](https://github.com/stdlib-js/stdlib/pull/9665) _(by Shreelaxmi Hegde)_
 -   [`279f181`](https://github.com/stdlib-js/stdlib/commit/279f1817651a774f8d97f053529ac2bd94a94f91) - **docs:** update parameter name and description in `ndarray/base` TypeScript declaration  [(#9660)](https://github.com/stdlib-js/stdlib/pull/9660) _(by stdlib-bot)_
 -   [`7169fdd`](https://github.com/stdlib-js/stdlib/commit/7169fdd88c02203cb5eb31969417c99bff24057f) - **docs:** update `ndarray` TypeScript declaration example code [(#9661)](https://github.com/stdlib-js/stdlib/pull/9661) _(by stdlib-bot)_
 -   [`426da6e`](https://github.com/stdlib-js/stdlib/commit/426da6ec175dfdb72a9435612069bd5e2819b194) - **test:** add tests to `ndarray/count-truthy` for complete test code coverage [(#9593)](https://github.com/stdlib-js/stdlib/pull/9593) _(by Muhammad Haris, Athan Reines)_

flatten/README.md

@@ -42,16 +42,12 @@ Returns a flattened copy of an input [ndarray][@stdlib/ndarray/ctor].
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
 // returns <ndarray>
 
 var y = flatten( x );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+// returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 ```
 
 The function accepts the following arguments:
@@ -78,58 +74,46 @@ By default, the function flattens all dimensions of the input [ndarray][@stdlib/
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
 // returns <ndarray>
 
 var y = flatten( x, {
     'depth': 1
 });
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
+// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 ```
 
 By default, the input [ndarray][@stdlib/ndarray/ctor] is flattened in lexicographic order. To flatten elements in a different order, specify the `order` option.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
 // returns <ndarray>
 
 var y = flatten( x, {
     'order': 'column-major'
 });
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
+// returns <ndarray>[ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
 ```
 
 By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred from the input [ndarray][@stdlib/ndarray/ctor]. To return an ndarray with a different [data type][@stdlib/ndarray/dtypes], specify the `dtype` option.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
 var dtype = require( '@stdlib/ndarray/dtype' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
 // returns <ndarray>
 
 var y = flatten( x, {
     'dtype': 'float32'
 });
-// returns <ndarray>
+// returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 
 var dt = String( dtype( y ) );
 // returns 'float32'
-
-var arr = ndarray2array( y );
-// returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 ```
 
 </section>

flatten/docs/repl.txt

@@ -41,9 +41,8 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
-    > var y = {{alias}}( x );
-    > var arr = {{alias:@stdlib/ndarray/to-array}}( y )
-    [ 1.0, 2.0, 3.0, 4.0 ]
+    > var y = {{alias}}( x )
+    <ndarray>[ 1.0, 2.0, 3.0, 4.0 ]
 
     See Also
     --------

flatten/docs/types/index.d.ts

@@ -79,16 +79,12 @@ type Options<U> = BaseOptions & {
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
 * // returns <ndarray>
 *
 * var y = flatten( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 */
 declare function flatten<T extends ndarray>( x: T, options?: BaseOptions ): T;
 
@@ -108,16 +104,12 @@ declare function flatten<T extends ndarray>( x: T, options?: BaseOptions ): T;
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
 * // returns <ndarray>
 *
 * var y = flatten( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 */
 declare function flatten<T = unknown, U extends keyof DataTypeMap<T> = 'generic'>( x: typedndarray<T>, options: Options<U> ): DataTypeMap<T>[U];
 

flatten/lib/index.js

@@ -25,7 +25,6 @@
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var flatten = require( '@stdlib/ndarray/flatten' );
 *
 * // Create an input ndarray:
@@ -34,10 +33,7 @@
 *
 * // Flatten the input ndarray:
 * var y = flatten( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 */
 
 // MODULES //

flatten/lib/main.js

@@ -63,20 +63,15 @@ var COL_MAJOR = 'column-major';
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
 * // returns <ndarray>
 *
 * var y = flatten( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
 *     'shape': [ 2, 3 ],
@@ -85,14 +80,10 @@ var COL_MAJOR = 'column-major';
 * // returns <ndarray>
 *
 * var y = flatten( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
 *     'shape': [ 2, 3 ],
@@ -103,14 +94,10 @@ var COL_MAJOR = 'column-major';
 * var y = flatten( x, {
 *     'order': 'column-major'
 * });
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ]
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
 *     'shape': [ 2, 3 ],
@@ -121,14 +108,10 @@ var COL_MAJOR = 'column-major';
 * var y = flatten( x, {
 *     'order': 'row-major'
 * });
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 3.0, 5.0, 2.0, 4.0, 6.0 ]
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
 *     'shape': [ 2, 3 ],
@@ -139,14 +122,10 @@ var COL_MAJOR = 'column-major';
 * var y = flatten( x, {
 *     'order': 'same'
 * });
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], {
 *     'shape': [ 2, 3 ],
@@ -157,29 +136,21 @@ var COL_MAJOR = 'column-major';
 * var y = flatten( x, {
 *     'order': 'same'
 * });
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
 *
 * var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'row-major' );
 * // returns <ndarray>
 *
 * var y = flatten( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
+* // returns <ndarray>[ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
 *
@@ -188,14 +159,10 @@ var COL_MAJOR = 'column-major';
 * // returns <ndarray>
 *
 * var y = flatten( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
+* // returns <ndarray>[ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
 *
@@ -206,14 +173,10 @@ var COL_MAJOR = 'column-major';
 * var y = flatten( x, {
 *     'order': 'same'
 * });
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 6.0, 3.0, 5.0, 2.0, 4.0, 1.0 ]
+* // returns <ndarray>[ 6.0, 3.0, 5.0, 2.0, 4.0, 1.0 ]
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
 *
@@ -224,14 +187,10 @@ var COL_MAJOR = 'column-major';
 * var y = flatten( x, {
 *     'order': 'any'
 * });
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
+* // returns <ndarray>[ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
 *
@@ -240,14 +199,10 @@ var COL_MAJOR = 'column-major';
 * // returns <ndarray>
 *
 * var y = flatten( x );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 6.0, 4.0, 2.0, 5.0, 3.0, 1.0 ]
+* // returns <ndarray>[ 6.0, 4.0, 2.0, 5.0, 3.0, 1.0 ]
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
 *
@@ -258,14 +213,10 @@ var COL_MAJOR = 'column-major';
 * var y = flatten( x, {
 *     'order': 'same'
 * });
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 6.0, 4.0, 2.0, 5.0, 3.0, 1.0 ]
+* // returns <ndarray>[ 6.0, 4.0, 2.0, 5.0, 3.0, 1.0 ]
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
 *
@@ -276,10 +227,7 @@ var COL_MAJOR = 'column-major';
 * var y = flatten( x, {
 *     'order': 'any'
 * });
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
+* // returns <ndarray>[ 6.0, 5.0, 4.0, 3.0, 2.0, 1.0 ]
 */
 function flatten( x, options ) {
 	var view;