Skip to content

Commit 10b44d3

Browse files
stdlib-botstdlib-bot
committed
feat: update blas/ext/base TypeScript declarations
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent a13b269 commit 10b44d3

1 file changed

Lines changed: 259 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/blas/ext/base/docs/types

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

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,17 @@ import dnansumkbn2 = require( '@stdlib/blas/ext/base/dnansumkbn2' );
5353
import dnansumors = require( '@stdlib/blas/ext/base/dnansumors' );
5454
import dnansumpw = require( '@stdlib/blas/ext/base/dnansumpw' );
5555
import drev = require( '@stdlib/blas/ext/base/drev' );
56+
import drrss = require( '@stdlib/blas/ext/base/drrss' );
57+
import drss = require( '@stdlib/blas/ext/base/drss' );
58+
import drssbl = require( '@stdlib/blas/ext/base/drssbl' );
59+
import drsskbn = require( '@stdlib/blas/ext/base/drsskbn' );
5660
import dsapxsum = require( '@stdlib/blas/ext/base/dsapxsum' );
5761
import dsapxsumpw = require( '@stdlib/blas/ext/base/dsapxsumpw' );
5862
import dsnannsumors = require( '@stdlib/blas/ext/base/dsnannsumors' );
5963
import dsnansum = require( '@stdlib/blas/ext/base/dsnansum' );
6064
import dsnansumors = require( '@stdlib/blas/ext/base/dsnansumors' );
6165
import dsnansumpw = require( '@stdlib/blas/ext/base/dsnansumpw' );
66+
import dsort = require( '@stdlib/blas/ext/base/dsort' );
6267
import dsort2hp = require( '@stdlib/blas/ext/base/dsort2hp' );
6368
import dsort2ins = require( '@stdlib/blas/ext/base/dsort2ins' );
6469
import dsort2sh = require( '@stdlib/blas/ext/base/dsort2sh' );
@@ -73,13 +78,15 @@ import dsumkbn = require( '@stdlib/blas/ext/base/dsumkbn' );
7378
import dsumkbn2 = require( '@stdlib/blas/ext/base/dsumkbn2' );
7479
import dsumors = require( '@stdlib/blas/ext/base/dsumors' );
7580
import dsumpw = require( '@stdlib/blas/ext/base/dsumpw' );
81+
import dzeroTo = require( '@stdlib/blas/ext/base/dzero-to' );
7682
import gapx = require( '@stdlib/blas/ext/base/gapx' );
7783
import gapxsum = require( '@stdlib/blas/ext/base/gapxsum' );
7884
import gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' );
7985
import gapxsumkbn2 = require( '@stdlib/blas/ext/base/gapxsumkbn2' );
8086
import gapxsumors = require( '@stdlib/blas/ext/base/gapxsumors' );
8187
import gapxsumpw = require( '@stdlib/blas/ext/base/gapxsumpw' );
8288
import gasumpw = require( '@stdlib/blas/ext/base/gasumpw' );
89+
import gcircshift = require( '@stdlib/blas/ext/base/gcircshift' );
8390
import gcusum = require( '@stdlib/blas/ext/base/gcusum' );
8491
import gcusumkbn = require( '@stdlib/blas/ext/base/gcusumkbn' );
8592
import gcusumkbn2 = require( '@stdlib/blas/ext/base/gcusumkbn2' );
@@ -91,6 +98,7 @@ import gfindIndex = require( '@stdlib/blas/ext/base/gfind-index' );
9198
import gfindLastIndex = require( '@stdlib/blas/ext/base/gfind-last-index' );
9299
import gindexOf = require( '@stdlib/blas/ext/base/gindex-of' );
93100
import gindexOfRow = require( '@stdlib/blas/ext/base/gindex-of-row' );
101+
import gjoin = require( '@stdlib/blas/ext/base/gjoin' );
94102
import glastIndexOf = require( '@stdlib/blas/ext/base/glast-index-of' );
95103
import glinspace = require( '@stdlib/blas/ext/base/glinspace' );
96104
import gnannsumkbn = require( '@stdlib/blas/ext/base/gnannsumkbn' );
@@ -101,6 +109,7 @@ import gnansumkbn2 = require( '@stdlib/blas/ext/base/gnansumkbn2' );
101109
import gnansumors = require( '@stdlib/blas/ext/base/gnansumors' );
102110
import gnansumpw = require( '@stdlib/blas/ext/base/gnansumpw' );
103111
import grev = require( '@stdlib/blas/ext/base/grev' );
112+
import gsort = require( '@stdlib/blas/ext/base/gsort' );
104113
import gsort2hp = require( '@stdlib/blas/ext/base/gsort2hp' );
105114
import gsort2ins = require( '@stdlib/blas/ext/base/gsort2ins' );
106115
import gsort2sh = require( '@stdlib/blas/ext/base/gsort2sh' );
@@ -1112,6 +1121,134 @@ interface Namespace {
11121121
*/
11131122
drev: typeof drev;
11141123

1124+
/**
1125+
* Compute the square root of the residual sum of squares of two double-precision floating-point strided arrays.
1126+
*
1127+
* @param N - number of indexed elements
1128+
* @param x - first input array
1129+
* @param strideX - stride length of `x`
1130+
* @param y - second input array
1131+
* @param strideY - stride length of `y`
1132+
* @returns square root of the residual sum of squares
1133+
*
1134+
* @example
1135+
* var Float64Array = require( '@stdlib/array/float64' );
1136+
* var ns.drrss = require( '@stdlib/blas/ext/base/drrss' );
1137+
*
1138+
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
1139+
* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] );
1140+
*
1141+
* var out = ns.drrss( x.length, x, 1, y, 1 );
1142+
* // returns ~6.7
1143+
*
1144+
* @example
1145+
* var Float64Array = require( '@stdlib/array/float64' );
1146+
* var ns.drrss = require( '@stdlib/blas/ext/base/drrss' );
1147+
*
1148+
* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
1149+
* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] );
1150+
*
1151+
* var z = ns.drrss.ndarray( x.length, x, 1, 0, y, 1, 0 );
1152+
* // returns ~8.485
1153+
*/
1154+
drrss: typeof drrss;
1155+
1156+
/**
1157+
* Computes the residual sum of squares of two double-precision floating-point strided arrays.
1158+
*
1159+
* @param N - number of indexed elements
1160+
* @param x - first input array
1161+
* @param strideX - stride length of `x`
1162+
* @param y - second input array
1163+
* @param strideY - stride length of `y`
1164+
* @returns residual sum of squares
1165+
*
1166+
* @example
1167+
* var Float64Array = require( '@stdlib/array/float64' );
1168+
* var ns.drss = require( '@stdlib/blas/ext/base/drss' );
1169+
*
1170+
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
1171+
* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] );
1172+
*
1173+
* var out = ns.drss( x.length, x, 1, y, 1 );
1174+
* // returns 45.0
1175+
*
1176+
* @example
1177+
* var Float64Array = require( '@stdlib/array/float64' );
1178+
* var ns.drss = require( '@stdlib/blas/ext/base/drss' );
1179+
*
1180+
* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
1181+
* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] );
1182+
*
1183+
* var z = ns.drss.ndarray( x.length, x, 1, 0, y, 1, 0 );
1184+
* // returns 72.0
1185+
*/
1186+
drss: typeof drss;
1187+
1188+
/**
1189+
* Computes the residual sum of squares of two double-precision floating-point strided arrays using Blue's algorithm.
1190+
*
1191+
* @param N - number of indexed elements
1192+
* @param x - first input array
1193+
* @param strideX - stride length of `x`
1194+
* @param y - second input array
1195+
* @param strideY - stride length of `y`
1196+
* @returns residual sum of squares
1197+
*
1198+
* @example
1199+
* var Float64Array = require( '@stdlib/array/float64' );
1200+
* var ns.drssbl = require( '@stdlib/blas/ext/base/drssbl' );
1201+
*
1202+
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
1203+
* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] );
1204+
*
1205+
* var out = ns.drssbl( x.length, x, 1, y, 1 );
1206+
* // returns 45.0
1207+
*
1208+
* @example
1209+
* var Float64Array = require( '@stdlib/array/float64' );
1210+
* var ns.drssbl = require( '@stdlib/blas/ext/base/drssbl' );
1211+
*
1212+
* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
1213+
* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] );
1214+
*
1215+
* var z = ns.drssbl.ndarray( x.length, x, 1, 0, y, 1, 0 );
1216+
* // returns 72.0
1217+
*/
1218+
drssbl: typeof drssbl;
1219+
1220+
/**
1221+
* Compute the residual sum of squares of two double-precision floating-point strided arrays using an improved Kahan–Babuška algorithm.
1222+
*
1223+
* @param N - number of indexed elements
1224+
* @param x - first input array
1225+
* @param strideX - stride length of `x`
1226+
* @param y - second input array
1227+
* @param strideY - stride length of `y`
1228+
* @returns residual sum of squares
1229+
*
1230+
* @example
1231+
* var Float64Array = require( '@stdlib/array/float64' );
1232+
* var ns.drsskbn = require( '@stdlib/blas/ext/base/drsskbn' );
1233+
*
1234+
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
1235+
* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] );
1236+
*
1237+
* var out = ns.drsskbn( x.length, x, 1, y, 1 );
1238+
* // returns 45.0
1239+
*
1240+
* @example
1241+
* var Float64Array = require( '@stdlib/array/float64' );
1242+
* var ns.drsskbn = require( '@stdlib/blas/ext/base/drsskbn' );
1243+
*
1244+
* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
1245+
* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] );
1246+
*
1247+
* var z = ns.drsskbn.ndarray( x.length, x, 1, 0, y, 1, 0 );
1248+
* // returns 72.0
1249+
*/
1250+
drsskbn: typeof drsskbn;
1251+
11151252
/**
11161253
* Adds a scalar constant to each single-precision floating-point strided array element, and computes the sum using extended accumulation and returning an extended precision result.
11171254
*
@@ -1276,6 +1413,33 @@ interface Namespace {
12761413
*/
12771414
dsnansumpw: typeof dsnansumpw;
12781415

1416+
/**
1417+
* Sorts a double-precision floating-point strided array.
1418+
*
1419+
* @param N - number of indexed elements
1420+
* @param order - sort order
1421+
* @param x - input array
1422+
* @param strideX - stride length
1423+
* @returns input array
1424+
*
1425+
* @example
1426+
* var Float64Array = require( '@stdlib/array/float64' );
1427+
*
1428+
* var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );
1429+
*
1430+
* ns.dsort( x.length, 1.0, x, 1 );
1431+
* // x => <Float64Array>[ -4.0, -2.0, 1.0, 3.0 ]
1432+
*
1433+
* @example
1434+
* var Float64Array = require( '@stdlib/array/float64' );
1435+
*
1436+
* var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );
1437+
*
1438+
* ns.dsort.ndarray( x.length, 1.0, x, 1, 0 );
1439+
* // x => <Float64Array>[ -4.0, -2.0, 1.0, 3.0 ]
1440+
*/
1441+
dsort: typeof dsort;
1442+
12791443
/**
12801444
* Simultaneously sorts two double-precision floating-point strided arrays based on the sort order of the first array using heapsort.
12811445
*
@@ -1688,6 +1852,32 @@ interface Namespace {
16881852
*/
16891853
dsumpw: typeof dsumpw;
16901854

1855+
/**
1856+
* Fills a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.
1857+
*
1858+
* @param N - number of indexed elements
1859+
* @param x - input array
1860+
* @param strideX - stride length
1861+
* @returns input array
1862+
*
1863+
* @example
1864+
* var Float64Array = require( '@stdlib/array/float64' );
1865+
*
1866+
* var x = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
1867+
*
1868+
* ns.dzeroTo( x.length, x, 1 );
1869+
* // x => <Float64Array>[ 0.0, 1.0, 2.0, 3.0 ]
1870+
*
1871+
* @example
1872+
* var Float64Array = require( '@stdlib/array/float64' );
1873+
*
1874+
* var x = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
1875+
*
1876+
* ns.dzeroTo.ndarray( x.length, x, 1, 0 );
1877+
* // x => <Float64Array>[ 0.0, 1.0, 2.0, 3.0 ]
1878+
*/
1879+
dzeroTo: typeof dzeroTo;
1880+
16911881
/**
16921882
* Adds a scalar constant to each element in a strided array.
16931883
*
@@ -1848,6 +2038,29 @@ interface Namespace {
18482038
*/
18492039
gasumpw: typeof gasumpw;
18502040

2041+
/**
2042+
* Circularly shifts the elements of a strided array by a specified number of positions.
2043+
*
2044+
* @param N - number of indexed elements
2045+
* @param k - number of positions to shift
2046+
* @param x - input array
2047+
* @param strideX - stride length
2048+
* @returns `x`
2049+
*
2050+
* @example
2051+
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
2052+
*
2053+
* ns.gcircshift( x.length, 2, x, 1 );
2054+
* // x => [ 4.0, 5.0, 1.0, 2.0, 3.0 ]
2055+
*
2056+
* @example
2057+
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
2058+
*
2059+
* ns.gcircshift.ndarray( x.length, 2, x, 1, 0 );
2060+
* // x => [ 4.0, 5.0, 1.0, 2.0, 3.0 ]
2061+
*/
2062+
gcircshift: typeof gcircshift;
2063+
18512064
/**
18522065
* Computes the cumulative sum of strided array elements.
18532066
*
@@ -2194,6 +2407,29 @@ interface Namespace {
21942407
*/
21952408
gindexOfRow: typeof gindexOfRow;
21962409

2410+
/**
2411+
* Returns a string created by joining strided array elements using a specified separator.
2412+
*
2413+
* @param N - number of indexed elements
2414+
* @param sep - separator
2415+
* @param x - input array
2416+
* @param strideX - stride length
2417+
* @returns joined string
2418+
*
2419+
* @example
2420+
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
2421+
*
2422+
* var str = ns.gjoin( x.length, ',', x, 1 );
2423+
* // returns '1,2,3,4'
2424+
*
2425+
* @example
2426+
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
2427+
*
2428+
* var str = ns.gjoin.ndarray( x.length, ',', x, 1, 0 );
2429+
* // returns '1,2,3,4'
2430+
*/
2431+
gjoin: typeof gjoin;
2432+
21972433
/**
21982434
* Returns the last index of a specified search element in a strided array.
21992435
*
@@ -2442,6 +2678,29 @@ interface Namespace {
24422678
*/
24432679
grev: typeof grev;
24442680

2681+
/**
2682+
* Sorts a strided array.
2683+
*
2684+
* @param N - number of indexed elements
2685+
* @param order - sort order
2686+
* @param x - input array
2687+
* @param strideX - stride length
2688+
* @returns `x`
2689+
*
2690+
* @example
2691+
* var x = [ 1.0, -2.0, 3.0, -4.0 ];
2692+
*
2693+
* ns.gsort( x.length, 1, x, 1 );
2694+
* // x => [ -4.0, -2.0, 1.0, 3.0 ]
2695+
*
2696+
* @example
2697+
* var x = [ 1.0, -2.0, 3.0, -4.0 ];
2698+
*
2699+
* ns.gsort.ndarray( x.length, 1, x, 1, 0 );
2700+
* // x => [ -4.0, -2.0, 1.0, 3.0 ]
2701+
*/
2702+
gsort: typeof gsort;
2703+
24452704
/**
24462705
* Simultaneously sorts two strided arrays based on the sort order of the first array using heapsort.
24472706
*

0 commit comments

Comments
 (0)