Skip to content

docs: update namespace TypeScript declaration comments #4794

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 18, 2025
Merged

docs: update namespace TypeScript declaration comments #4794

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
22 changes: 11 additions & 11 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 @@ -2334,12 +2334,12 @@ interface Namespace {
sapxsumkbn: typeof sapxsumkbn;

/**
* Adds a constant to each single-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm.
* Adds a scalar constant to each single-precision floating-point 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 Down Expand Up @@ -2388,12 +2388,12 @@ interface Namespace {
sapxsumors: typeof sapxsumors;

/**
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation.
* Adds a scalar constant to each single-precision floating-point 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 @@ -2419,7 +2419,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 @@ -2477,9 +2477,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 @@ -2508,9 +2508,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
19 changes: 19 additions & 0 deletions lib/node_modules/@stdlib/complex/float64/base/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,25 @@ interface Namespace {
*
* var im = imag( out );
* // returns -1.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var out = new Float64Array( 2 );
* var v = ns.mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
* // returns <Float64Array>[ -13.0, -1.0 ]
*
* var bool = ( out === v );
* // returns true
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var z1 = new Float64Array( [ 5.0, 3.0 ] );
* var z2 = new Float64Array( [ -2.0, 1.0 ] );
*
* var out = ns.mul.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
* // returns <Float64Array>[ -13.0, -1.0 ]
*/
mul: typeof mul;
}
Expand Down
19 changes: 19 additions & 0 deletions lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,25 @@ interface Namespace {
*
* var im = imag( out );
* // returns -1.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var out = new Float64Array( 2 );
* var v = ns.cmul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 );
* // returns <Float64Array>[ -13.0, -1.0 ]
*
* var bool = ( out === v );
* // returns true
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var z1 = new Float64Array( [ 5.0, 3.0 ] );
* var z2 = new Float64Array( [ -2.0, 1.0 ] );
*
* var out = ns.cmul.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 );
* // returns <Float64Array>[ -13.0, -1.0 ]
*/
cmul: typeof cmul;

Expand Down
18 changes: 9 additions & 9 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 @@ -607,7 +607,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 @@ -659,7 +659,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 @@ -711,7 +711,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 @@ -763,7 +763,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 @@ -1899,7 +1899,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns standard error of the mean
*
* @example
Expand Down Expand Up @@ -1953,7 +1953,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns standard error of the mean
*
* @example
Expand Down Expand Up @@ -2007,7 +2007,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns standard error of the mean
*
* @example
Expand Down Expand Up @@ -4105,7 +4105,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 @@ -5863,7 +5863,7 @@ interface Namespace {
* @param N - number of indexed elements
* @param correction - degrees of freedom adjustment
* @param x - input array
* @param stride - stride length
* @param strideX - stride length
* @returns variance
*
* @example
Expand Down
Loading