Skip to content

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

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

Open
stdlib-bot wants to merge 1 commit into
base: develop
Choose a base branch
from
+203 −12
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
215 changes: 203 additions & 12 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 @@ -38,6 +38,7 @@ import dapxsumkbn2 = require( '@stdlib/blas/ext/base/dapxsumkbn2' );
import dapxsumors = require( '@stdlib/blas/ext/base/dapxsumors' );
import dapxsumpw = require( '@stdlib/blas/ext/base/dapxsumpw' );
import dasumpw = require( '@stdlib/blas/ext/base/dasumpw' );
import daxpb = require( '@stdlib/blas/ext/base/daxpb' );
import dcartesianPower = require( '@stdlib/blas/ext/base/dcartesian-power' );
import dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' );
import dcircshift = require( '@stdlib/blas/ext/base/dcircshift' );
Expand All @@ -47,6 +48,7 @@ import dcusumkbn2 = require( '@stdlib/blas/ext/base/dcusumkbn2' );
import dcusumors = require( '@stdlib/blas/ext/base/dcusumors' );
import dcusumpw = require( '@stdlib/blas/ext/base/dcusumpw' );
import ddiff = require( '@stdlib/blas/ext/base/ddiff' );
import dediff = require( '@stdlib/blas/ext/base/dediff' );
import dfill = require( '@stdlib/blas/ext/base/dfill' );
import dindexOf = require( '@stdlib/blas/ext/base/dindex-of' );
import dindexOfColumn = require( '@stdlib/blas/ext/base/dindex-of-column' );
Expand Down Expand Up @@ -164,6 +166,7 @@ import sapxsumkbn2 = require( '@stdlib/blas/ext/base/sapxsumkbn2' );
import sapxsumors = require( '@stdlib/blas/ext/base/sapxsumors' );
import sapxsumpw = require( '@stdlib/blas/ext/base/sapxsumpw' );
import sasumpw = require( '@stdlib/blas/ext/base/sasumpw' );
import saxpb = require( '@stdlib/blas/ext/base/saxpb' );
import scartesianPower = require( '@stdlib/blas/ext/base/scartesian-power' );
import scartesianSquare = require( '@stdlib/blas/ext/base/scartesian-square' );
import scircshift = require( '@stdlib/blas/ext/base/scircshift' );
Expand All @@ -179,6 +182,7 @@ import sdsnansum = require( '@stdlib/blas/ext/base/sdsnansum' );
import sdsnansumpw = require( '@stdlib/blas/ext/base/sdsnansumpw' );
import sdssum = require( '@stdlib/blas/ext/base/sdssum' );
import sdssumpw = require( '@stdlib/blas/ext/base/sdssumpw' );
import sediff = require( '@stdlib/blas/ext/base/sediff' );
import sfill = require( '@stdlib/blas/ext/base/sfill' );
import sindexOf = require( '@stdlib/blas/ext/base/sindex-of' );
import sindexOfColumn = require( '@stdlib/blas/ext/base/sindex-of-column' );
Expand Down Expand Up @@ -211,6 +215,7 @@ import svander = require( '@stdlib/blas/ext/base/svander' );
import swhere = require( '@stdlib/blas/ext/base/swhere' );
import szeroTo = require( '@stdlib/blas/ext/base/szero-to' );
import wasm = require( '@stdlib/blas/ext/base/wasm' );
import zdiff = require( '@stdlib/blas/ext/base/zdiff' );
import zfill = require( '@stdlib/blas/ext/base/zfill' );
import zindexOf = require( '@stdlib/blas/ext/base/zindex-of' );
import zindexOfColumn = require( '@stdlib/blas/ext/base/zindex-of-column' );
Expand Down Expand Up @@ -342,7 +347,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -385,7 +390,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -786,6 +791,34 @@ interface Namespace {
*/
dasumpw: typeof dasumpw;

/**
* Multiplies each element in a double-precision floating-point strided array by a scalar constant and adds a scalar constant to each result.
*
* @param N - number of indexed elements
* @param alpha - first scalar constant
* @param beta - second scalar constant
* @param x - input array
* @param strideX - stride length
* @returns input array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
*
* ns.daxpb( x.length, 5.0, 3.0, x, 1 );
* // x => <Float64Array>[ -7.0, 8.0, 18.0, -22.0, 23.0, 3.0, -2.0, -12.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
*
* ns.daxpb.ndarray( x.length, 5.0, 3.0, x, 1, 0 );
* // x => <Float64Array>[ -7.0, 8.0, 18.0, -22.0, 23.0, 3.0, -2.0, -12.0 ]
*/
daxpb: typeof daxpb;

/**
* Computes the Cartesian power for a double-precision floating-point strided array.
*
Expand Down Expand Up @@ -1085,6 +1118,46 @@ interface Namespace {
*/
ddiff: typeof ddiff;

/**
* Calculates the differences between consecutive elements of a double-precision floating-point strided array.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length for `x`
* @param N1 - number of indexed elements to prepend
* @param prepend - prepend array
* @param strideP - stride length for `prepend`
* @param N2 - number of indexed elements to append
* @param append - append array
* @param strideA - stride length for `append`
* @param out - output array
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 2.0, 4.0, 7.0, 11.0, 16.0 ] );
* var p = new Float64Array( [ 1.0 ] );
* var a = new Float64Array( [ 22.0 ] );
* var out = new Float64Array( 6 );
*
* ns.dediff( x.length, x, 1, 1, p, 1, 1, a, 1, out, 1 );
* // out => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 22.0 ]
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 2.0, 4.0, 7.0, 11.0, 16.0 ] );
* var p = new Float64Array( [ 1.0 ] );
* var a = new Float64Array( [ 22.0 ] );
* var out = new Float64Array( 6 );
*
* ns.dediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
* // out => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 22.0 ]
*/
dediff: typeof dediff;

/**
* Fills a double-precision floating-point strided array with a specified scalar value.
*
Expand Down Expand Up @@ -1191,7 +1264,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -1265,7 +1338,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -3293,7 +3366,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching column, the function returns `-1` (i.e., an invalid index).
*
* @param order - storage layout
* @param M - number of rows in `A`
Expand Down Expand Up @@ -3325,7 +3398,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
*
* @param order - storage layout
* @param M - number of rows in `A`
Expand Down Expand Up @@ -3435,7 +3508,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -4373,6 +4446,34 @@ interface Namespace {
*/
sasumpw: typeof sasumpw;

/**
* Multiplies each element in a single-precision floating-point strided array by a scalar constant and adds a scalar constant to each result.
*
* @param N - number of indexed elements
* @param alpha - first scalar constant
* @param beta - second scalar constant
* @param x - input array
* @param strideX - stride length
* @returns input array
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
*
* ns.saxpb( x.length, 5.0, 3.0, x, 1 );
* // x => <Float32Array>[ -7.0, 8.0, 18.0, -22.0, 23.0, 3.0, -2.0, -12.0 ]
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
*
* ns.saxpb.ndarray( x.length, 5.0, 3.0, x, 1, 0 );
* // x => <Float32Array>[ -7.0, 8.0, 18.0, -22.0, 23.0, 3.0, -2.0, -12.0 ]
*/
saxpb: typeof saxpb;

/**
* Computes the Cartesian power for a single-precision floating-point strided array.
*
Expand Down Expand Up @@ -4830,6 +4931,46 @@ interface Namespace {
*/
sdssumpw: typeof sdssumpw;

/**
* Calculates the differences between consecutive elements of a single-precision floating-point strided array.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length for `x`
* @param N1 - number of indexed elements to prepend
* @param prepend - prepend array
* @param strideP - stride length for `prepend`
* @param N2 - number of indexed elements to append
* @param append - append array
* @param strideA - stride length for `append`
* @param out - output array
* @param strideOut - stride length for `out`
* @returns output array
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 2.0, 4.0, 7.0, 11.0, 16.0 ] );
* var p = new Float32Array( [ 1.0 ] );
* var a = new Float32Array( [ 22.0 ] );
* var out = new Float32Array( 6 );
*
* ns.sediff( x.length, x, 1, 1, p, 1, 1, a, 1, out, 1 );
* // out => <Float32Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 22.0 ]
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 2.0, 4.0, 7.0, 11.0, 16.0 ] );
* var p = new Float32Array( [ 1.0 ] );
* var a = new Float32Array( [ 22.0 ] );
* var out = new Float32Array( 6 );
*
* ns.sediff.ndarray( x.length, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0 );
* // out => <Float32Array>[ 1.0, 2.0, 3.0, 4.0, 5.0, 22.0 ]
*/
sediff: typeof sediff;

/**
* Fills a single-precision floating-point strided array with a specified scalar value.
*
Expand Down Expand Up @@ -4893,7 +5034,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching column, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in row-major order. When the matrix is stored in column-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -4936,7 +5077,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -5010,7 +5151,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -5791,6 +5932,56 @@ interface Namespace {
*/
wasm: typeof wasm;

/**
* Calculates the k-th discrete forward difference of a double-precision complex floating-point strided array.
*
* ## Notes
*
* - The `out` array must have `N + N1 + N2 - k` elements.
* - The `workspace` array must have `N + N1 + N2 - 1` elements.
*
* @param N - number of indexed elements
* @param k - number of times to recursively compute differences
* @param x - input array
* @param strideX - stride length for `x`
* @param N1 - number of indexed elements for `prepend`
* @param prepend - prepend array
* @param strideP - stride length for `prepend`
* @param N2 - number of indexed elements for `append`
* @param append - append array
* @param strideA - stride length for `append`
* @param out - output array
* @param strideOut - stride length for `out`
* @param workspace - workspace array
* @param strideW - stride length for `workspace`
* @returns output array
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 2.0, -2.0, 4.0, -4.0, 6.0, -6.0, 8.0, -8.0, 10.0, -10.0 ] );
* var p = new Complex128Array( [ 1.0, -1.0 ] );
* var a = new Complex128Array( [ 11.0, -11.0 ] );
* var out = new Complex128Array( 6 );
* var w = new Complex128Array( 6 );
*
* ns.zdiff( x.length, 1, x, 1, 1, p, 1, 1, a, 1, out, 1, w, 1 );
* // out => <Complex128Array>[ 1.0, -1.0, 2.0, -2.0, 2.0, -2.0, 2.0, -2.0, 2.0, -2.0, 1.0, -1.0 ]
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 2.0, -2.0, 4.0, -4.0, 6.0, -6.0, 8.0, -8.0, 10.0, -10.0 ] );
* var p = new Complex128Array( [ 1.0, -1.0 ] );
* var a = new Complex128Array( [ 11.0, -11.0 ] );
* var out = new Complex128Array( 6 );
* var w = new Complex128Array( 6 );
*
* ns.zdiff.ndarray( x.length, 1, x, 1, 0, 1, p, 1, 0, 1, a, 1, 0, out, 1, 0, w, 1, 0 );
* // out => <Complex128Array>[ 1.0, -1.0, 2.0, -2.0, 2.0, -2.0, 2.0, -2.0, 2.0, -2.0, 1.0, -1.0 ]
*/
zdiff: typeof zdiff;

/**
* Fills a double-precision complex floating-point strided array with a specified scalar constant.
*
Expand Down Expand Up @@ -5894,7 +6085,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down Expand Up @@ -5937,7 +6128,7 @@ interface Namespace {
*
* ## Notes
*
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
* - If the function is provided an empty matrix or if the function is unable to find a matching row, the function returns `-1` (i.e., an invalid index).
* - The `workspace` array is only applicable when an input matrix is stored in column-major order. When the matrix is stored in row-major order, the workspace array is ignored.
*
* @param order - storage layout
Expand Down