Skip to content

feat!: update namespace TypeScript declarations #4809

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

Merged
merged 1 commit into from
Jan 19, 2025
Merged

feat!: update namespace TypeScript declarations #4809

Show file tree
Hide file tree
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
64 changes: 32 additions & 32 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 @@ -1444,12 +1444,12 @@ interface Namespace {
dsumpw: typeof dsumpw;

/**
* Adds a constant to each element in a strided array.
* Adds a scalar constant to each element in a strided array.
*
* @param N - number of indexed elements
* @param alpha - constant
* @param alpha - scalar constant
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns `x`
*
* @example
Expand All @@ -1467,12 +1467,12 @@ interface Namespace {
gapx: typeof gapx;

/**
* Adds a constant to each strided array element and computes the sum.
* Adds a scalar constant to each strided array element and computes the sum.
*
* @param N - number of indexed elements
* @param alpha - constant
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand Down Expand Up @@ -1513,12 +1513,12 @@ interface Namespace {
gapxsumkbn: typeof gapxsumkbn;

/**
* Adds a constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
* Adds a scalar constant to each strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
*
* @param N - number of indexed elements
* @param alpha - constant
* @param alpha - scalar constant
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand All @@ -1536,12 +1536,12 @@ interface Namespace {
gapxsumkbn2: typeof gapxsumkbn2;

/**
* Adds a constant to each strided array element and computes the sum using ordinary recursive summation.
* Adds a scalar constant to each strided array element and computes the sum using ordinary recursive summation.
*
* @param N - number of indexed elements
* @param alpha - constant
* @param alpha - scalar constant
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand All @@ -1559,12 +1559,12 @@ interface Namespace {
gapxsumors: typeof gapxsumors;

/**
* Adds a constant to each strided array element and computes the sum using pairwise summation.
* Adds a scalar constant to each strided array element and computes the sum using pairwise summation.
*
* @param N - number of indexed elements
* @param alpha - constant
* @param alpha - scalar constant
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand All @@ -1586,7 +1586,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand All @@ -1609,9 +1609,9 @@ interface Namespace {
* @param N - number of indexed elements
* @param sum - initial sum
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param y - output array
* @param strideY - `y` stride length
* @param strideY - stride length for `y`
* @returns output array
*
* @example
Expand Down Expand Up @@ -1663,9 +1663,9 @@ interface Namespace {
* @param N - number of indexed elements
* @param sum - initial sum
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param y - output array
* @param strideY - `y` stride length
* @param strideY - stride length for `y`
* @returns output array
*
* @example
Expand Down Expand Up @@ -1717,9 +1717,9 @@ interface Namespace {
* @param N - number of indexed elements
* @param sum - initial sum
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param y - output array
* @param strideY - `y` stride length
* @param strideY - stride length for `y`
* @returns output array
*
* @example
Expand All @@ -1739,12 +1739,12 @@ interface Namespace {
gcusumpw: typeof gcusumpw;

/**
* Fills a strided array with a specified scalar value.
* Fills a strided array with a specified scalar constant.
*
* @param N - number of indexed elements
* @param alpha - constant
* @param alpha - scalar constant
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns `x`
*
* @example
Expand Down Expand Up @@ -1777,8 +1777,8 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param clbk - callback
* @param strideX - stride length
* @param clbk - callback function
* @param thisArg - execution context
* @returns `x`
*
Expand Down Expand Up @@ -2169,7 +2169,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand Down Expand Up @@ -2307,12 +2307,12 @@ interface Namespace {
sapxsum: typeof sapxsum;

/**
* Adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.
* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.
*
* @param N - number of indexed elements
* @param alpha - constant
* @param alpha - scalar constant
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns sum
*
* @example
Expand Down Expand Up @@ -2446,9 +2446,9 @@ interface Namespace {
* @param N - number of indexed elements
* @param sum - initial sum
* @param x - input array
* @param strideX - `x` stride length
* @param strideX - stride length for `x`
* @param y - output array
* @param strideY - `y` stride length
* @param strideY - stride length for `y`
* @returns output array
*
* @example
Expand Down
33 changes: 3 additions & 30 deletions lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ import dcumaxabs = require( '@stdlib/stats/base/dcumaxabs' );
import dcumin = require( '@stdlib/stats/base/dcumin' );
import dcuminabs = require( '@stdlib/stats/base/dcuminabs' );
import dists = require( '@stdlib/stats/base/dists' );
import dmax = require( '@stdlib/stats/strided/dmax' );
import dmaxabs = require( '@stdlib/stats/base/dmaxabs' );
import dmaxabssorted = require( '@stdlib/stats/base/dmaxabssorted' );
import dmaxsorted = require( '@stdlib/stats/base/dmaxsorted' );
Expand Down Expand Up @@ -472,32 +471,6 @@ interface Namespace {
*/
dists: typeof dists;

/**
* Computes the maximum value of a double-precision floating-point strided array.
*
* @param N - number of indexed elements
* @param x - input array
* @param strideX - stride length
* @returns maximum value
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
*
* var v = ns.dmax( x.length, x, 1 );
* // returns 2.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
*
* var v = ns.dmax.ndarray( x.length, x, 1, 0 );
* // returns 2.0
*/
dmax: typeof dmax;

/**
* Computes the maximum absolute value of a double-precision floating-point strided array.
*
Expand Down Expand Up @@ -2059,7 +2032,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns arithmetic mean
*
* @example
Expand All @@ -2085,7 +2058,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns arithmetic mean
*
* @example
Expand Down Expand Up @@ -2137,7 +2110,7 @@ interface Namespace {
*
* @param N - number of indexed elements
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns arithmetic mean
*
* @example
Expand Down
Loading