diff --git a/lib/node_modules/@stdlib/blas/ext/sorthp/README.md b/lib/node_modules/@stdlib/blas/ext/sorthp/README.md index c56ceeb1a214..87d9ddf0d9b4 100644 --- a/lib/node_modules/@stdlib/blas/ext/sorthp/README.md +++ b/lib/node_modules/@stdlib/blas/ext/sorthp/README.md @@ -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 - -var arr = ndarray2array( y ); -// returns [ -3.0, -1.0, 2.0 ] +// returns [ -3.0, -1.0, 2.0 ] var bool = ( x === y ); // returns true @@ -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 - -var arr = ndarray2array( y ); -// returns [ 2.0, -1.0, -3.0 ] +// returns [ 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 - -var arr = ndarray2array( y ); -// returns [ -3.0, -1.0, 2.0 ] +// returns [ -3.0, -1.0, 2.0 ] // Sort in descending order: y = sorthp( x, 'descending' ); -// returns - -arr = ndarray2array( y ); -// returns [ 2.0, -1.0, -3.0 ] +// returns [ 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 [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] var y = sorthp( x, { 'dims': [ 0 ] }); -// returns - -v = ndarray2array( y ); -// returns [ [ -3.0, 2.0 ], [ -1.0, 4.0 ] ] +// returns [ [ -3.0, 2.0 ], [ -1.0, 4.0 ] ] ``` diff --git a/lib/node_modules/@stdlib/blas/ext/sorthp/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/sorthp/docs/repl.txt index 472c27605a4e..19437560e3e3 100644 --- a/lib/node_modules/@stdlib/blas/ext/sorthp/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/sorthp/docs/repl.txt @@ -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 ) + [ -4.0, -3.0, -1.0, 2.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/sorthp/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/sorthp/docs/types/index.d.ts index 0106cb13ac7f..bd3e2e5fc3d1 100644 --- a/lib/node_modules/@stdlib/blas/ext/sorthp/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/sorthp/docs/types/index.d.ts @@ -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 - * - * var arr = ndarray2array( y ); - * // returns [ -3.0, -1.0, 2.0 ] + * // returns [ -3.0, -1.0, 2.0 ] */ ( x: T, options?: Options ): T; @@ -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 - * - * var arr = ndarray2array( y ); - * // returns [ -3.0, -1.0, 2.0 ] + * // returns [ -3.0, -1.0, 2.0 ] */ ( x: T, sortOrder: SortOrder, options?: Options ): T; } @@ -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 -* -* var arr = ndarray2array( y ); -* // returns [ -3.0, -1.0, 2.0 ] +* // returns [ -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 -* -* var arr = ndarray2array( y ); -* // returns [ -3.0, -1.0, 2.0 ] +* // returns [ -3.0, -1.0, 2.0 ] */ declare const sorthp: Sorthp; diff --git a/lib/node_modules/@stdlib/blas/ext/sorthp/lib/base.js b/lib/node_modules/@stdlib/blas/ext/sorthp/lib/base.js index 620270654deb..8e34cfb525f3 100644 --- a/lib/node_modules/@stdlib/blas/ext/sorthp/lib/base.js +++ b/lib/node_modules/@stdlib/blas/ext/sorthp/lib/base.js @@ -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' ); * @@ -95,10 +94,7 @@ var options = { * * // Perform operation: * var out = sorthp( x, sortOrder ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ] +* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ] */ var sorthp = factory( table, [ idtypes0 ], odtypes, options ); diff --git a/lib/node_modules/@stdlib/blas/ext/sorthp/lib/index.js b/lib/node_modules/@stdlib/blas/ext/sorthp/lib/index.js index 09412ed7dd01..889047ccbd1e 100644 --- a/lib/node_modules/@stdlib/blas/ext/sorthp/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/sorthp/lib/index.js @@ -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: @@ -46,10 +45,7 @@ * * // Perform operation: * var out = sorthp( x ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ] +* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/sorthp/lib/main.js b/lib/node_modules/@stdlib/blas/ext/sorthp/lib/main.js index 008a712f980c..fb9353958dc3 100644 --- a/lib/node_modules/@stdlib/blas/ext/sorthp/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/sorthp/lib/main.js @@ -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: @@ -141,10 +140,7 @@ function normalizeOrder( value ) { * * // Perform operation: * var out = sorthp( x ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ] +* // returns [ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ] */ function sorthp( x ) { var nargs;