Skip to content

feat: update blas/ext/base TypeScript declarations #11165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
stdlib-bot wants to merge 2 commits into from
Closed

feat: update blas/ext/base TypeScript declarations #11165

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10b44d3
feat: update `blas/ext/base` TypeScript declarations
stdlib-bot Mar 27, 2026
fc1acde
Merge remote-tracking branch 'upstream/develop' into update-blas-ext-…
stdlib-bot Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
259 changes: 259 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,17 @@
import dnansumors = require( '@stdlib/blas/ext/base/dnansumors' );
import dnansumpw = require( '@stdlib/blas/ext/base/dnansumpw' );
import drev = require( '@stdlib/blas/ext/base/drev' );
import drrss = require( '@stdlib/blas/ext/base/drrss' );
import drss = require( '@stdlib/blas/ext/base/drss' );
import drssbl = require( '@stdlib/blas/ext/base/drssbl' );
import drsskbn = require( '@stdlib/blas/ext/base/drsskbn' );
import dsapxsum = require( '@stdlib/blas/ext/base/dsapxsum' );
import dsapxsumpw = require( '@stdlib/blas/ext/base/dsapxsumpw' );
import dsnannsumors = require( '@stdlib/blas/ext/base/dsnannsumors' );
import dsnansum = require( '@stdlib/blas/ext/base/dsnansum' );
import dsnansumors = require( '@stdlib/blas/ext/base/dsnansumors' );
import dsnansumpw = require( '@stdlib/blas/ext/base/dsnansumpw' );
import dsort = require( '@stdlib/blas/ext/base/dsort' );
import dsort2hp = require( '@stdlib/blas/ext/base/dsort2hp' );
import dsort2ins = require( '@stdlib/blas/ext/base/dsort2ins' );
import dsort2sh = require( '@stdlib/blas/ext/base/dsort2sh' );
Expand All @@ -73,13 +78,15 @@
import dsumkbn2 = require( '@stdlib/blas/ext/base/dsumkbn2' );
import dsumors = require( '@stdlib/blas/ext/base/dsumors' );
import dsumpw = require( '@stdlib/blas/ext/base/dsumpw' );
import dzeroTo = require( '@stdlib/blas/ext/base/dzero-to' );
import gapx = require( '@stdlib/blas/ext/base/gapx' );
import gapxsum = require( '@stdlib/blas/ext/base/gapxsum' );
import gapxsumkbn = require( '@stdlib/blas/ext/base/gapxsumkbn' );
import gapxsumkbn2 = require( '@stdlib/blas/ext/base/gapxsumkbn2' );
import gapxsumors = require( '@stdlib/blas/ext/base/gapxsumors' );
import gapxsumpw = require( '@stdlib/blas/ext/base/gapxsumpw' );
import gasumpw = require( '@stdlib/blas/ext/base/gasumpw' );
import gcircshift = require( '@stdlib/blas/ext/base/gcircshift' );
import gcusum = require( '@stdlib/blas/ext/base/gcusum' );
import gcusumkbn = require( '@stdlib/blas/ext/base/gcusumkbn' );
import gcusumkbn2 = require( '@stdlib/blas/ext/base/gcusumkbn2' );
Expand All @@ -91,6 +98,7 @@
import gfindLastIndex = require( '@stdlib/blas/ext/base/gfind-last-index' );
import gindexOf = require( '@stdlib/blas/ext/base/gindex-of' );
import gindexOfRow = require( '@stdlib/blas/ext/base/gindex-of-row' );
import gjoin = require( '@stdlib/blas/ext/base/gjoin' );
import glastIndexOf = require( '@stdlib/blas/ext/base/glast-index-of' );
import glinspace = require( '@stdlib/blas/ext/base/glinspace' );
import gnannsumkbn = require( '@stdlib/blas/ext/base/gnannsumkbn' );
Expand All @@ -101,6 +109,7 @@
import gnansumors = require( '@stdlib/blas/ext/base/gnansumors' );
import gnansumpw = require( '@stdlib/blas/ext/base/gnansumpw' );
import grev = require( '@stdlib/blas/ext/base/grev' );
import gsort = require( '@stdlib/blas/ext/base/gsort' );
import gsort2hp = require( '@stdlib/blas/ext/base/gsort2hp' );
import gsort2ins = require( '@stdlib/blas/ext/base/gsort2ins' );
import gsort2sh = require( '@stdlib/blas/ext/base/gsort2sh' );
Expand Down Expand Up @@ -1112,6 +1121,134 @@
*/
drev: typeof drev;

