Skip to content

Commit 0e64df0

Browse files
authored
docs: update examples
PR-URL: #9688 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 38631fc commit 0e64df0

1 file changed

Lines changed: 4 additions & 20 deletions

File tree

  • lib/node_modules/@stdlib/ndarray/docs/types

lib/node_modules/@stdlib/ndarray/docs/types/index.d.ts

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1214,7 +1214,6 @@ interface Namespace {
12141214
* @example
12151215
* var Float64Array = require( '@stdlib/array/float64' );
12161216
* var ndarray = require( '@stdlib/ndarray/ctor' );
1217-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
12181217
*
12191218
* function scale( z ) {
12201219
* if ( z > 5.0 ) {
@@ -1234,10 +1233,7 @@ interface Namespace {
12341233
* 'dtype': 'generic'
12351234
* };
12361235
* var y = ns.filterMap( x, opts, scale );
1237-
* // returns <ndarray>
1238-
*
1239-
* var arr = ndarray2array( y );
1240-
* // returns [ 80.0, 90.0, 100.0 ]
1236+
* // returns <ndarray>[ 80.0, 90.0, 100.0 ]
12411237
*/
12421238
filterMap: typeof filterMap;
12431239

@@ -1360,16 +1356,12 @@ interface Namespace {
13601356
*
13611357
* @example
13621358
* var array = require( '@stdlib/ndarray/array' );
1363-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
13641359
*
13651360
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
13661361
* // returns <ndarray>
13671362
*
13681363
* var y = ns.flatten( x );
1369-
* // returns <ndarray>
1370-
*
1371-
* var arr = ndarray2array( y );
1372-
* // returns [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
1364+
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
13731365
*/
13741366
flatten: typeof flatten;
13751367

@@ -1388,7 +1380,6 @@ interface Namespace {
13881380
* @example
13891381
* var Float64Array = require( '@stdlib/array/float64' );
13901382
* var ndarray = require( '@stdlib/ndarray/ctor' );
1391-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
13921383
*
13931384
* function scale( value ) {
13941385
* return value * 2.0;
@@ -1407,10 +1398,7 @@ interface Namespace {
14071398
* };
14081399
*
14091400
* var y = ns.flattenBy( x, opts, scale );
1410-
* // returns <ndarray>
1411-
*
1412-
* var arr = ndarray2array( y );
1413-
* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
1401+
* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
14141402
*/
14151403
flattenBy: typeof flattenBy;
14161404

@@ -1431,7 +1419,6 @@ interface Namespace {
14311419
* @example
14321420
* var array = require( '@stdlib/ndarray/array' );
14331421
* var shape = require( '@stdlib/ndarray/shape' );
1434-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
14351422
*
14361423
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
14371424
* // returns <ndarray>
@@ -1440,13 +1427,10 @@ interface Namespace {
14401427
* // returns [ 3, 1, 2 ]
14411428
*
14421429
* var y = ns.flattenFrom( x, 1 );
1443-
* // returns <ndarray>
1430+
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
14441431
*
14451432
* var shy = shape( y );
14461433
* // returns [ 3, 2 ]
1447-
*
1448-
* var arr = ndarray2array( y );
1449-
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
14501434
*/
14511435
flattenFrom: typeof flattenFrom;
14521436

0 commit comments

Comments
 (0)