Skip to content

Commit 2c6719d

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 0aa3962 commit 2c6719d

File tree

7 files changed

+16
-65
lines changed

7 files changed

+16
-65
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -860,6 +860,7 @@ A total of 57 issues were closed in this release:
860860

861861
<details>
862862

863+
- [`b434fcc`](https://github.com/stdlib-js/stdlib/commit/b434fcc0eee2e5a6930b5c99a0fe8515dcff2fae) - **docs:** improve doctests for ndarray instances in `blas/ext/sorthp` [(#11483)](https://github.com/stdlib-js/stdlib/pull/11483) _(by Uday Kakade)_
863864
- [`4743252`](https://github.com/stdlib-js/stdlib/commit/4743252abb3eb47297a10260e2ed159389036143) - **docs:** improve doctests for ndarray instances in `blas/ext/find-index` [(#11486)](https://github.com/stdlib-js/stdlib/pull/11486) _(by Uday Kakade)_
864865
- [`ace9b98`](https://github.com/stdlib-js/stdlib/commit/ace9b98cd31056ec3efbbd14b3c12defe96b07fc) - **docs:** improve doctests for ndarray instances in `blas/ext/find-last-index` [(#11487)](https://github.com/stdlib-js/stdlib/pull/11487) _(by Uday Kakade)_
865866
- [`b2160c6`](https://github.com/stdlib-js/stdlib/commit/b2160c655c2ce47912079386eab7ecf61c6bbceb) - **docs:** improve doctests for ndarray instances in `blas/ext/index-of` [(#11488)](https://github.com/stdlib-js/stdlib/pull/11488) _(by Uday Kakade)_

‎ext/sorthp/README.md‎

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,12 @@ var sorthp = require( '@stdlib/blas/ext/sorthp' );
3535
Sorts an input [ndarray][@stdlib/ndarray/ctor] along one or more [ndarray][@stdlib/ndarray/ctor] dimensions using heapsort.
3636

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

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

4342
var y = sorthp( x );
44-
// returns <ndarray>
45-
46-
var arr = ndarray2array( y );
47-
// returns [ -3.0, -1.0, 2.0 ]
43+
// returns <ndarray>[ -3.0, -1.0, 2.0 ]
4844

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

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

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

7166
var y = sorthp( x, -1.0 );
72-
// returns <ndarray>
73-
74-
var arr = ndarray2array( y );
75-
// returns [ 2.0, -1.0, -3.0 ]
67+
// returns <ndarray>[ 2.0, -1.0, -3.0 ]
7668
```
7769

7870
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.
7971

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

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

8677
// Sort in ascending order:
8778
var y = sorthp( x, 'asc' );
88-
// returns <ndarray>
89-
90-
var arr = ndarray2array( y );
91-
// returns [ -3.0, -1.0, 2.0 ]
79+
// returns <ndarray>[ -3.0, -1.0, 2.0 ]
9280

9381
// Sort in descending order:
9482
y = sorthp( x, 'descending' );
95-
// returns <ndarray>
96-
97-
arr = ndarray2array( y );
98-
// returns [ 2.0, -1.0, -3.0 ]
83+
// returns <ndarray>[ 2.0, -1.0, -3.0 ]
9984
```
10085

10186
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.
10287

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

10791
var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
10892
'shape': [ 2, 2 ],
10993
'order': 'row-major'
11094
});
111-
112-
var v = ndarray2array( x );
113-
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
95+
// returns <ndarray>[ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
11496

11597
var y = sorthp( x, {
11698
'dims': [ 0 ]
11799
});
118-
// returns <ndarray>
119-
120-
v = ndarray2array( y );
121-
// returns [ [ -3.0, 2.0 ], [ -1.0, 4.0 ] ]
100+
// returns <ndarray>[ [ -3.0, 2.0 ], [ -1.0, 4.0 ] ]
122101
```
123102

124103
</section>

‎ext/sorthp/docs/repl.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,8 @@
5858
Examples
5959
--------
6060
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
61-
> var y = {{alias}}( x );
62-
> {{alias:@stdlib/ndarray/to-array}}( y )
63-
[ -4.0, -3.0, -1.0, 2.0 ]
61+
> var y = {{alias}}( x )
62+
<ndarray>[ -4.0, -3.0, -1.0, 2.0 ]
6463

6564
See Also
6665
--------

‎ext/sorthp/docs/types/index.d.ts‎

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -65,16 +65,12 @@ interface Sorthp {
6565
* @returns output ndarray
6666
*
6767
* @example
68-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
6968
* var array = require( '@stdlib/ndarray/array' );
7069
*
7170
* var x = array( [ -1.0, 2.0, -3.0 ] );
7271
*
7372
* var y = sorthp( x );
74-
* // returns <ndarray>
75-
*
76-
* var arr = ndarray2array( y );
77-
* // returns [ -3.0, -1.0, 2.0 ]
73+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
7874
*/
7975
<T extends InputArray = InputArray>( x: T, options?: Options ): T;
8076

@@ -96,16 +92,12 @@ interface Sorthp {
9692
* @returns output ndarray
9793
*
9894
* @example
99-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
10095
* var array = require( '@stdlib/ndarray/array' );
10196
*
10297
* var x = array( [ -1.0, 2.0, -3.0 ] );
10398
*
10499
* var y = sorthp( x, 1.0 );
105-
* // returns <ndarray>
106-
*
107-
* var arr = ndarray2array( y );
108-
* // returns [ -3.0, -1.0, 2.0 ]
100+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
109101
*/
110102
<T extends InputArray = InputArray>( x: T, sortOrder: SortOrder, options?: Options ): T;
111103
}
@@ -128,28 +120,20 @@ interface Sorthp {
128120
* @returns output ndarray
129121
*
130122
* @example
131-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
132123
* var array = require( '@stdlib/ndarray/array' );
133124
*
134125
* var x = array( [ -1.0, 2.0, -3.0 ] );
135126
*
136127
* var y = sorthp( x, 1.0 );
137-
* // returns <ndarray>
138-
*
139-
* var arr = ndarray2array( y );
140-
* // returns [ -3.0, -1.0, 2.0 ]
128+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
141129
*
142130
* @example
143-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
144131
* var array = require( '@stdlib/ndarray/array' );
145132
*
146133
* var x = array( [ -1.0, 2.0, -3.0 ] );
147134
*
148135
* var y = sorthp( x, 1.0 );
149-
* // returns <ndarray>
150-
*
151-
* var arr = ndarray2array( y );
152-
* // returns [ -3.0, -1.0, 2.0 ]
136+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
153137
*/
154138
declare const sorthp: Sorthp;
155139

‎ext/sorthp/lib/base.js‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ var options = {
6969
*
7070
* @example
7171
* var Float64Array = require( '@stdlib/array/float64' );
72-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
7372
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
7473
* var ndarray = require( '@stdlib/ndarray/ctor' );
7574
*
@@ -95,10 +94,7 @@ var options = {
9594
*
9695
* // Perform operation:
9796
* var out = sorthp( x, sortOrder );
98-
* // returns <ndarray>
99-
*
100-
* var arr = ndarray2array( out );
101-
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
97+
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
10298
*/
10399
var sorthp = factory( table, [ idtypes0 ], odtypes, options );
104100

‎ext/sorthp/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/ctor' );
29-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3029
* var sorthp = require( '@stdlib/blas/ext/sorthp' );
3130
*
3231
* // Create a data buffer:
@@ -46,10 +45,7 @@
4645
*
4746
* // Perform operation:
4847
* var out = sorthp( x );
49-
* // returns <ndarray>
50-
*
51-
* var arr = ndarray2array( out );
52-
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
48+
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
5349
*/
5450

5551
// MODULES //

‎ext/sorthp/lib/main.js‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,6 @@ function normalizeOrder( value ) {
121121
*
122122
* @example
123123
* var Float64Array = require( '@stdlib/array/float64' );
124-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
125124
* var ndarray = require( '@stdlib/ndarray/ctor' );
126125
*
127126
* // Create a data buffer:
@@ -141,10 +140,7 @@ function normalizeOrder( value ) {
141140
*
142141
* // Perform operation:
143142
* var out = sorthp( x );
144-
* // returns <ndarray>
145-
*
146-
* var arr = ndarray2array( out );
147-
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
143+
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
148144
*/
149145
function sorthp( x ) {
150146
var nargs;

0 commit comments

Comments
 (0)
⚡