/**

Check failure on line 1124 in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: Unexpected token '.'

Check failure on line 1124 in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: Unexpected token '.'
* Compute the square root of the residual sum of squares of two double-precision floating-point strided arrays.
*
* @param N - number of indexed elements
* @param x - first input array
* @param strideX - stride length of `x`
* @param y - second input array
* @param strideY - stride length of `y`
* @returns square root of the residual sum of squares
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ns.drrss = require( '@stdlib/blas/ext/base/drrss' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] );
*
* var out = ns.drrss( x.length, x, 1, y, 1 );
* // returns ~6.7
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ns.drrss = require( '@stdlib/blas/ext/base/drrss' );
*
* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] );
*
* var z = ns.drrss.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns ~8.485
*/
drrss: typeof drrss;

/**

Check failure on line 1156 in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: Unexpected token '.'

Check failure on line 1156 in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: Unexpected token '.'
* Computes the residual sum of squares of two double-precision floating-point strided arrays.
*
* @param N - number of indexed elements
* @param x - first input array
* @param strideX - stride length of `x`
* @param y - second input array
* @param strideY - stride length of `y`
* @returns residual sum of squares
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ns.drss = require( '@stdlib/blas/ext/base/drss' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] );
*
* var out = ns.drss( x.length, x, 1, y, 1 );
* // returns 45.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ns.drss = require( '@stdlib/blas/ext/base/drss' );
*
* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] );
*
* var z = ns.drss.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns 72.0
*/
drss: typeof drss;

/**

Check failure on line 1188 in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: Unexpected token '.'

Check failure on line 1188 in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: Unexpected token '.'
* Computes the residual sum of squares of two double-precision floating-point strided arrays using Blue's algorithm.
*
* @param N - number of indexed elements
* @param x - first input array
* @param strideX - stride length of `x`
* @param y - second input array
* @param strideY - stride length of `y`
* @returns residual sum of squares
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ns.drssbl = require( '@stdlib/blas/ext/base/drssbl' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] );
*
* var out = ns.drssbl( x.length, x, 1, y, 1 );
* // returns 45.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ns.drssbl = require( '@stdlib/blas/ext/base/drssbl' );
*
* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] );
*
* var z = ns.drssbl.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns 72.0
*/
drssbl: typeof drssbl;

/**

Check failure on line 1220 in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: Unexpected token '.'

Check failure on line 1220 in lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Encountered an error while running example code: Unexpected token '.'
* Compute the residual sum of squares of two double-precision floating-point strided arrays using an improved Kahan–Babuška algorithm.
*
* @param N - number of indexed elements
* @param x - first input array
* @param strideX - stride length of `x`
* @param y - second input array
* @param strideY - stride length of `y`
* @returns residual sum of squares
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ns.drsskbn = require( '@stdlib/blas/ext/base/drsskbn' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
* var y = new Float64Array( [ 1.0, 1.0, -4.0 ] );
*
* var out = ns.drsskbn( x.length, x, 1, y, 1 );
* // returns 45.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ns.drsskbn = require( '@stdlib/blas/ext/base/drsskbn' );
*
* var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
* var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] );
*
* var z = ns.drsskbn.ndarray( x.length, x, 1, 0, y, 1, 0 );
* // returns 72.0
*/
drsskbn: typeof drsskbn;

