diff --git a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/README.md b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/README.md index d34b9f3033af..89ecaff367ff 100644 --- a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/README.md +++ b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/README.md @@ -35,16 +35,12 @@ var toSortedhp = require( '@stdlib/blas/ext/to-sortedhp' ); 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. ```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 = toSortedhp( x ); -// returns - -var arr = ndarray2array( y ); -// returns [ -3.0, -1.0, 2.0 ] +// returns [ -3.0, -1.0, 2.0 ] ``` The function has the following parameters: @@ -61,45 +57,33 @@ 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 = toSortedhp( 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 = toSortedhp( 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 = toSortedhp( 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 ], { @@ -107,22 +91,15 @@ var x = array( [ -1.0, 2.0, -3.0, 4.0 ], { 'order': 'row-major' }); -var v = ndarray2array( x ); -// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] - var y = toSortedhp( 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 ] ] ``` To specify the output [ndarray][@stdlib/ndarray/ctor] [data type][@stdlib/ndarray/dtypes], provide a `dtype` option. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var array = require( '@stdlib/ndarray/array' ); var x = array( [ -1.0, 2.0, -3.0 ] ); @@ -130,10 +107,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] ); var y = toSortedhp( x, { 'dtype': 'float32' }); -// returns - -var arr = ndarray2array( y ); -// returns [ -3.0, -1.0, 2.0 ] +// returns [ -3.0, -1.0, 2.0 ] ``` #### toSortedhp.assign( x, out\[, sortOrder]\[, options] ) @@ -141,7 +115,6 @@ var arr = ndarray2array( y ); 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]. ```javascript -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var zeros = require( '@stdlib/ndarray/zeros' ); var array = require( '@stdlib/ndarray/array' ); @@ -149,10 +122,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] ); var y = zeros( [ 3 ] ); var out = toSortedhp.assign( x, y ); -// returns - -var arr = ndarray2array( out ); -// returns [ -3.0, -1.0, 2.0 ] +// returns [ -3.0, -1.0, 2.0 ] var bool = ( y === out ); // returns true diff --git a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/repl.txt index 005be213a8c4..9a43f125f592 100644 --- a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/repl.txt @@ -59,9 +59,8 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] ); - > var out = {{alias}}( x ); - > {{alias:@stdlib/ndarray/to-array}}( out ) - [ -4.0, -3.0, -1.0, 2.0 ] + > var out = {{alias}}( x ) + [ -4.0, -3.0, -1.0, 2.0 ] {{alias}}.assign( x, out[, sortOrder][, options] ) @@ -112,9 +111,8 @@ -------- > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] ); > var y = {{alias:@stdlib/ndarray/zeros}}( [ 4 ] ); - > var out = {{alias}}.assign( x, y ); - > {{alias:@stdlib/ndarray/to-array}}( out ) - [ -4.0, -3.0, -1.0, 2.0 ] + > var out = {{alias}}.assign( x, y ) + [ -4.0, -3.0, -1.0, 2.0 ] > var bool = ( out === y ) true diff --git a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/types/index.d.ts index fdef48296575..c06b2c52e63e 100644 --- a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/docs/types/index.d.ts @@ -78,16 +78,12 @@ interface ToSortedhp { * @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 = toSortedhp( x ); - * // returns - * - * var arr = ndarray2array( y ); - * // returns [ -3.0, -1.0, 2.0 ] + * // returns [ -3.0, -1.0, 2.0 ] */ ( x: T, options?: BaseOptions ): T; @@ -107,16 +103,12 @@ interface ToSortedhp { * @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 = toSortedhp( x ); - * // returns - * - * var arr = ndarray2array( y ); - * // returns [ -3.0, -1.0, 2.0 ] + * // returns [ -3.0, -1.0, 2.0 ] */ ( x: T, options?: Options ): U; // NOTE: we lose type specificity here. We can likely address this with type maps @@ -137,16 +129,12 @@ interface ToSortedhp { * @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 = toSortedhp( 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?: BaseOptions ): T; @@ -167,16 +155,12 @@ interface ToSortedhp { * @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 = toSortedhp( 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 ): U; // NOTE: we lose type specificity here. We can likely address this with type maps @@ -197,7 +181,6 @@ interface ToSortedhp { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var zeros = require( '@stdlib/ndarray/zeros' ); * var array = require( '@stdlib/ndarray/array' ); * @@ -206,10 +189,7 @@ interface ToSortedhp { * var y = zeros( [ 3 ] ); * * var out = toSortedhp.assign( x, y ); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ -3.0, -1.0, 2.0 ] + * // returns [ -3.0, -1.0, 2.0 ] * * var bool = ( out === y ); * // returns true @@ -234,7 +214,6 @@ interface ToSortedhp { * @returns output ndarray * * @example - * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var zeros = require( '@stdlib/ndarray/zeros' ); * var array = require( '@stdlib/ndarray/array' ); * @@ -243,10 +222,7 @@ interface ToSortedhp { * var y = zeros( [ 3 ] ); * * var out = toSortedhp.assign( x, y, 1); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ -3.0, -1.0, 2.0 ] + * // returns [ -3.0, -1.0, 2.0 ] * * var bool = ( out === y ); * // returns true @@ -271,19 +247,14 @@ interface ToSortedhp { * @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 = toSortedhp( 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 zeros = require( '@stdlib/ndarray/zeros' ); * var array = require( '@stdlib/ndarray/array' ); * @@ -292,10 +263,7 @@ interface ToSortedhp { * var y = zeros( [ 3 ] ); * * var out = toSortedhp.assign( x, y ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -3.0, -1.0, 2.0 ] +* // returns [ -3.0, -1.0, 2.0 ] * * var bool = ( out === y ); * // returns true diff --git a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/assign.js b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/assign.js index 4c95fe280200..263562366c97 100644 --- a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/assign.js +++ b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/assign.js @@ -51,7 +51,6 @@ var format = require( '@stdlib/string/format' ); * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var zeros = require( '@stdlib/ndarray/zeros' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * @@ -75,10 +74,7 @@ var format = require( '@stdlib/string/format' ); * * // Perform operation: * var out = assign( x, y ); -* // 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 bool = ( y === out ); * // returns true diff --git a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/index.js b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/index.js index 2662601a5a6d..cec3ffdd894b 100644 --- a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/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 toSortedhp = require( '@stdlib/blas/ext/to-sortedhp' ); * * // Create a data buffer: @@ -46,14 +45,10 @@ * * // Perform operation: * var out = toSortedhp( 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 ] ] ] * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var zeros = require( '@stdlib/ndarray/zeros' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var toSortedhp = require( '@stdlib/blas/ext/to-sortedhp' ); @@ -78,10 +73,7 @@ * * // Perform operation: * var out = toSortedhp.assign( x, y ); -* // 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 bool = ( y === out ); * // returns true diff --git a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/main.js b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/main.js index 71250be97342..107a85ecc8b6 100644 --- a/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/to-sortedhp/lib/main.js @@ -56,7 +56,6 @@ var format = require( '@stdlib/string/format' ); * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * * // Create a data buffer: @@ -76,10 +75,7 @@ var format = require( '@stdlib/string/format' ); * * // Perform operation: * var out = toSortedhp( 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 toSortedhp( x ) { var sortOrder;