Skip to content

docs: improve doctests for ndarray instances in blas/ext/sorthp #11483

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 2 commits into from
Apr 17, 2026
Merged

docs: improve doctests for ndarray instances in blas/ext/sorthp #11483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2160e4
docs: improve doctest for ndarray instance in blas/ext/sorthp
udaykakade25 Apr 16, 2026
418b684
fix Lint error
udaykakade25 Apr 16, 2026
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
33 changes: 6 additions & 27 deletions lib/node_modules/@stdlib/blas/ext/sorthp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,12 @@ var sorthp = require( '@stdlib/blas/ext/sorthp' );
Sorts an input [ndarray][@stdlib/ndarray/ctor] along one or more [ndarray][@stdlib/ndarray/ctor] dimensions using heapsort.

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );

var x = array( [ -1.0, 2.0, -3.0 ] );

var y = sorthp( x );
// returns <ndarray>

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

var bool = ( x === y );
// returns true
Expand All @@ -63,62 +59,45 @@ The function accepts the following options:
By default, the function sorts elements in increasing order. To sort in a different order, provide a `sortOrder` argument.

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );

var x = array( [ -1.0, 2.0, -3.0 ] );

var y = sorthp( x, -1.0 );
// returns <ndarray>

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

In addition to numeric values, one can specify the sort order via one of the following string literals: `'ascending'`, `'asc'`, `'descending'`, or `'desc'`. The first two literals indicate to sort in ascending (i.e., increasing) order. The last two literals indicate to sort in descending (i.e., decreasing) order.

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );

var x = array( [ -1.0, 2.0, -3.0 ] );

// Sort in ascending order:
var y = sorthp( x, 'asc' );
// returns <ndarray>

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

// Sort in descending order:
y = sorthp( x, 'descending' );
// returns <ndarray>

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

By default, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform the operation over specific dimensions, provide a `dims` option.

```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var array = require( '@stdlib/ndarray/array' );

var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
'shape': [ 2, 2 ],
'order': 'row-major'
});

var v = ndarray2array( x );
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
// returns <ndarray>[ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]

var y = sorthp( x, {
'dims': [ 0 ]
});
// returns <ndarray>

v = ndarray2array( y );
// returns [ [ -3.0, 2.0 ], [ -1.0, 4.0 ] ]
// returns <ndarray>[ [ -3.0, 2.0 ], [ -1.0, 4.0 ] ]
```

</section>
Expand Down
5 changes: 2 additions & 3 deletions lib/node_modules/@stdlib/blas/ext/sorthp/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,8 @@
Examples
--------
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
> var y = {{alias}}( x );
> {{alias:@stdlib/ndarray/to-array}}( y )
[ -4.0, -3.0, -1.0, 2.0 ]
> var y = {{alias}}( x )
<ndarray>[ -4.0, -3.0, -1.0, 2.0 ]

See Also
--------
24 changes: 4 additions & 20 deletions lib/node_modules/@stdlib/blas/ext/sorthp/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,12 @@ interface Sorthp {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = sorthp( x );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ -3.0, -1.0, 2.0 ]
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
*/
<T extends InputArray = InputArray>( x: T, options?: Options ): T;

Expand All @@ -96,16 +92,12 @@ interface Sorthp {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = sorthp( x, 1.0 );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ -3.0, -1.0, 2.0 ]
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
*/
<T extends InputArray = InputArray>( x: T, sortOrder: SortOrder, options?: Options ): T;
}
Expand All @@ -128,28 +120,20 @@ interface Sorthp {
* @returns output ndarray
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = sorthp( x, 1.0 );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ -3.0, -1.0, 2.0 ]
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
*
* @example
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ -1.0, 2.0, -3.0 ] );
*
* var y = sorthp( x, 1.0 );
* // returns <ndarray>
*
* var arr = ndarray2array( y );
* // returns [ -3.0, -1.0, 2.0 ]
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
*/
declare const sorthp: Sorthp;

Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/sorthp/lib/base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ var options = {
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
Expand All @@ -95,10 +94,7 @@ var options = {
*
* // Perform operation:
* var out = sorthp( x, sortOrder );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
*/
var sorthp = factory( table, [ idtypes0 ], odtypes, options );

Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/sorthp/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var sorthp = require( '@stdlib/blas/ext/sorthp' );
*
* // Create a data buffer:
Expand All @@ -46,10 +45,7 @@
*
* // Perform operation:
* var out = sorthp( x );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
*/

// MODULES //
Expand Down
6 changes: 1 addition & 5 deletions lib/node_modules/@stdlib/blas/ext/sorthp/lib/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ function normalizeOrder( value ) {
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a data buffer:
Expand All @@ -141,10 +140,7 @@ function normalizeOrder( value ) {
*
* // Perform operation:
* var out = sorthp( x );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
*/
function sorthp( x ) {
var nargs;
Expand Down