Skip to content

Commit bf4aa3e

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

1 file changed

Lines changed: 163 additions & 0 deletions

File tree

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

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

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import coneTo = require( '@stdlib/blas/ext/base/ndarray/cone-to' );
2727
import csum = require( '@stdlib/blas/ext/base/ndarray/csum' );
2828
import csumkbn = require( '@stdlib/blas/ext/base/ndarray/csumkbn' );
2929
import cunitspace = require( '@stdlib/blas/ext/base/ndarray/cunitspace' );
30+
import cxpy = require( '@stdlib/blas/ext/base/ndarray/cxpy' );
3031
import cxsa = require( '@stdlib/blas/ext/base/ndarray/cxsa' );
3132
import czeroTo = require( '@stdlib/blas/ext/base/ndarray/czero-to' );
3233
import daxpb = require( '@stdlib/blas/ext/base/ndarray/daxpb' );
@@ -39,6 +40,7 @@ import dcusumors = require( '@stdlib/blas/ext/base/ndarray/dcusumors' );
3940
import dcusumpw = require( '@stdlib/blas/ext/base/ndarray/dcusumpw' );
4041
import ddiff = require( '@stdlib/blas/ext/base/ndarray/ddiff' );
4142
import dindexOf = require( '@stdlib/blas/ext/base/ndarray/dindex-of' );
43+
import dindexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/dindex-of-falsy' );
4244
import dlastIndexOf = require( '@stdlib/blas/ext/base/ndarray/dlast-index-of' );
4345
import dlinspace = require( '@stdlib/blas/ext/base/ndarray/dlinspace' );
4446
import dnansum = require( '@stdlib/blas/ext/base/ndarray/dnansum' );
@@ -57,6 +59,7 @@ import dsumkbn2 = require( '@stdlib/blas/ext/base/ndarray/dsumkbn2' );
5759
import dsumors = require( '@stdlib/blas/ext/base/ndarray/dsumors' );
5860
import dsumpw = require( '@stdlib/blas/ext/base/ndarray/dsumpw' );
5961
import dunitspace = require( '@stdlib/blas/ext/base/ndarray/dunitspace' );
62+
import dxpy = require( '@stdlib/blas/ext/base/ndarray/dxpy' );
6063
import dxsa = require( '@stdlib/blas/ext/base/ndarray/dxsa' );
6164
import dzeroTo = require( '@stdlib/blas/ext/base/ndarray/dzero-to' );
6265
import gaxpb = require( '@stdlib/blas/ext/base/ndarray/gaxpb' );
@@ -70,6 +73,8 @@ import gcusumpw = require( '@stdlib/blas/ext/base/ndarray/gcusumpw' );
7073
import gfindIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-index' );
7174
import gfindLastIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-last-index' );
7275
import gindexOf = require( '@stdlib/blas/ext/base/ndarray/gindex-of' );
76+
import gindexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/gindex-of-falsy' );
77+
import gindexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/gindex-of-truthy' );
7378
import gjoin = require( '@stdlib/blas/ext/base/ndarray/gjoin' );
7479
import gjoinBetween = require( '@stdlib/blas/ext/base/ndarray/gjoin-between' );
7580
import glastIndexOf = require( '@stdlib/blas/ext/base/ndarray/glast-index-of' );
@@ -88,6 +93,7 @@ import gsumkbn2 = require( '@stdlib/blas/ext/base/ndarray/gsumkbn2' );
8893
import gsumors = require( '@stdlib/blas/ext/base/ndarray/gsumors' );
8994
import gsumpw = require( '@stdlib/blas/ext/base/ndarray/gsumpw' );
9095
import gunitspace = require( '@stdlib/blas/ext/base/ndarray/gunitspace' );
96+
import gxpy = require( '@stdlib/blas/ext/base/ndarray/gxpy' );
9197
import gxsa = require( '@stdlib/blas/ext/base/ndarray/gxsa' );
9298
import gzeroTo = require( '@stdlib/blas/ext/base/ndarray/gzero-to' );
9399
import saxpb = require( '@stdlib/blas/ext/base/ndarray/saxpb' );
@@ -115,6 +121,7 @@ import ssumkbn2 = require( '@stdlib/blas/ext/base/ndarray/ssumkbn2' );
115121
import ssumors = require( '@stdlib/blas/ext/base/ndarray/ssumors' );
116122
import ssumpw = require( '@stdlib/blas/ext/base/ndarray/ssumpw' );
117123
import sunitspace = require( '@stdlib/blas/ext/base/ndarray/sunitspace' );
124+
import sxpy = require( '@stdlib/blas/ext/base/ndarray/sxpy' );
118125
import sxsa = require( '@stdlib/blas/ext/base/ndarray/sxsa' );
119126
import szeroTo = require( '@stdlib/blas/ext/base/ndarray/szero-to' );
120127
import zaxpb = require( '@stdlib/blas/ext/base/ndarray/zaxpb' );
@@ -330,6 +337,30 @@ interface Namespace {
330337
*/
331338
cunitspace: typeof cunitspace;
332339

340+
/**
341+
* Adds elements of a one-dimensional single-precision complex floating-point ndarray to the corresponding elements of a second one-dimensional single-precision complex floating-point ndarray and assigns the results to the second ndarray.
342+
*
343+
* ## Notes
344+
*
345+
* - The function expects the following ndarrays:
346+
*
347+
* - a one-dimensional input ndarray.
348+
* - a one-dimensional output ndarray.
349+
*
350+
* @param arrays - array-like object containing ndarrays
351+
* @returns output ndarray
352+
*
353+
* @example
354+
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
355+
*
356+
* var x = new Complex64Vector( [ 1.0, 2.0, 3.0, -1.0, 0.0, 1.0 ] );
357+
* var y = new Complex64Vector( [ 2.0, 1.0, -1.0, 3.0, 4.0, 0.0 ] );
358+
*
359+
* var out = ns.cxpy( [ x, y ] );
360+
* // returns <ndarray>[ <Complex64>[ 3.0, 3.0 ], <Complex64>[ 2.0, 2.0 ], <Complex64>[ 4.0, 1.0 ] ]
361+
*/
362+
cxpy: typeof cxpy;
363+
333364
/**
334365
* Subtracts a scalar constant from each element in a one-dimensional single-precision complex floating-point ndarray.
335366
*
@@ -710,6 +741,28 @@ interface Namespace {
710741
*/
711742
dindexOf: typeof dindexOf;
712743

744+
/**
745+
* Returns the index of the first falsy element in a one-dimensional double-precision floating-point ndarray.
746+
*
747+
* ## Notes
748+
*
749+
* - The function expects the following ndarrays:
750+
*
751+
* - a one-dimensional input ndarray.
752+
*
753+
* @param arrays - array-like object containing ndarrays
754+
* @returns index
755+
*
756+
* @example
757+
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
758+
*
759+
* var x = new Float64Vector( [ 1.0, 0.0, 3.0, 2.0 ] );
760+
*
761+
* var v = ns.dindexOfFalsy( [ x ] );
762+
* // returns 1
763+
*/
764+
dindexOfFalsy: typeof dindexOfFalsy;
765+
713766
/**
714767
* Returns the last index of a search element in a one-dimensional double-precision floating-point ndarray.
715768
*
@@ -1168,6 +1221,30 @@ interface Namespace {
11681221
*/
11691222
dunitspace: typeof dunitspace;
11701223

1224+
/**
1225+
* Adds elements of a one-dimensional double-precision floating-point ndarray to the corresponding elements of a second one-dimensional double-precision floating-point ndarray and assigns the results to the second ndarray.
1226+
*
1227+
* ## Notes
1228+
*
1229+
* - The function expects the following ndarrays:
1230+
*
1231+
* - a one-dimensional input ndarray.
1232+
* - a one-dimensional output ndarray.
1233+
*
1234+
* @param arrays - array-like object containing ndarrays
1235+
* @returns output ndarray
1236+
*
1237+
* @example
1238+
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
1239+
*
1240+
* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
1241+
* var y = new Float64Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] );
1242+
*
1243+
* var out = ns.dxpy( [ x, y ] );
1244+
* // returns <ndarray>[ 3.0, 5.0, 7.0, 9.0, 11.0 ]
1245+
*/
1246+
dxpy: typeof dxpy;
1247+
11711248
/**
11721249
* Subtracts a scalar constant from each element in a one-dimensional double-precision floating-point ndarray.
11731250
*
@@ -1573,6 +1650,44 @@ interface Namespace {
15731650
*/
15741651
gindexOf: typeof gindexOf;
15751652

1653+
/**
1654+
* Returns the index of the first falsy element in a one-dimensional ndarray.
1655+
*
1656+
* ## Notes
1657+
*
1658+
* - The function expects the following ndarrays:
1659+
*
1660+
* - a one-dimensional input ndarray.
1661+
*
1662+
* @param arrays - array-like object containing ndarrays
1663+
* @returns index
1664+
*
1665+
* @example
1666+
* var vector = require( '@stdlib/ndarray/vector/ctor' );
1667+
*
1668+
* var x = vector( [ 1.0, 3.0, 0.0, 2.0 ], 'generic' );
1669+
*
1670+
* var v = ns.gindexOfFalsy( [ x ] );
1671+
* // returns 2
1672+
*/
1673+
gindexOfFalsy: typeof gindexOfFalsy;
1674+
1675+
/**
1676+
* Returns the index of the first truthy element in a one-dimensional ndarray.
1677+
*
1678+
* @param arrays - array-like object containing ndarrays
1679+
* @returns index
1680+
*
1681+
* @example
1682+
* var vector = require( '@stdlib/ndarray/vector/ctor' );
1683+
*
1684+
* var x = vector( [ 0.0, 0.0, 3.0, 0.0, 4.0 ], 'generic' );
1685+
*
1686+
* var idx = ns.gindexOfTruthy( [ x ] );
1687+
* // returns 2
1688+
*/
1689+
gindexOfTruthy: typeof gindexOfTruthy;
1690+
15761691
/**
15771692
* Returns a string created by joining one-dimensional ndarray elements using a specified separator.
15781693
*
@@ -2040,6 +2155,30 @@ interface Namespace {
20402155
*/
20412156
gunitspace: typeof gunitspace;
20422157

2158+
/**
2159+
* Adds elements of a one-dimensional ndarray to the corresponding elements of a second one-dimensional ndarray and assigns the results to the second ndarray.
2160+
*
2161+
* ## Notes
2162+
*
2163+
* - The function expects the following ndarrays:
2164+
*
2165+
* - a one-dimensional input ndarray.
2166+
* - a one-dimensional output ndarray.
2167+
*
2168+
* @param arrays - array-like object containing ndarrays
2169+
* @returns output ndarray
2170+
*
2171+
* @example
2172+
* var vector = require( '@stdlib/ndarray/vector/ctor' );
2173+
*
2174+
* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );
2175+
* var y = vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ], 'generic' );
2176+
*
2177+
* var out = ns.gxpy( [ x, y ] );
2178+
* // returns <ndarray>[ 3.0, 5.0, 7.0, 9.0, 11.0 ]
2179+
*/
2180+
gxpy: typeof gxpy;
2181+
20432182
/**
20442183
* Subtracts a scalar constant from each element in a one-dimensional ndarray.
20452184
*
@@ -2786,6 +2925,30 @@ interface Namespace {
27862925
*/
27872926
sunitspace: typeof sunitspace;
27882927

2928+
/**
2929+
* Adds elements of a one-dimensional single-precision floating-point ndarray to the corresponding elements of a second one-dimensional single-precision floating-point ndarray and assigns the results to the second ndarray.
2930+
*
2931+
* ## Notes
2932+
*
2933+
* - The function expects the following ndarrays:
2934+
*
2935+
* - a one-dimensional input ndarray.
2936+
* - a one-dimensional output ndarray.
2937+
*
2938+
* @param arrays - array-like object containing ndarrays
2939+
* @returns output ndarray
2940+
*
2941+
* @example
2942+
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
2943+
*
2944+
* var x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
2945+
* var y = new Float32Vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ] );
2946+
*
2947+
* var out = ns.sxpy( [ x, y ] );
2948+
* // returns <ndarray>[ 3.0, 5.0, 7.0, 9.0, 11.0 ]
2949+
*/
2950+
sxpy: typeof sxpy;
2951+
27892952
/**
27902953
* Subtracts a scalar constant from each element in a one-dimensional single-precision floating-point ndarray.
27912954
*

0 commit comments

Comments
 (0)