Skip to content

Commit dd046ff

Browse files
authored
docs: improve doctests for ndarray instances in blas/ext/ndarray/gsorthp
PR-URL: #11546 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: #9329
1 parent e0c37cb commit dd046ff

5 files changed

Lines changed: 5 additions & 23 deletions

File tree

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Sorts a one-dimensional ndarray using heapsort.
4242

4343
```javascript
4444
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
45-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4645
var ndarray = require( '@stdlib/ndarray/base/ctor' );
4746

4847
var xbuf = [ 1.0, -2.0, 3.0, -4.0 ];
@@ -53,10 +52,7 @@ var order = scalar2ndarray( 1.0, {
5352
});
5453

5554
var out = gsorthp( [ x, order ] );
56-
// returns <ndarray>
57-
58-
var arr = ndarray2array( out );
59-
// returns [ -4.0, -2.0, 1.0, 3.0 ]
55+
// returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
6056
```
6157

6258
The function has the following parameters:

lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/docs/repl.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@
3232
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
3333
> var o = {{alias:@stdlib/ndarray/from-scalar}}( 1.0 );
3434
> {{alias}}( [ x, o ] )
35-
<ndarray>
36-
> var data = x.data
37-
[ -4.0, -2.0, 1.0, 3.0 ]
35+
<ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
3836

3937
See Also
4038
--------

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ import { typedndarray, genericndarray } from '@stdlib/types/ndarray';
3333
* @returns input ndarray
3434
*
3535
* @example
36-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3736
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3837
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
3938
*
@@ -45,10 +44,7 @@ import { typedndarray, genericndarray } from '@stdlib/types/ndarray';
4544
* });
4645
*
4746
* var out = gsorthp( [ x, ord ] );
48-
* // returns <ndarray>
49-
*
50-
* var arr = ndarray2array( out );
51-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
47+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
5248
*/
5349
declare function gsorthp<T extends typedndarray<unknown> | genericndarray<unknown> = typedndarray<unknown>>( arrays: [ T, typedndarray<number> ] ): T;
5450

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
*
2626
* @example
2727
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
28-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2928
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3029
* var gsorthp = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
3130
*
@@ -37,10 +36,7 @@
3736
* });
3837
*
3938
* var out = gsorthp( [ x, ord ] );
40-
* // returns <ndarray>
41-
*
42-
* var arr = ndarray2array( out );
43-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
39+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
4440
*/
4541

4642
// MODULES //

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ var strided = require( '@stdlib/blas/ext/base/gsorthp' ).ndarray;
3737
* @returns {Object} input ndarray
3838
*
3939
* @example
40-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4140
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
4241
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
4342
*
@@ -49,10 +48,7 @@ var strided = require( '@stdlib/blas/ext/base/gsorthp' ).ndarray;
4948
* });
5049
*
5150
* var out = gsorthp( [ x, ord ] );
52-
* // returns <ndarray>
53-
*
54-
* var arr = ndarray2array( out );
55-
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
51+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
5652
*/
5753
function gsorthp( arrays ) {
5854
var ord;

0 commit comments

Comments
 (0)