diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts index aa1fa42005b2..158a32e4d5a3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts @@ -39,6 +39,7 @@ import dnansumkbn2 = require( '@stdlib/blas/ext/base/ndarray/dnansumkbn2' ); import dnansumors = require( '@stdlib/blas/ext/base/ndarray/dnansumors' ); import dnansumpw = require( '@stdlib/blas/ext/base/ndarray/dnansumpw' ); import doneTo = require( '@stdlib/blas/ext/base/ndarray/done-to' ); +import dsort = require( '@stdlib/blas/ext/base/ndarray/dsort' ); import dsorthp = require( '@stdlib/blas/ext/base/ndarray/dsorthp' ); import dsortins = require( '@stdlib/blas/ext/base/ndarray/dsortins' ); import dsortsh = require( '@stdlib/blas/ext/base/ndarray/dsortsh' ); @@ -89,6 +90,7 @@ import snansumkbn2 = require( '@stdlib/blas/ext/base/ndarray/snansumkbn2' ); import snansumors = require( '@stdlib/blas/ext/base/ndarray/snansumors' ); import snansumpw = require( '@stdlib/blas/ext/base/ndarray/snansumpw' ); import soneTo = require( '@stdlib/blas/ext/base/ndarray/sone-to' ); +import ssort = require( '@stdlib/blas/ext/base/ndarray/ssort' ); import ssorthp = require( '@stdlib/blas/ext/base/ndarray/ssorthp' ); import ssum = require( '@stdlib/blas/ext/base/ndarray/ssum' ); import ssumkbn = require( '@stdlib/blas/ext/base/ndarray/ssumkbn' ); @@ -538,6 +540,36 @@ interface Namespace { */ doneTo: typeof doneTo; + /** + * Sorts a one-dimensional double-precision floating-point ndarray. + * + * ## Notes + * + * - When the sort order is less than zero, the input ndarray is sorted in **decreasing** order. When the sort order is greater than zero, the input ndarray is sorted in **increasing** order. When the sort order is equal to zero, the input ndarray is left unchanged. + * + * @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order + * @returns input ndarray + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); + * var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + * + * var ord = scalar2ndarray( 1.0, { + * 'dtype': 'generic' + * }); + * + * var out = ns.dsort( [ x, ord ] ); + * // returns [ -4.0, -2.0, 1.0, 3.0 ] + * + * var bool = ( out === x ); + * // returns true + */ + dsort: typeof dsort; + /** * Sorts a one-dimensional double-precision floating-point ndarray using heapsort. * @@ -1723,6 +1755,36 @@ interface Namespace { */ soneTo: typeof soneTo; + /** + * Sorts a one-dimensional single-precision floating-point ndarray. + * + * ## Notes + * + * - When the sort order is less than zero, the input ndarray is sorted in **decreasing** order. When the sort order is greater than zero, the input ndarray is sorted in **increasing** order. When the sort order is equal to zero, the input ndarray is left unchanged. + * + * @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order + * @returns input ndarray + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] ); + * var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + * + * var ord = scalar2ndarray( 1.0, { + * 'dtype': 'generic' + * }); + * + * var out = ns.ssort( [ x, ord ] ); + * // returns [ -4.0, -2.0, 1.0, 3.0 ] + * + * var bool = ( out === x ); + * // returns true + */ + ssort: typeof ssort; + /** * Sorts a one-dimensional single-precision floating-point ndarray using heapsort. *