Skip to content

Commit aa84074

Browse files
claudeclaude
committed
docs: inline ndarray output in doctests across stats/base/ndarray/* and blas/ext/base/ndarray/*
Propagates fix from 7be0aa6, a6b67f6, 71a93c8, adc6eb6, d5dc0ec, 9e562a3, a19ed4c, 00385f6 ("docs: improve doctests for ndarray instances in ..."), and 849495e ("docs: update example") to sibling ndarray-instance packages — removing the `ndarray2array` import plus the trailing `var arr = ndarray2array( v )` block and inlining the array value into the `// returns <ndarray>[...]` comment. Applied to: - stats/base/ndarray: scumaxabs, scuminabs, plus 10 `@example` blocks in stats/base/ndarray/docs/types/index.d.ts (cumax, cumin, dcumax, dcumaxabs, dcumin, dcuminabs, scumax, scumaxabs, scumin, scuminabs). - blas/ext/base/ndarray: dcusumkbn (main.js only), dsortins, dsortsh, gcusumkbn, gcusumkbn2, gcusumors, gcusumpw, glinspace, gsorthp, scusumkbn, scusumkbn2, scusumors, slinspace, ssorthp, plus 13 `@example` blocks in blas/ext/base/ndarray/docs/types/index.d.ts (dsortins, dsortsh, gcusumkbn, gcusumkbn2, gcusumors, gcusumpw, glinspace, gsorthp, scusumkbn, scusumkbn2, scusumors, slinspace, ssorthp). The `Examples` section of each README (runnable `console.log` blocks) is intentionally untouched; the fix only applies to the Usage doctest blocks. https://claude.ai/code/session_01GXZT2uLjX36Q2EepAt4GeQ
1 parent 45addf3 commit aa84074

File tree

65 files changed

+88
-426
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+88
-426
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dcusumkbn/lib/main.js‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ var strided = require( '@stdlib/blas/ext/base/dcusumkbn' ).ndarray;
3838
*
3939
* @example
4040
* var Float64Array = require( '@stdlib/array/float64' );
41-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4241
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
4342
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
4443
*
@@ -51,13 +50,10 @@ var strided = require( '@stdlib/blas/ext/base/dcusumkbn' ).ndarray;
5150
* var initial = scalar2ndarray( 0.0, 'float64', 'row-major' );
5251
*
5352
* var v = dcusumkbn( [ x, y, initial ] );
54-
* // returns <ndarray>
53+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
5554
*
5655
* var bool = ( v === y );
5756
* // returns true
58-
*
59-
* var arr = ndarray2array( v );
60-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
6157
*/
6258
function dcusumkbn( arrays ) {
6359
var x = arrays[ 0 ];

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts‎

Lines changed: 13 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,6 @@ interface Namespace {
609609
*
610610
* @example
611611
* var Float64Array = require( '@stdlib/array/float64' );
612-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
613612
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
614613
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
615614
*
@@ -621,10 +620,7 @@ interface Namespace {
621620
* });
622621
*
623622
* var out = ns.dsortins( [ x, ord ] );
624-
* // returns <ndarray>
625-
*
626-
* var arr = ndarray2array( out );
627-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
623+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
628624
*/
629625
dsortins: typeof dsortins;
630626

@@ -640,7 +636,6 @@ interface Namespace {
640636
*
641637
* @example
642638
* var Float64Array = require( '@stdlib/array/float64' );
643-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
644639
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
645640
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
646641
*
@@ -652,10 +647,7 @@ interface Namespace {
652647
* });
653648
*
654649
* var out = ns.dsortsh( [ x, ord ] );
655-
* // returns <ndarray>
656-
*
657-
* var arr = ndarray2array( out );
658-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
650+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
659651
*/
660652
dsortsh: typeof dsortsh;
661653

@@ -823,7 +815,6 @@ interface Namespace {
823815
* @returns output ndarray
824816
*
825817
* @example
826-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
827818
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
828819
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
829820
*
@@ -836,13 +827,10 @@ interface Namespace {
836827
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
837828
*
838829
* var v = ns.gcusumkbn( [ x, y, initial ] );
839-
* // returns <ndarray>
830+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
840831
*
841832
* var bool = ( v === y );
842833
* // returns true
843-
*
844-
* var arr = ndarray2array( v );
845-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
846834
*/
847835
gcusumkbn: typeof gcusumkbn;
848836

@@ -853,7 +841,6 @@ interface Namespace {
853841
* @returns output ndarray
854842
*
855843
* @example
856-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
857844
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
858845
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
859846
*
@@ -866,13 +853,10 @@ interface Namespace {
866853
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
867854
*
868855
* var v = ns.gcusumkbn2( [ x, y, initial ] );
869-
* // returns <ndarray>
856+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
870857
*
871858
* var bool = ( v === y );
872859
* // returns true
873-
*
874-
* var arr = ndarray2array( v );
875-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
876860
*/
877861
gcusumkbn2: typeof gcusumkbn2;
878862

@@ -883,7 +867,6 @@ interface Namespace {
883867
* @returns output ndarray
884868
*
885869
* @example
886-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
887870
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
888871
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
889872
*
@@ -896,13 +879,10 @@ interface Namespace {
896879
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
897880
*
898881
* var v = ns.gcusumors( [ x, y, initial ] );
899-
* // returns <ndarray>
882+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
900883
*
901884
* var bool = ( v === y );
902885
* // returns true
903-
*
904-
* var arr = ndarray2array( v );
905-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
906886
*/
907887
gcusumors: typeof gcusumors;
908888

@@ -913,7 +893,6 @@ interface Namespace {
913893
* @returns output ndarray
914894
*
915895
* @example
916-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
917896
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
918897
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
919898
*
@@ -926,13 +905,10 @@ interface Namespace {
926905
* var initial = scalar2ndarray( 0.0, 'generic', 'row-major' );
927906
*
928907
* var v = ns.gcusumpw( [ x, y, initial ] );
929-
* // returns <ndarray>
908+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
930909
*
931910
* var bool = ( v === y );
932911
* // returns true
933-
*
934-
* var arr = ndarray2array( v );
935-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
936912
*/
937913
gcusumpw: typeof gcusumpw;
938914

@@ -1110,7 +1086,6 @@ interface Namespace {
11101086
*
11111087
* @example
11121088
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
1113-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
11141089
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
11151090
*
11161091
* var xbuf = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
@@ -1129,10 +1104,7 @@ interface Namespace {
11291104
* });
11301105
*
11311106
* var out = ns.glinspace( [ x, start, stop, endpoint ] );
1132-
* // returns <ndarray>
1133-
*
1134-
* var arr = ndarray2array( out );
1135-
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
1107+
* // returns <ndarray>[ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
11361108
*/
11371109
glinspace: typeof glinspace;
11381110

@@ -1279,7 +1251,6 @@ interface Namespace {
12791251
* @returns input ndarray
12801252
*
12811253
* @example
1282-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
12831254
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
12841255
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
12851256
*
@@ -1291,10 +1262,7 @@ interface Namespace {
12911262
* });
12921263
*
12931264
* var out = ns.gsorthp( [ x, ord ] );
1294-
* // returns <ndarray>
1295-
*
1296-
* var arr = ndarray2array( out );
1297-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
1265+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
12981266
*/
12991267
gsorthp: typeof gsorthp;
13001268

@@ -1459,7 +1427,6 @@ interface Namespace {
14591427
*
14601428
* @example
14611429
* var Float32Array = require( '@stdlib/array/float32' );
1462-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
14631430
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
14641431
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
14651432
*
@@ -1472,13 +1439,10 @@ interface Namespace {
14721439
* var initial = scalar2ndarray( 0.0, 'float32', 'row-major' );
14731440
*
14741441
* var v = ns.scusumkbn( [ x, y, initial ] );
1475-
* // returns <ndarray>
1442+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
14761443
*
14771444
* var bool = ( v === y );
14781445
* // returns true
1479-
*
1480-
* var arr = ndarray2array( v );
1481-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
14821446
*/
14831447
scusumkbn: typeof scusumkbn;
14841448

@@ -1490,7 +1454,6 @@ interface Namespace {
14901454
*
14911455
* @example
14921456
* var Float32Array = require( '@stdlib/array/float32' );
1493-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
14941457
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
14951458
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
14961459
*
@@ -1503,13 +1466,10 @@ interface Namespace {
15031466
* var initial = scalar2ndarray( 0.0, 'float32', 'row-major' );
15041467
*
15051468
* var v = ns.scusumkbn2( [ x, y, initial ] );
1506-
* // returns <ndarray>
1469+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
15071470
*
15081471
* var bool = ( v === y );
15091472
* // returns true
1510-
*
1511-
* var arr = ndarray2array( v );
1512-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
15131473
*/
15141474
scusumkbn2: typeof scusumkbn2;
15151475

@@ -1521,7 +1481,6 @@ interface Namespace {
15211481
*
15221482
* @example
15231483
* var Float32Array = require( '@stdlib/array/float32' );
1524-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
15251484
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
15261485
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
15271486
*
@@ -1534,13 +1493,10 @@ interface Namespace {
15341493
* var initial = scalar2ndarray( 0.0, 'float32', 'row-major' );
15351494
*
15361495
* var v = ns.scusumors( [ x, y, initial ] );
1537-
* // returns <ndarray>
1496+
* // returns <ndarray>[ 1.0, 4.0, 8.0, 10.0 ]
15381497
*
15391498
* var bool = ( v === y );
15401499
* // returns true
1541-
*
1542-
* var arr = ndarray2array( v );
1543-
* // returns [ 1.0, 4.0, 8.0, 10.0 ]
15441500
*/
15451501
scusumors: typeof scusumors;
15461502

@@ -1616,7 +1572,6 @@ interface Namespace {
16161572
* @example
16171573
* var Float32Array = require( '@stdlib/array/float32' );
16181574
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
1619-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
16201575
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
16211576
*
16221577
* var xbuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -1635,10 +1590,7 @@ interface Namespace {
16351590
* });
16361591
*
16371592
* var out = ns.slinspace( [ x, start, stop, endpoint ] );
1638-
* // returns <ndarray>
1639-
*
1640-
* var arr = ndarray2array( out );
1641-
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
1593+
* // returns <ndarray>[ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
16421594
*/
16431595
slinspace: typeof slinspace;
16441596

@@ -1793,7 +1745,6 @@ interface Namespace {
17931745
*
17941746
* @example
17951747
* var Float32Array = require( '@stdlib/array/float32' );
1796-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
17971748
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
17981749
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
17991750
*
@@ -1805,10 +1756,7 @@ interface Namespace {
18051756
* });
18061757
*
18071758
* var out = ns.ssorthp( [ x, ord ] );
1808-
* // returns <ndarray>
1809-
*
1810-
* var arr = ndarray2array( out );
1811-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
1759+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
18121760
*/
18131761
ssorthp: typeof ssorthp;
18141762

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dsortins/README.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ Sorts a one-dimensional double-precision floating-point ndarray using insertion
4343
```javascript
4444
var Float64Array = require( '@stdlib/array/float64' );
4545
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
46-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4746
var ndarray = require( '@stdlib/ndarray/base/ctor' );
4847

4948
var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );
@@ -54,10 +53,7 @@ var order = scalar2ndarray( 1.0, {
5453
});
5554

5655
var out = dsortins( [ x, order ] );
57-
// returns <ndarray>
58-
59-
var arr = ndarray2array( out );
60-
// returns [ -4.0, -2.0, 1.0, 3.0 ]
56+
// returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
6157
```
6258

6359
The function has the following parameters:

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dsortins/docs/types/index.d.ts‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ import { typedndarray, float64ndarray } from '@stdlib/types/ndarray';
3434
*
3535
* @example
3636
* var Float64Array = require( '@stdlib/array/float64' );
37-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3837
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3938
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
4039
*
@@ -46,10 +45,7 @@ import { typedndarray, float64ndarray } from '@stdlib/types/ndarray';
4645
* });
4746
*
4847
* var out = dsortins( [ x, ord ] );
49-
* // returns <ndarray>
50-
*
51-
* var arr = ndarray2array( out );
52-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
48+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
5349
*/
5450
declare function dsortins( arrays: [ float64ndarray, typedndarray<number> ] ): float64ndarray;
5551

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dsortins/lib/index.js‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
* @example
2727
* var Float64Array = require( '@stdlib/array/float64' );
2828
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
29-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3029
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3130
* var dsortins = require( '@stdlib/blas/ext/base/ndarray/dsortins' );
3231
*
@@ -38,10 +37,7 @@
3837
* });
3938
*
4039
* var out = dsortins( [ x, ord ] );
41-
* // returns <ndarray>
42-
*
43-
* var arr = ndarray2array( out );
44-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
40+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
4541
*/
4642

4743
// MODULES //

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/dsortins/lib/main.js‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ var strided = require( '@stdlib/blas/ext/base/dsortins' ).ndarray;
4242
*
4343
* @example
4444
* var Float64Array = require( '@stdlib/array/float64' );
45-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4645
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
4746
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
4847
*
@@ -54,10 +53,7 @@ var strided = require( '@stdlib/blas/ext/base/dsortins' ).ndarray;
5453
* });
5554
*
5655
* var out = dsortins( [ x, ord ] );
57-
* // returns <ndarray>
58-
*
59-
* var arr = ndarray2array( out );
60-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
56+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
6157
*/
6258
function dsortins( arrays ) {
6359
var ord;

0 commit comments

Comments
 (0)