/**
* 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.
*
Expand Down Expand Up @@ -1276,6 +1413,33 @@
*/
dsnansumpw: typeof dsnansumpw;

/**
* Sorts a double-precision floating-point strided array.
*
* @param N - number of indexed elements
* @param order - sort order
* @param x - input array
* @param strideX - stride length
* @returns input array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );
*
* ns.dsort( x.length, 1.0, x, 1 );
* // x => <Float64Array>[ -4.0, -2.0, 1.0, 3.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );
*
* ns.dsort.ndarray( x.length, 1.0, x, 1, 0 );
* // x => <Float64Array>[ -4.0, -2.0, 1.0, 3.0 ]
*/
dsort: typeof dsort;

/**
* Simultaneously sorts two double-precision floating-point strided arrays based on the sort order of the first array using heapsort.
*
Expand Down Expand Up @@ -1688,6 +1852,32 @@
*/
dsumpw: typeof dsumpw;

/**
* Fills a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length
* @returns input array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.dzeroTo( x.length, x, 1 );
* // x => <Float64Array>[ 0.0, 1.0, 2.0, 3.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
*
* ns.dzeroTo.ndarray( x.length, x, 1, 0 );
* // x => <Float64Array>[ 0.0, 1.0, 2.0, 3.0 ]
*/
dzeroTo: typeof dzeroTo;

/**
* Adds a scalar constant to each element in a strided array.
*
Expand Down Expand Up @@ -1848,6 +2038,29 @@
*/
gasumpw: typeof gasumpw;

/**
* Circularly shifts the elements of a strided array by a specified number of positions.
*
* @param N - number of indexed elements
* @param k - number of positions to shift
* @param x - input array
* @param strideX - stride length
* @returns `x`
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
*
* ns.gcircshift( x.length, 2, x, 1 );
* // x => [ 4.0, 5.0, 1.0, 2.0, 3.0 ]
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
*
* ns.gcircshift.ndarray( x.length, 2, x, 1, 0 );
* // x => [ 4.0, 5.0, 1.0, 2.0, 3.0 ]
*/
gcircshift: typeof gcircshift;

/**
* Computes the cumulative sum of strided array elements.
*
Expand Down Expand Up @@ -2194,6 +2407,29 @@
*/
gindexOfRow: typeof gindexOfRow;

/**
* Returns a string created by joining strided array elements using a specified separator.
*
* @param N - number of indexed elements
* @param sep - separator
* @param x - input array
* @param strideX - stride length
* @returns joined string
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
*
* var str = ns.gjoin( x.length, ',', x, 1 );
* // returns '1,2,3,4'
*
* @example
* var x = [ 1.0, 2.0, 3.0, 4.0 ];
*
* var str = ns.gjoin.ndarray( x.length, ',', x, 1, 0 );
* // returns '1,2,3,4'
*/
gjoin: typeof gjoin;

/**
* Returns the last index of a specified search element in a strided array.
*
Expand Down Expand Up @@ -2442,6 +2678,29 @@
*/
grev: typeof grev;

/**
* Sorts a strided array.
*
* @param N - number of indexed elements
* @param order - sort order
* @param x - input array
* @param strideX - stride length
* @returns `x`
*
* @example
* var x = [ 1.0, -2.0, 3.0, -4.0 ];
*
* ns.gsort( x.length, 1, x, 1 );
* // x => [ -4.0, -2.0, 1.0, 3.0 ]
*
* @example
* var x = [ 1.0, -2.0, 3.0, -4.0 ];
*
* ns.gsort.ndarray( x.length, 1, x, 1, 0 );
* // x => [ -4.0, -2.0, 1.0, 3.0 ]
*/
gsort: typeof gsort;

/**
* Simultaneously sorts two strided arrays based on the sort order of the first array using heapsort.
*
Expand Down
Loading