Skip to content

docs: improve doctests for ndarray instances in blas/ext/ndarray/gsorthp #11546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Apr 19, 2026
Merged

docs: improve doctests for ndarray instances in blas/ext/ndarray/gsorthp #11546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Sorts a one-dimensional ndarray using heapsort.

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

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

var out = gsorthp( [ x, order ] );
// returns <ndarray>

var arr = ndarray2array( out );
// returns [ -4.0, -2.0, 1.0, 3.0 ]
// returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
```

The function has the following parameters:
Expand Down
4 changes: 1 addition & 3 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
> var o = {{alias:@stdlib/ndarray/from-scalar}}( 1.0 );
> {{alias}}( [ x, o ] )
<ndarray>
> var data = x.data
[ -4.0, -2.0, 1.0, 3.0 ]
<ndarray>[ -4.0, -2.0, 1.0, 3.0 ]

See Also
--------
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ import { typedndarray, genericndarray } from '@stdlib/types/ndarray';
* @returns input ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
Expand All @@ -45,10 +44,7 @@ import { typedndarray, genericndarray } from '@stdlib/types/ndarray';
* });
*
* var out = gsorthp( [ x, ord ] );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
*/
declare function gsorthp<T extends typedndarray<unknown> | genericndarray<unknown> = typedndarray<unknown>>( arrays: [ T, typedndarray<number> ] ): T;

Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
*
* @example
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var gsorthp = require( '@stdlib/blas/ext/base/ndarray/gsorthp' );
*
Expand All @@ -37,10 +36,7 @@
* });
*
* var out = gsorthp( [ x, ord ] );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
*/

// MODULES //
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/gsorthp/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ var strided = require( '@stdlib/blas/ext/base/gsorthp' ).ndarray;
* @returns {Object} input ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
Expand All @@ -49,10 +48,7 @@ var strided = require( '@stdlib/blas/ext/base/gsorthp' ).ndarray;
* });
*
* var out = gsorthp( [ x, ord ] );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ -4.0, -2.0, 1.0, 3.0 ]
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
*/
function gsorthp( arrays ) {
var ord;
Expand Down