Skip to content

Commit 2ab6254

Browse files
authored
feat: update blas/ext/base/ndarray TypeScript declarations
PR-URL: #11496 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent afe2348 commit 2ab6254

File tree

1 file changed

+62
-0
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types

1 file changed

+62
-0
lines changed

lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import dnansumkbn2 = require( '@stdlib/blas/ext/base/ndarray/dnansumkbn2' );
3939
import dnansumors = require( '@stdlib/blas/ext/base/ndarray/dnansumors' );
4040
import dnansumpw = require( '@stdlib/blas/ext/base/ndarray/dnansumpw' );
4141
import doneTo = require( '@stdlib/blas/ext/base/ndarray/done-to' );
42+
import dsort = require( '@stdlib/blas/ext/base/ndarray/dsort' );
4243
import dsorthp = require( '@stdlib/blas/ext/base/ndarray/dsorthp' );
4344
import dsortins = require( '@stdlib/blas/ext/base/ndarray/dsortins' );
4445
import dsortsh = require( '@stdlib/blas/ext/base/ndarray/dsortsh' );
@@ -89,6 +90,7 @@ import snansumkbn2 = require( '@stdlib/blas/ext/base/ndarray/snansumkbn2' );
8990
import snansumors = require( '@stdlib/blas/ext/base/ndarray/snansumors' );
9091
import snansumpw = require( '@stdlib/blas/ext/base/ndarray/snansumpw' );
9192
import soneTo = require( '@stdlib/blas/ext/base/ndarray/sone-to' );
93+
import ssort = require( '@stdlib/blas/ext/base/ndarray/ssort' );
9294
import ssorthp = require( '@stdlib/blas/ext/base/ndarray/ssorthp' );
9395
import ssum = require( '@stdlib/blas/ext/base/ndarray/ssum' );
9496
import ssumkbn = require( '@stdlib/blas/ext/base/ndarray/ssumkbn' );
@@ -538,6 +540,36 @@ interface Namespace {
538540
*/
539541
doneTo: typeof doneTo;
540542

543+
/**
544+
* Sorts a one-dimensional double-precision floating-point ndarray.
545+
*
546+
* ## Notes
547+
*
548+
* - 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.
549+
*
550+
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order
551+
* @returns input ndarray
552+
*
553+
* @example
554+
* var Float64Array = require( '@stdlib/array/float64' );
555+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
556+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
557+
*
558+
* var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );
559+
* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
560+
*
561+
* var ord = scalar2ndarray( 1.0, {
562+
* 'dtype': 'generic'
563+
* });
564+
*
565+
* var out = ns.dsort( [ x, ord ] );
566+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
567+
*
568+
* var bool = ( out === x );
569+
* // returns true
570+
*/
571+
dsort: typeof dsort;
572+
541573
/**
542574
* Sorts a one-dimensional double-precision floating-point ndarray using heapsort.
543575
*
@@ -1723,6 +1755,36 @@ interface Namespace {
17231755
*/
17241756
soneTo: typeof soneTo;
17251757

1758+
/**
1759+
* Sorts a one-dimensional single-precision floating-point ndarray.
1760+
*
1761+
* ## Notes
1762+
*
1763+
* - 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.
1764+
*
1765+
* @param arrays - array-like object containing a one-dimensional input ndarray and a zero-dimensional ndarray specifying the sort order
1766+
* @returns input ndarray
1767+
*
1768+
* @example
1769+
* var Float32Array = require( '@stdlib/array/float32' );
1770+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
1771+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
1772+
*
1773+
* var xbuf = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] );
1774+
* var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
1775+
*
1776+
* var ord = scalar2ndarray( 1.0, {
1777+
* 'dtype': 'generic'
1778+
* });
1779+
*
1780+
* var out = ns.ssort( [ x, ord ] );
1781+
* // returns <ndarray>[ -4.0, -2.0, 1.0, 3.0 ]
1782+
*
1783+
* var bool = ( out === x );
1784+
* // returns true
1785+
*/
1786+
ssort: typeof ssort;
1787+
17261788
/**
17271789
* Sorts a one-dimensional single-precision floating-point ndarray using heapsort.
17281790
*

0 commit comments

Comments
 (0)