Skip to content

Commit e0c37cb

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

5 files changed

Lines changed: 5 additions & 23 deletions

File tree

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ Sorts a one-dimensional single-precision floating-point ndarray using heapsort.
4343
```javascript
4444
var Float32Array = require( '@stdlib/array/float32' );
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 Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] );
@@ -54,10 +53,7 @@ var order = scalar2ndarray( 1.0, {
5453
});
5554

5655
var out = ssorthp( [ 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/ssorthp/docs/repl.txt

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

4038
See Also
4139
--------

lib/node_modules/@stdlib/blas/ext/base/ndarray/ssorthp/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, float32ndarray } from '@stdlib/types/ndarray';
3434
*
3535
* @example
3636
* var Float32Array = require( '@stdlib/array/float32' );
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, float32ndarray } from '@stdlib/types/ndarray';
4645
* });
4746
*
4847
* var out = ssorthp( [ 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 ssorthp( arrays: [ float32ndarray, typedndarray<number> ] ): float32ndarray;
5551

lib/node_modules/@stdlib/blas/ext/base/ndarray/ssorthp/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 Float32Array = require( '@stdlib/array/float32' );
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 ssorthp = require( '@stdlib/blas/ext/base/ndarray/ssorthp' );
3231
*
@@ -38,10 +37,7 @@
3837
* });
3938
*
4039
* var out = ssorthp( [ 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/ssorthp/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/ssorthp' ).ndarray;
4242
*
4343
* @example
4444
* var Float32Array = require( '@stdlib/array/float32' );
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/ssorthp' ).ndarray;
5453
* });
5554
*
5655
* var out = ssorthp( [ 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 ssorthp( arrays ) {
6359
var ord;

0 commit comments

Comments
 (0)