Skip to content

Commit 12d495c

Browse files
udaykakade25udaykakade25
authored
docs: improve doctests for ndarray instances in blas/ext/to-sortedhp
PR-URL: #11479 Ref: #9329 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent fa69a58 commit 12d495c

File tree

6 files changed

+23
-103
lines changed

6 files changed

+23
-103
lines changed

‎lib/node_modules/@stdlib/blas/ext/to-sortedhp/README.md‎

Lines changed: 7 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,12 @@ var toSortedhp = require( '@stdlib/blas/ext/to-sortedhp' );
3535
Returns a new [ndarray][@stdlib/ndarray/ctor] containing the elements of an input [ndarray][@stdlib/ndarray/ctor] sorted 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 = toSortedhp( 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

5046
The function has the following parameters:
@@ -61,98 +57,72 @@ The function accepts the following options:
6157
By default, the function sorts elements in increasing order. To sort in a different order, provide a `sortOrder` argument.
6258

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

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

6964
var y = toSortedhp( x, -1.0 );
70-
// returns <ndarray>
71-
72-
var arr = ndarray2array( y );
73-
// returns [ 2.0, -1.0, -3.0 ]
65+
// returns <ndarray>[ 2.0, -1.0, -3.0 ]
7466
```
7567

7668
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.
7769

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

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

8475
// Sort in ascending order:
8576
var y = toSortedhp( x, 'asc' );
86-
// returns <ndarray>
87-
88-
var arr = ndarray2array( y );
89-
// returns [ -3.0, -1.0, 2.0 ]
77+
// returns <ndarray>[ -3.0, -1.0, 2.0 ]
9078

9179
// Sort in descending order:
9280
y = toSortedhp( x, 'descending' );
93-
// returns <ndarray>
94-
95-
arr = ndarray2array( y );
96-
// returns [ 2.0, -1.0, -3.0 ]
81+
// returns <ndarray>[ 2.0, -1.0, -3.0 ]
9782
```
9883

9984
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.
10085

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

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

110-
var v = ndarray2array( x );
111-
// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
112-
11394
var y = toSortedhp( x, {
11495
'dims': [ 0 ]
11596
});
116-
// returns <ndarray>
117-
118-
v = ndarray2array( y );
119-
// returns [ [ -3.0, 2.0 ], [ -1.0, 4.0 ] ]
97+
// returns <ndarray>[ [ -3.0, 2.0 ], [ -1.0, 4.0 ] ]
12098
```
12199

122100
To specify the output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes], provide a `dtype` option.
123101

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

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

130107
var y = toSortedhp( x, {
131108
'dtype': 'float32'
132109
});
133-
// returns <ndarray>
134-
135-
var arr = ndarray2array( y );
136-
// returns [ -3.0, -1.0, 2.0 ]
110+
// returns <ndarray>[ -3.0, -1.0, 2.0 ]
137111
```
138112

139113
#### toSortedhp.assign( x, out\[, sortOrder]\[, options] )
140114

141115
Sorts the elements of an input [ndarray][@stdlib/ndarray/ctor] along one or more [ndarray][@stdlib/ndarray/ctor] dimensions using heapsort and assigns the results to an output [ndarray][@stdlib/ndarray/ctor].
142116

143117
```javascript
144-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
145118
var zeros = require( '@stdlib/ndarray/zeros' );
146119
var array = require( '@stdlib/ndarray/array' );
147120

148121
var x = array( [ -1.0, 2.0, -3.0 ] );
149122
var y = zeros( [ 3 ] );
150123

151124
var out = toSortedhp.assign( x, y );
152-
// returns <ndarray>
153-
154-
var arr = ndarray2array( out );
155-
// returns [ -3.0, -1.0, 2.0 ]
125+
// returns <ndarray>[ -3.0, -1.0, 2.0 ]
156126

157127
var bool = ( y === out );
158128
// returns true

‎lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/repl.txt‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,8 @@
5959
Examples
6060
--------
6161
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
62-
> var out = {{alias}}( x );
63-
> {{alias:@stdlib/ndarray/to-array}}( out )
64-
[ -4.0, -3.0, -1.0, 2.0 ]
62+
> var out = {{alias}}( x )
63+
<ndarray>[ -4.0, -3.0, -1.0, 2.0 ]
6564

6665

6766
{{alias}}.assign( x, out[, sortOrder][, options] )
@@ -112,9 +111,8 @@
112111
--------
113112
> var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
114113
> var y = {{alias:@stdlib/ndarray/zeros}}( [ 4 ] );
115-
> var out = {{alias}}.assign( x, y );
116-
> {{alias:@stdlib/ndarray/to-array}}( out )
117-
[ -4.0, -3.0, -1.0, 2.0 ]
114+
> var out = {{alias}}.assign( x, y )
115+
<ndarray>[ -4.0, -3.0, -1.0, 2.0 ]
118116
> var bool = ( out === y )
119117
true
120118

‎lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/types/index.d.ts‎

Lines changed: 8 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,12 @@ interface ToSortedhp {
7878
* @returns output ndarray
7979
*
8080
* @example
81-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
8281
* var array = require( '@stdlib/ndarray/array' );
8382
*
8483
* var x = array( [ -1.0, 2.0, -3.0 ] );
8584
*
8685
* var y = toSortedhp( x );
87-
* // returns <ndarray>
88-
*
89-
* var arr = ndarray2array( y );
90-
* // returns [ -3.0, -1.0, 2.0 ]
86+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
9187
*/
9288
<T extends InputArray = InputArray>( x: T, options?: BaseOptions ): T;
9389

@@ -107,16 +103,12 @@ interface ToSortedhp {
107103
* @returns output ndarray
108104
*
109105
* @example
110-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
111106
* var array = require( '@stdlib/ndarray/array' );
112107
*
113108
* var x = array( [ -1.0, 2.0, -3.0 ] );
114109
*
115110
* var y = toSortedhp( x );
116-
* // returns <ndarray>
117-
*
118-
* var arr = ndarray2array( y );
119-
* // returns [ -3.0, -1.0, 2.0 ]
111+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
120112
*/
121113
<T extends InputArray = InputArray, U extends OutputArray = OutputArray>( x: T, options?: Options ): U; // NOTE: we lose type specificity here. We can likely address this with type maps
122114

@@ -137,16 +129,12 @@ interface ToSortedhp {
137129
* @returns output ndarray
138130
*
139131
* @example
140-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
141132
* var array = require( '@stdlib/ndarray/array' );
142133
*
143134
* var x = array( [ -1.0, 2.0, -3.0 ] );
144135
*
145136
* var y = toSortedhp( x, 1.0 );
146-
* // returns <ndarray>
147-
*
148-
* var arr = ndarray2array( y );
149-
* // returns [ -3.0, -1.0, 2.0 ]
137+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
150138
*/
151139
<T extends InputArray = InputArray>( x: T, sortOrder: SortOrder, options?: BaseOptions ): T;
152140

@@ -167,16 +155,12 @@ interface ToSortedhp {
167155
* @returns output ndarray
168156
*
169157
* @example
170-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
171158
* var array = require( '@stdlib/ndarray/array' );
172159
*
173160
* var x = array( [ -1.0, 2.0, -3.0 ] );
174161
*
175162
* var y = toSortedhp( x, 1.0 );
176-
* // returns <ndarray>
177-
*
178-
* var arr = ndarray2array( y );
179-
* // returns [ -3.0, -1.0, 2.0 ]
163+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
180164
*/
181165
<T extends InputArray = InputArray, U extends OutputArray = OutputArray>( x: T, sortOrder: SortOrder, options?: Options ): U; // NOTE: we lose type specificity here. We can likely address this with type maps
182166

@@ -197,7 +181,6 @@ interface ToSortedhp {
197181
* @returns output ndarray
198182
*
199183
* @example
200-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
201184
* var zeros = require( '@stdlib/ndarray/zeros' );
202185
* var array = require( '@stdlib/ndarray/array' );
203186
*
@@ -206,10 +189,7 @@ interface ToSortedhp {
206189
* var y = zeros( [ 3 ] );
207190
*
208191
* var out = toSortedhp.assign( x, y );
209-
* // returns <ndarray>
210-
*
211-
* var arr = ndarray2array( out );
212-
* // returns [ -3.0, -1.0, 2.0 ]
192+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
213193
*
214194
* var bool = ( out === y );
215195
* // returns true
@@ -234,7 +214,6 @@ interface ToSortedhp {
234214
* @returns output ndarray
235215
*
236216
* @example
237-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
238217
* var zeros = require( '@stdlib/ndarray/zeros' );
239218
* var array = require( '@stdlib/ndarray/array' );
240219
*
@@ -243,10 +222,7 @@ interface ToSortedhp {
243222
* var y = zeros( [ 3 ] );
244223
*
245224
* var out = toSortedhp.assign( x, y, 1);
246-
* // returns <ndarray>
247-
*
248-
* var arr = ndarray2array( out );
249-
* // returns [ -3.0, -1.0, 2.0 ]
225+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
250226
*
251227
* var bool = ( out === y );
252228
* // returns true
@@ -271,19 +247,14 @@ interface ToSortedhp {
271247
* @returns output ndarray
272248
*
273249
* @example
274-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
275250
* var array = require( '@stdlib/ndarray/array' );
276251
*
277252
* var x = array( [ -1.0, 2.0, -3.0 ] );
278253
*
279254
* var y = toSortedhp( x, 1.0 );
280-
* // returns <ndarray>
281-
*
282-
* var arr = ndarray2array( y );
283-
* // returns [ -3.0, -1.0, 2.0 ]
255+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
284256
*
285257
* @example
286-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
287258
* var zeros = require( '@stdlib/ndarray/zeros' );
288259
* var array = require( '@stdlib/ndarray/array' );
289260
*
@@ -292,10 +263,7 @@ interface ToSortedhp {
292263
* var y = zeros( [ 3 ] );
293264
*
294265
* var out = toSortedhp.assign( x, y );
295-
* // returns <ndarray>
296-
*
297-
* var arr = ndarray2array( out );
298-
* // returns [ -3.0, -1.0, 2.0 ]
266+
* // returns <ndarray>[ -3.0, -1.0, 2.0 ]
299267
*
300268
* var bool = ( out === y );
301269
* // returns true

‎lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/assign.js‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ var format = require( '@stdlib/string/format' );
5151
*
5252
* @example
5353
* var Float64Array = require( '@stdlib/array/float64' );
54-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
5554
* var zeros = require( '@stdlib/ndarray/zeros' );
5655
* var ndarray = require( '@stdlib/ndarray/ctor' );
5756
*
@@ -75,10 +74,7 @@ var format = require( '@stdlib/string/format' );
7574
*
7675
* // Perform operation:
7776
* var out = assign( x, y );
78-
* // returns <ndarray>
79-
*
80-
* var arr = ndarray2array( out );
81-
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
77+
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
8278
*
8379
* var bool = ( y === out );
8480
* // returns true

‎lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/index.js‎

Lines changed: 2 additions & 10 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 toSortedhp = require( '@stdlib/blas/ext/to-sortedhp' );
3130
*
3231
* // Create a data buffer:
@@ -46,14 +45,10 @@
4645
*
4746
* // Perform operation:
4847
* var out = toSortedhp( 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
* @example
5551
* var Float64Array = require( '@stdlib/array/float64' );
56-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
5752
* var zeros = require( '@stdlib/ndarray/zeros' );
5853
* var ndarray = require( '@stdlib/ndarray/ctor' );
5954
* var toSortedhp = require( '@stdlib/blas/ext/to-sortedhp' );
@@ -78,10 +73,7 @@
7873
*
7974
* // Perform operation:
8075
* var out = toSortedhp.assign( x, y );
81-
* // returns <ndarray>
82-
*
83-
* var arr = ndarray2array( out );
84-
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
76+
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
8577
*
8678
* var bool = ( y === out );
8779
* // returns true

‎lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/main.js‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@ var format = require( '@stdlib/string/format' );
5656
*
5757
* @example
5858
* var Float64Array = require( '@stdlib/array/float64' );
59-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
6059
* var ndarray = require( '@stdlib/ndarray/ctor' );
6160
*
6261
* // Create a data buffer:
@@ -76,10 +75,7 @@ var format = require( '@stdlib/string/format' );
7675
*
7776
* // Perform operation:
7877
* var out = toSortedhp( x );
79-
* // returns <ndarray>
80-
*
81-
* var arr = ndarray2array( out );
82-
* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
78+
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
8379
*/
8480
function toSortedhp( x ) {
8581
var sortOrder;

0 commit comments

Comments
 (0)